opentelemetry_api v1.3.0

View Source otel_ctx (opentelemetry_api v1.3.0)

Ctx is responsible for propagating values within a process that are associated with a particular Trace or set of Baggage. OpenTelemetry.Tracer and OpenTelemetry.Baggage handle updating the Context.

Functions in this module include variants that explicitly take a Ctx argument and variants that implicitly use the current context, which is the context stored in the process dictionary.

Link to this section Summary

Types

key/0
A context key.
t/0
A context map.
token/0
An opaque token that represents a context.
value/0
A context value.

Functions

attach(Ctx)

Attaches the given context to the current process.

clear()
Removes all key-value pairs from the current context.
clear(Ctx)

Removes all key-value pairs from the given context.

detach(Token)
Detaches the given context from the current process.
get_current()
Returns the current context.
get_value(Key)
Gets a value from the current context under the given key.
get_value(Key, Default)
Gets a value from the current context under the given key, or returns the default value if the key is not present in the current context.
get_value(Ctx, Key, Default)
Gets a value from the given context under the given key, or returns the default value if the key is not present in the given context or if Ctx is undefined.
new()
Creates a new context.
remove(Key)
Removes the value under the given key from the current context.
remove(Ctx, Key)

Removes the value under the given key from the given context.

set_value(Key, Value)
Sets a value in the current context under the given key.
set_value(Ctx, Key, Value)

Sets a value in the given context under the given key.

with_ctx(Ctx, Fun)

Attaches a context and runs a function, detaching the context at the end.

Link to this section Types

Link to this type

key/0

View Source 
-type key() :: term().
A context key.
Link to this type

t/0

View Source 
-type t() :: map() | undefined.
A context map.
Link to this opaque

token/0

View Source (opaque) 
-opaque token()
An opaque token that represents a context.
Link to this type

value/0

View Source 
-type value() :: term().
A context value.

Link to this section Functions

Link to this function

attach(Ctx)

View Source 
-spec attach(t()) -> token().

Attaches the given context to the current process.

Essentially, this sets Ctx as the current context .
Link to this function

clear()

View Source 
-spec clear() -> ok.
Removes all key-value pairs from the current context.
Link to this function

clear(Ctx)

View Source 
-spec clear(t()) -> t().

Removes all key-value pairs from the given context.

Returns an empty context.
Link to this function

detach(Token)

View Source 
-spec detach(token()) -> t() | undefined.
Detaches the given context from the current process.
Link to this function

get_current()

View Source 
-spec get_current() -> map().
Returns the current context.
Link to this function

get_value(Key)

View Source 
-spec get_value(term()) -> eqwalizer:dynamic().
Gets a value from the current context under the given key.
Link to this function

get_value(Key, Default)

View Source 
-spec get_value(term(), term()) -> eqwalizer:dynamic().
Gets a value from the current context under the given key, or returns the default value if the key is not present in the current context.
Link to this function

get_value(Ctx, Key, Default)

View Source 
-spec get_value(t(), term(), term()) -> eqwalizer:dynamic().
Gets a value from the given context under the given key, or returns the default value if the key is not present in the given context or if Ctx is undefined.
Link to this function

new()

View Source 
-spec new() -> t().
Creates a new context.
Link to this function

remove(Key)

View Source 
-spec remove(term()) -> ok.
Removes the value under the given key from the current context.
Link to this function

remove(Ctx, Key)

View Source 
-spec remove(t(), term()) -> t().

Removes the value under the given key from the given context.

Returns the updated context.
Link to this function

set_value(Key, Value)

View Source 
-spec set_value(term(), term()) -> ok.
Sets a value in the current context under the given key.
Link to this function

set_value(Ctx, Key, Value)

View Source 
-spec set_value(t(), term(), term()) -> t().

Sets a value in the given context under the given key.

Returns the updated context.
Link to this function

with_ctx(Ctx, Fun)

View Source 
-spec with_ctx(t(), fun(() -> term())) -> {term(), t()}.

Attaches a context and runs a function, detaching the context at the end.

Returns the detached context.