opentelemetry_api v1.0.0-rc.2

otel_baggage (opentelemetry_api v1.0.0-rc.2)

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

check_utf8(Cs)
clear()
clear(Ctx)
convert_to_binary(Binary, InEncoding, OutEncoding)
decode_key(Key)
decode_value(ValueAndMetadata)
encode_key(Key)
encode_metadata(Metadata)
encode_value(_)
form_urlencode(Cs, _)
get_all()
get_all(Ctx)
get_text_map_propagators()
html5_byte_encode(B)
html5_byte_encode(H, Acc)
is_hex_digit(C)
is_url_char(C)
lookup(Header, Rest)
metadata_decode(Metadata)
percent_decode(URI)
raw_decode(Cs)
raw_decode(L, Acc)
set(KeyValues)
set(Key, Value)
set(Key, Value, Metadata)
set(Ctx, Key, Value, Metadata)
string_decode(S)
to_binary(String)
update_metadata(Value)
update_metadata(Value, Metadata)
verify_baggage(KeyValues)
verify_metadata(M)

Link to this section Types

Link to this type

key/0

Specs

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

metadata/0

Specs

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

t/0

Specs

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

value/0

Specs

value() :: unicode:unicode_binary().

Link to this section Functions

Link to this function

check_utf8(Cs)

Link to this function

clear()

Specs

clear() -> ok.
Link to this function

clear(Ctx)

Specs

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

convert_to_binary(Binary, InEncoding, OutEncoding)

Link to this function

decode_key(Key)

Link to this function

decode_value(ValueAndMetadata)

Link to this function

encode_key(Key)

Link to this function

encode_metadata(Metadata)

Link to this function

encode_value(_)

Link to this function

form_urlencode(Cs, _)

Link to this function

get_all()

Specs

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

get_all(Ctx)

Specs

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

get_text_map_propagators()

Specs

get_text_map_propagators() ->
                            {otel_propagator:text_map_extractor(),
                             otel_propagator:text_map_injector()}.
Link to this function

html5_byte_encode(B)

Link to this function

html5_byte_encode(H, Acc)

Link to this function

is_hex_digit(C)

Specs

is_hex_digit(char()) -> boolean().
Link to this function

is_url_char(C)

Link to this function

lookup(Header, Rest)

Link to this function

metadata_decode(Metadata)

Link to this function

percent_decode(URI)

Specs

percent_decode(URI) -> Result
                  when
                      URI :: uri_string:uri_string(),
                      Result ::
                          uri_string:uri_string() | {error, {invalid, {atom(), {term(), term()}}}}.
Link to this function

raw_decode(Cs)

Specs

raw_decode(list() | binary()) -> list() | binary() | uri_string:error().
Link to this function

raw_decode(L, Acc)

Link to this function

set(KeyValues)

Specs

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

set(Key, Value)

Specs

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

set(Key, Value, Metadata)

Specs

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

set(Ctx, Key, Value, Metadata)

Specs

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

string_decode(S)

Link to this function

to_binary(String)

Link to this function

update_metadata(Value)

Link to this function

update_metadata(Value, Metadata)

Link to this function

verify_baggage(KeyValues)

Link to this function

verify_metadata(M)