baggage

Documentation

Overview

Package baggage provides functionality for storing and retrieving baggage items in Go context. For propagating the baggage, see the go.opentelemetry.io/otel/propagation package.

This package is currently in a pre-GA phase. Backwards incompatible changes may be introduced in subsequent minor version releases as we work to track the evolving OpenTelemetry specification and user feedback.

Index

• func ContextWithEmpty(parent context.Context) context.Context
• func ContextWithValues(parent context.Context, pairs ...attribute.KeyValue) context.Context
• func ContextWithoutValues(parent context.Context, keys ...attribute.Key) context.Context
• func Set(ctx context.Context) attribute.Set
• func Value(ctx context.Context, key attribute.Key) attribute.Value

Functions

func ContextWithEmpty

func ContextWithEmpty(parent context.Context) context.Context

ContextWithEmpty returns a copy of parent without baggage.

func ContextWithValues

func ContextWithValues(parent context.Context, pairs ...attribute.KeyValue) context.Context

ContextWithValues returns a copy of parent with pairs updated in the baggage.

func ContextWithoutValues

func ContextWithoutValues(parent context.Context, keys ...attribute.Key) context.Context

ContextWithoutValues returns a copy of parent in which the values related to keys have been removed from the baggage.

func Set

func Set(ctx context.Context) attribute.Set

Set returns a copy of the set of baggage key-values in ctx.

func Value

func Value(ctx context.Context, key attribute.Key) attribute.Value

Value returns the value related to key in the baggage of ctx. If no value is set, the returned attribute.Value will be an uninitialized zero-value with type INVALID.