Module otel_baggage

Baggage is used to annotate telemetry, adding context and information to metrics, traces, and logs.

Description

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.

Data Types

key()

key() = unicode:unicode_binary()

metadata()

metadata() = [unicode:unicode_binary() | {unicode:unicode_binary(), unicode:unicode_binary()}]

t()

t() = #{key() => {value(), metadata()}}

value()

value() = unicode:unicode_binary()

Function Index

clear/0
clear/1
get_all/0
get_all/1
set/1
set/2
set/3
set/4

Function Details

clear/0

clear() -> ok

clear/1

clear(Ctx::otel_ctx:t()) -> otel_ctx:t()

get_all/0

get_all() -> t()

get_all/1

get_all(Ctx::otel_ctx:t()) -> t()

set/1

set(KeyValues::#{key() => value()} | [{key(), value()}]) -> ok

set/2

set(Key::otel_ctx:t() | key() | unicode:charlist(), Value::#{key() => value()} | [{key(), value()}] | value()) -> otel_ctx:t()

set/3

set(Key::otel_ctx:t() | key(), Value::key() | value(), Metadata::value() | list()) -> ok | otel_ctx:t()

set/4

set(Ctx::otel_ctx:t(), Key::key(), Value::value(), Metadata::metadata()) -> otel_ctx:t()


Generated by EDoc