Package: go.opentelemetry.io/otel/propagation

package propagation Import Path go.opentelemetry.io/otel/propagation (on go.dev) Dependency Relation imports 7 packages, and imported by 3 packages

Involved Source Files baggage.go d doc.go Package propagation contains OpenTelemetry context propagators. OpenTelemetry propagators are used to extract and inject context data from and into messages exchanged by applications. The propagator supported by this package is the W3C Trace Context encoding (https://www.w3.org/TR/trace-context/), and W3C Baggage (https://www.w3.org/TR/baggage/). propagation.go trace_context.go

Code Examples SetTextMapPropagator package main import ( "go.opentelemetry.io/otel" "go.opentelemetry.io/otel/propagation" ) func main() { // Create a new composite text map propagator. propagator := propagation.NewCompositeTextMapPropagator( propagation.TraceContext{}, propagation.Baggage{}, ) // Set it as the global text map propagator. otel.SetTextMapPropagator(propagator) }

Package-Level Type Names (total 7)

/* sort by: alphabet | popularity */

type Baggage (struct) Baggage is a propagator that supports the W3C Baggage format. This propagates user-defined baggage associated with a trace. The complete specification is defined at https://www.w3.org/TR/baggage/. Methods (total 3) ( Baggage) Extract(parent context.Context, carrier TextMapCarrier) context.Context Extract returns a copy of parent with the baggage from the carrier added. If carrier implements [ValuesGetter] (e.g. [HeaderCarrier]), Values is invoked for multiple values extraction. Otherwise, Get is called. ( Baggage) Fields() []string Fields returns the keys who's values are set with Inject. ( Baggage) Inject(ctx context.Context, carrier TextMapCarrier) Inject sets baggage key-values from ctx into the carrier. Implements (at least one exported) Baggage : TextMapPropagator

type HeaderCarrier http.Header (map) HeaderCarrier adapts http.Header to satisfy the TextMapCarrier and ValuesGetter interfaces. Methods (total 4) ( HeaderCarrier) Get(key string) string Get returns the first value associated with the passed key. ( HeaderCarrier) Keys() []string Keys lists the keys stored in this carrier. ( HeaderCarrier) Set(key, value string) Set stores the key-value pair. ( HeaderCarrier) Values(key string) []string Values returns all values associated with the passed key. Implements (at least 3) HeaderCarrier : TextMapCarrier HeaderCarrier : ValuesGetter HeaderCarrier : github.com/redis/go-redis/v9.ConsistentHash

type MapCarrier (map) MapCarrier is a TextMapCarrier that uses a map held in memory as a storage medium for propagated key-value pairs. Methods (total 3) ( MapCarrier) Get(key string) string Get returns the value associated with the passed key. ( MapCarrier) Keys() []string Keys lists the keys stored in this carrier. ( MapCarrier) Set(key, value string) Set stores the key-value pair. Implements (at least 2) MapCarrier : TextMapCarrier MapCarrier : github.com/redis/go-redis/v9.ConsistentHash

type TextMapCarrier (interface) TextMapCarrier is the storage medium used by a TextMapPropagator. See ValuesGetter for how a TextMapCarrier can get multiple values for a key. Methods (total 3) ( TextMapCarrier) Get(key string) string Get returns the value associated with the passed key. ( TextMapCarrier) Keys() []string Keys lists the keys stored in this carrier. ( TextMapCarrier) Set(key, value string) Set stores the key-value pair. Implemented By (at least 2) HeaderCarrier MapCarrier Implements (at least one exported) TextMapCarrier : github.com/redis/go-redis/v9.ConsistentHash As Inputs Of (at least 6) func Baggage.Extract(parent context.Context, carrier TextMapCarrier) context.Context func Baggage.Inject(ctx context.Context, carrier TextMapCarrier) func TextMapPropagator.Extract(ctx context.Context, carrier TextMapCarrier) context.Context func TextMapPropagator.Inject(ctx context.Context, carrier TextMapCarrier) func TraceContext.Extract(ctx context.Context, carrier TextMapCarrier) context.Context func TraceContext.Inject(ctx context.Context, carrier TextMapCarrier)

type TextMapPropagator (interface) TextMapPropagator propagates cross-cutting concerns as key-value text pairs within a carrier that travels in-band across process boundaries. Methods (total 3) ( TextMapPropagator) Extract(ctx context.Context, carrier TextMapCarrier) context.Context Extract reads cross-cutting concerns from the carrier into a Context. Implementations may check if the carrier implements ValuesGetter, to support extraction of multiple values per key. ( TextMapPropagator) Fields() []string Fields returns the keys whose values are set with Inject. ( TextMapPropagator) Inject(ctx context.Context, carrier TextMapCarrier) Inject set cross-cutting concerns from the Context into the carrier. Implemented By (at least 2) Baggage TraceContext As Outputs Of (at least 3) func NewCompositeTextMapPropagator(p ...TextMapPropagator) TextMapPropagator func go.opentelemetry.io/otel.GetTextMapPropagator() TextMapPropagator func go.opentelemetry.io/otel/internal/global.TextMapPropagator() TextMapPropagator As Inputs Of (at least 3) func NewCompositeTextMapPropagator(p ...TextMapPropagator) TextMapPropagator func go.opentelemetry.io/otel.SetTextMapPropagator(propagator TextMapPropagator) func go.opentelemetry.io/otel/internal/global.SetTextMapPropagator(p TextMapPropagator)

type TraceContext (struct) TraceContext is a propagator that supports the W3C Trace Context format (https://www.w3.org/TR/trace-context/) This propagator will propagate the traceparent and tracestate headers to guarantee traces are not broken. It is up to the users of this propagator to choose if they want to participate in a trace by modifying the traceparent header and relevant parts of the tracestate header containing their proprietary information. Methods (total 3) ( TraceContext) Extract(ctx context.Context, carrier TextMapCarrier) context.Context Extract reads tracecontext from the carrier into a returned Context. The returned Context will be a copy of ctx and contain the extracted tracecontext as the remote SpanContext. If the extracted tracecontext is invalid, the passed ctx will be returned directly instead. ( TraceContext) Fields() []string Fields returns the keys who's values are set with Inject. ( TraceContext) Inject(ctx context.Context, carrier TextMapCarrier) Inject injects the trace context from ctx into carrier. Implements (at least one exported) TraceContext : TextMapPropagator

type ValuesGetter (interface) ValuesGetter can return multiple values for a single key, with contrast to TextMapCarrier.Get which returns a single value. Methods (only one) ( ValuesGetter) Values(key string) []string Values returns all values associated with the passed key. Implemented By (at least 4) HeaderCarrier github.com/nats-io/nats.go.Header net/http.Header net/textproto.MIMEHeader

Package-Level Functions (only one)

func NewCompositeTextMapPropagator(p ...TextMapPropagator) TextMapPropagator NewCompositeTextMapPropagator returns a unified TextMapPropagator from the group of passed TextMapPropagator. This allows different cross-cutting concerns to be propagates in a unified manner. The returned TextMapPropagator will inject and extract cross-cutting concerns in the order the TextMapPropagators were provided. Additionally, the Fields method will return a de-duplicated slice of the keys that are set with the Inject method.