github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/pkg/logutil/context.go (about)

     1  // Copyright 2022 PingCAP, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package logutil
    15  
    16  import (
    17  	"context"
    18  
    19  	"github.com/pingcap/log"
    20  	"go.uber.org/zap"
    21  )
    22  
    23  type ctxLogKeyType struct{}
    24  
    25  // ctxLogKey indicates the context key for logger
    26  var ctxLogKey = ctxLogKeyType{}
    27  
    28  // FromContext return the logger in context, or return global logger
    29  // if logger not found in context
    30  func FromContext(ctx context.Context) *zap.Logger {
    31  	if ctxlogger, ok := ctx.Value(ctxLogKey).(*zap.Logger); ok {
    32  		return ctxlogger
    33  	}
    34  
    35  	return log.L()
    36  }
    37  
    38  // NewContextWithLogger attaches a new logger to context and return the context
    39  func NewContextWithLogger(ctx context.Context, logger *zap.Logger) context.Context {
    40  	return context.WithValue(ctx, ctxLogKey, logger)
    41  }