opentelemetry_api v1.3.0

View Source otel_baggage (opentelemetry_api v1.3.0)

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.

The baggage can be stored either in the current context (with set/1 or set/3, for example) or in an explicit Context (see otel_ctx).

Link to this section Summary

Types

input_key/0
An input key, that is, a key that is then converted to a UTF-8 binary.
input_value/0
An input value, that is, a value that is then converted to a UTF-8 binary.
key/0
The type for the baggage key, which is a UTF-8 binary.
metadata/0
The type for the baggage metadata, which is a list of UTF-8 binaries or a list of tuples of UTF-8 binaries (as key-value pairs).
t/0
The type for the baggage.
value/0
The type for the baggage value, which is a UTF-8 binary.

Functions

clear()
Clears the baggage, removing all the current key-value pairs.
clear(Ctx)
Clears the baggage for the given context, removing all the current key-value pairs.
get_all()
Returns the baggage from the process dictionary.
get_all(Ctx)
Returns the baggage for the given context.
set(KeyValues)

Sets the given key-value pairs in the current baggage.

set(Key, Value)

Sets the given key-value pair in the current baggage, or sets the given key-value pairs in the baggage for the given context.

set(Key, Value, Metadata)

Sets the given key-value pair in the current baggage (with the associated metadata), or sets the given key-value pair in the baggage for the given context.

set(Ctx, Key, Value, Metadata)

Sets the given key-value pair in the baggage for the given context, with the associated metadata.

set_to(Ctx, KeyValues)

Sets the given key-value pairs in the baggage for the given context.

set_to(Ctx, Key, Value)

Sets the given key-value pair in the baggage for the given context.

set_to(Ctx, Key, Value, Metadata)

Sets the given key-value pair in the baggage for the given context, with the associated metadata.

Link to this section Types

Link to this type

input_key/0

View Source 
-type input_key() :: key() | unicode:charlist().
An input key, that is, a key that is then converted to a UTF-8 binary.
Link to this type

input_value/0

View Source 
-type input_value() :: value() | unicode:charlist() | atom().
An input value, that is, a value that is then converted to a UTF-8 binary.
Link to this type

key/0

View Source 
-type key() :: unicode:unicode_binary().
The type for the baggage key, which is a UTF-8 binary.
Link to this type

metadata/0

View Source 
-type metadata() :: [unicode:unicode_binary() | {unicode:unicode_binary(), unicode:unicode_binary()}].
The type for the baggage metadata, which is a list of UTF-8 binaries or a list of tuples of UTF-8 binaries (as key-value pairs).
Link to this type

t/0

View Source 
-type t() :: #{key() => {value(), metadata()}}.
The type for the baggage.
Link to this type

value/0

View Source 
-type value() :: unicode:unicode_binary().
The type for the baggage value, which is a UTF-8 binary.

Link to this section Functions

Link to this function

clear()

View Source 
-spec clear() -> ok.
Clears the baggage, removing all the current key-value pairs.
Link to this function

clear(Ctx)

View Source 
-spec clear(otel_ctx:t()) -> otel_ctx:t().
Clears the baggage for the given context, removing all the current key-value pairs.
Link to this function

get_all()

View Source 
-spec get_all() -> t().
Returns the baggage from the process dictionary.
Link to this function

get_all(Ctx)

View Source 
-spec get_all(otel_ctx:t()) -> t().
Returns the baggage for the given context.
Link to this function

set(KeyValues)

View Source 
-spec set(#{key() => value()} | [{key(), value()}]) -> ok.

Sets the given key-value pairs in the current baggage.

If you need to set metadata for the key-value pair, use set/3 instead.
Link to this function

set(Key, Value)

View Source 
-spec set(otel_ctx:t() | input_key(),
    #{input_key() => input_value()} | [{input_key(), input_value()}] | input_value()) ->
       otel_ctx:t() | ok.

Sets the given key-value pair in the current baggage, or sets the given key-value pairs in the baggage for the given context.

Returns ok when using the set(Key, Value) form, or the updated context when using the set(Ctx, KeyValues) form.
Link to this function

set(Key, Value, Metadata)

View Source 
-spec set(otel_ctx:t() | input_key(), input_key() | input_value(), input_value() | metadata()) ->
       otel_ctx:t() | ok.

Sets the given key-value pair in the current baggage (with the associated metadata), or sets the given key-value pair in the baggage for the given context.

Returns ok when using the set(Key, Value, Metadata) form, or the updated context when using the set(Ctx, Key, Value) form.
Link to this function

set(Ctx, Key, Value, Metadata)

View Source 
-spec set(otel_ctx:t(), input_key(), input_value(), metadata()) -> otel_ctx:t().

Sets the given key-value pair in the baggage for the given context, with the associated metadata.

Returns the updated context.
Link to this function

set_to(Ctx, KeyValues)

View Source 
-spec set_to(otel_ctx:t(), #{input_key() => input_value()} | [{input_key(), input_value()}]) ->
          otel_ctx:t().

Sets the given key-value pairs in the baggage for the given context.

Returns the updated context.
Link to this function

set_to(Ctx, Key, Value)

View Source 
-spec set_to(otel_ctx:t(), input_key(), input_value()) -> otel_ctx:t().

Sets the given key-value pair in the baggage for the given context.

Returns the updated context.
Link to this function

set_to(Ctx, Key, Value, Metadata)

View Source 
-spec set_to(otel_ctx:t(), input_key(), input_value(), metadata()) -> otel_ctx:t().

Sets the given key-value pair in the baggage for the given context, with the associated metadata.

Returns the updated context.