github.com/myhau/pulumi/pkg/v3@v3.70.2-0.20221116134521-f2775972e587/util/tracing/tracing.go (about)

     1  // Copyright 2016-2019, Pulumi Corporation.
     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 tracing
    16  
    17  import (
    18  	"context"
    19  )
    20  
    21  // tracingOptionsKey is the value used as the context key for TracingOptions.
    22  var tracingOptionsKey struct{}
    23  
    24  // TracingOptions describes the set of options available for configuring tracing on a per-request basis.
    25  type Options struct {
    26  	// PropagateSpans indicates that spans should be propagated from the client to the Pulumi service when making API
    27  	// calls.
    28  	PropagateSpans bool
    29  	// IncludeTracingHeader indicates that API calls should include the indicated tracing header contents.
    30  	TracingHeader string
    31  }
    32  
    33  // ContextWithOptions returns a new context.Context with the indicated tracing options.
    34  func ContextWithOptions(ctx context.Context, opts Options) context.Context {
    35  	return context.WithValue(ctx, tracingOptionsKey, opts)
    36  }
    37  
    38  // OptionsFromContext retrieves any tracing options present in the given context. If no options are present,
    39  // this function returns the zero value.
    40  func OptionsFromContext(ctx context.Context) Options {
    41  	opts, _ := ctx.Value(tracingOptionsKey).(Options)
    42  	return opts
    43  }