symphony.bdk.core.client.trace_id.DistributedTracingContext

class symphony.bdk.core.client.trace_id.DistributedTracingContext

Bases: object

Class to manage the tracing id context.

__init__()

Methods

__init__()
clear()	Clears the trace id value.
get_trace_id()	Gets the current trace id.
has_trace_id()	Checks whether a trace id has been set.
is_trace_id_set_by_user()	Checks whether the trace id has been manually set using set_trace_id().
set_new_trace_id()	Sets the trace id to a newly generated value.
set_trace_id(trace_id)	Sets the trace id to a new value.

classmethod clear() → None

Clears the trace id value.

Returns

None

classmethod get_trace_id() → str

Gets the current trace id.

Returns

the current trace id or empty string if not set

classmethod has_trace_id() → bool

Checks whether a trace id has been set.

Returns

True if a trace id has been set, False otherwise

classmethod is_trace_id_set_by_user() → bool

Checks whether the trace id has been manually set using set_trace_id().

Returns

True if a trace id has been manually set, False otherwise

classmethod set_new_trace_id() → None

Sets the trace id to a newly generated value.

Returns

None

classmethod set_trace_id(trace_id: str) → None

Sets the trace id to a new value.

Parameters

trace_id – string value, should not be None or empty

Returns

None