Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TraceState

Package version

Tracestate carries system-specific configuration data, represented as a list of key-value pairs. TraceState allows multiple tracing systems to participate in the same trace.

Hierarchy

  • TraceState

Index

Methods

Methods

get

  • get(key: string): string | undefined

  • 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.

serialize

  • serialize(): string

  • 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.

set

  • set(key: string, value: string): void

  • Adds or updates the TraceState that has the given key if it is present. The new State 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 void

unset

  • unset(key: string): void

  • Removes the TraceState Entry that has the given key if it is present.

    Parameters

    • key: string

      the key for the TraceState Entry to be removed.

    Returns void

Generated using TypeDoc