opentelemetry_api v1.0.3

View Source otel_baggage (opentelemetry_api v1.0.3)

Baggage is used to annotate telemetry, adding context and information to metrics, traces, and logs. It is represented by a set of name/value pairs describing user-defined properties.

Link to this section Summary

Types

key/0
metadata/0
t/0
value/0

Functions

clear()
clear(Ctx)
get_all()
get_all(Ctx)
set(KeyValues)
set(Key, Value)
set(Key, Value, Metadata)
set(Ctx, Key, Value, Metadata)

Link to this section Types

Link to this type

key/0

View Source

Specs

key() :: unicode:unicode_binary().
Link to this type

metadata/0

View Source

Specs

metadata() :: [unicode:unicode_binary() | {unicode:unicode_binary(), unicode:unicode_binary()}].
Link to this type

t/0

View Source

Specs

t() :: #{key() => {value(), metadata()}}.
Link to this type

value/0

View Source

Specs

value() :: unicode:unicode_binary().

Link to this section Functions

Link to this function

clear()

View Source

Specs

clear() -> ok.
Link to this function

clear(Ctx)

View Source

Specs

clear(otel_ctx:t()) -> otel_ctx:t().
Link to this function

get_all()

View Source

Specs

get_all() -> t().
Link to this function

get_all(Ctx)

View Source

Specs

get_all(otel_ctx:t()) -> t().
Link to this function

set(KeyValues)

View Source

Specs

set(#{key() => value()} | [{key(), value()}]) -> ok.
Link to this function

set(Key, Value)

View Source

Specs

set(otel_ctx:t() | key() | unicode:charlist(), #{key() => value()} | [{key(), value()}] | value()) ->
       otel_ctx:t().
Link to this function

set(Key, Value, Metadata)

View Source

Specs

set(otel_ctx:t() | key(), key() | value(), value() | list()) -> ok | otel_ctx:t().
Link to this function

set(Ctx, Key, Value, Metadata)

View Source

Specs

set(otel_ctx:t(), key(), value(), metadata()) -> otel_ctx:t().