github.com/cockroachdb/cockroach@v20.2.0-alpha.1+incompatible/pkg/util/tracing/annotate.go (about)

     1  // Copyright 2016 The Cockroach Authors.
     2  //
     3  // Use of this software is governed by the Business Source License
     4  // included in the file licenses/BSL.txt.
     5  //
     6  // As of the Change Date specified in that file, in accordance with
     7  // the Business Source License, use of this software will be governed
     8  // by the Apache License, Version 2.0, included in the file
     9  // licenses/APL.txt.
    10  
    11  package tracing
    12  
    13  // static void annotateTrace() {
    14  // }
    15  import "C"
    16  
    17  import "github.com/cockroachdb/cockroach/pkg/util/envutil"
    18  
    19  var annotationEnabled = envutil.EnvOrDefaultBool("COCKROACH_ANNOTATE_TRACES", false)
    20  
    21  // AnnotateTrace adds an annotation to the golang executation tracer by calling
    22  // a no-op cgo function.
    23  func AnnotateTrace() {
    24  	if annotationEnabled {
    25  		C.annotateTrace()
    26  	}
    27  }