OpenTelemetry SDK
    Preparing search index...

    Interface TraceState

    1.0.0

    interface TraceState {
        get(key: string): string | undefined;
        serialize(): string;
        set(key: string, value: string): @opentelemetry/api.TraceState;
        unset(key: string): @opentelemetry/api.TraceState;
    }

    Implemented by

    Index

    Methods

    get serialize set unset

    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 @opentelemetry/api.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 @opentelemetry/api.TraceState

    Settings

    Member Visibility

    On This Page

    Methods