github.com/KinWaiYuen/client-go/v2@v2.5.4/internal/logutil/log.go (about)

     1  // Copyright 2021 TiKV Authors
     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  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // NOTE: The code in this file is based on code from the
    16  // TiDB project, licensed under the Apache License v 2.0
    17  //
    18  // https://github.com/pingcap/tidb/tree/cc5e161ac06827589c4966674597c137cc9e809c/store/tikv/logutil/log.go
    19  //
    20  
    21  // Copyright 2021 PingCAP, Inc.
    22  //
    23  // Licensed under the Apache License, Version 2.0 (the "License");
    24  // you may not use this file except in compliance with the License.
    25  // You may obtain a copy of the License at
    26  //
    27  //     http://www.apache.org/licenses/LICENSE-2.0
    28  //
    29  // Unless required by applicable law or agreed to in writing, software
    30  // distributed under the License is distributed on an "AS IS" BASIS,
    31  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    32  // See the License for the specific language governing permissions and
    33  // limitations under the License.
    34  
    35  package logutil
    36  
    37  import (
    38  	"context"
    39  
    40  	"github.com/pingcap/log"
    41  	"go.uber.org/zap"
    42  )
    43  
    44  // BgLogger returns the default global logger.
    45  func BgLogger() *zap.Logger {
    46  	return log.L()
    47  }
    48  
    49  // Logger gets a contextual logger from current context.
    50  // contextual logger will output common fields from context.
    51  func Logger(ctx context.Context) *zap.Logger {
    52  	if ctxlogger, ok := ctx.Value(CtxLogKey).(*zap.Logger); ok {
    53  		return ctxlogger
    54  	}
    55  	return log.L()
    56  }
    57  
    58  type ctxLogKeyType struct{}
    59  
    60  // CtxLogKey is the key to retrieve logger from context.
    61  // It can be assigned to another value.
    62  var CtxLogKey interface{} = ctxLogKeyType{}