OpenTelemetry SDK
    Preparing search index...

    Class TraceState

    TraceState must be a class and not a simple object type because of the spec requirement (https://www.w3.org/TR/trace-context/#tracestate-field).

    Here is the list of allowed mutations:

    • New key-value pair should be added into the beginning of the list
    • The value of any key can be updated. Modified keys MUST be moved to the beginning of the list.

    Implements

    Index

    Constructors

    constructor

    Methods

    get serialize set unset

    Constructors

    • Parameters

      • OptionalrawTraceState: string

      Returns core.TraceState

    Methods

    • Returns the value to which the specified key is mapped, or undefined if this map contains no mapping for the key.

      Parameters

      • key: string

        with which the specified value is to be associated.

      Returns string | undefined

      the value to which the specified key is mapped, or undefined if this map contains no mapping for the key.

    • Serializes the TraceState to a list as defined below. The list is a series of list-members separated by commas ,, and a list-member is a key/value pair separated by an equals sign =. Spaces and horizontal tabs surrounding list-members are ignored. There can be a maximum of 32 list-members in a list.

      Returns string

      the serialized string.

    • Create a new TraceState which inherits from this TraceState and has the given key set. The new entry will always be added in the front of the list of states.

      Parameters

      • key: string

        key of the TraceState entry.

      • value: string

        value of the TraceState entry.

      Returns core.TraceState

    • Return a new TraceState which inherits from this TraceState but does not contain the given key.

      Parameters

      • key: string

        the key for the TraceState entry to be removed.

      Returns core.TraceState

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods