github.com/KinWaiYuen/client-go/v2@v2.5.4/tikv/logutil.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  package tikv
    16  
    17  import (
    18  	"context"
    19  
    20  	"github.com/KinWaiYuen/client-go/v2/internal/logutil"
    21  	"go.uber.org/zap"
    22  )
    23  
    24  // WithLogContext returns a copy of context that is associated with a logger.
    25  func WithLogContext(ctx context.Context, logger *zap.Logger) context.Context {
    26  	return context.WithValue(ctx, logutil.CtxLogKey, logger)
    27  }
    28  
    29  // SetLogContextKey sets the context key which is used by client to retrieve *zap.Logger from context.
    30  func SetLogContextKey(key interface{}) {
    31  	logutil.CtxLogKey = key
    32  }