opentelemetry_api v1.1.1

View Source otel_baggage (opentelemetry_api v1.1.1)

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

input_key/0
input_value/0
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)
set_to(Ctx, KeyValues)
set_to(Ctx, Key, Value)
set_to(Ctx, Key, Value, Metadata)

Link to this section Types

Link to this type

input_key/0

View Source 
-type input_key() :: key() | unicode:charlist().
Link to this type

input_value/0

View Source 
-type input_value() :: value() | unicode:charlist() | atom().
Link to this type

key/0

View Source 
-type key() :: unicode:unicode_binary().
Link to this type

metadata/0

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

t/0

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

value/0

View Source 
-type value() :: unicode:unicode_binary().

Link to this section Functions

Link to this function

clear()

View Source 
-spec clear() -> ok.
Link to this function

clear(Ctx)

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

get_all()

View Source 
-spec get_all() -> t().
Link to this function

get_all(Ctx)

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

set(KeyValues)

View Source 
-spec set(#{key() => value()} | [{key(), value()}]) -> ok.
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.
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.
Link to this function

set(Ctx, Key, Value, Metadata)

View Source 
-spec set(otel_ctx:t(), input_key(), input_value(), metadata()) -> otel_ctx:t().
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().
Link to this function

set_to(Ctx, Key, Value)

View Source 
-spec set_to(otel_ctx:t(), input_key(), input_value()) -> otel_ctx:t().
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().