github.com/KinWaiYuen/client-go/v2@v2.5.4/internal/logutil/tracing.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/tracing.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  	"fmt"
    40  
    41  	"github.com/opentracing/opentracing-go"
    42  	"github.com/opentracing/opentracing-go/log"
    43  )
    44  
    45  // TraceEventKey presents the TraceEventKey in span log.
    46  var TraceEventKey = "event"
    47  
    48  // Event records event in current tracing span.
    49  func Event(ctx context.Context, event string) {
    50  	if span := opentracing.SpanFromContext(ctx); span != nil && span.Tracer() != nil {
    51  		span.LogFields(log.String(TraceEventKey, event))
    52  	}
    53  }
    54  
    55  // Eventf records event in current tracing span with format support.
    56  func Eventf(ctx context.Context, format string, args ...interface{}) {
    57  	if span := opentracing.SpanFromContext(ctx); span != nil && span.Tracer() != nil {
    58  		span.LogFields(log.String(TraceEventKey, fmt.Sprintf(format, args...)))
    59  	}
    60  }
    61  
    62  // SetTag sets tag kv-pair in current tracing span
    63  func SetTag(ctx context.Context, key string, value interface{}) {
    64  	if span := opentracing.SpanFromContext(ctx); span != nil && span.Tracer() != nil {
    65  		span.SetTag(key, value)
    66  	}
    67  }