Class PropagationAPI

Singleton object which represents the entry point to the OpenTelemetry Propagation API

Hierarchy

  • PropagationAPI

Constructors

constructor

Properties

_getGlobalPropagator createBaggage deleteBaggage getActiveBaggage getBaggage setBaggage _instance?

Methods

disable extract fields inject setGlobalPropagator getInstance

Constructors

Private constructor

  • Empty private constructor prevents end users from constructing a new instance of the API

    Returns PropagationAPI

Properties

Private _getGlobalPropagator

_getGlobalPropagator: any

createBaggage

createBaggage: ((entries?) => Baggage)

Type declaration

    • (entries?): Baggage

    • Create a new Baggage with optional entries

      Parameters

      • Optional entries: Record<string, BaggageEntry>

        An array of baggage entries the new baggage should contain

        Optional

      Returns Baggage

deleteBaggage

deleteBaggage: ((context) => Context)

Type declaration

    • (context): Context

    • Delete the baggage stored in the given context

      Parameters

      Returns Context

getActiveBaggage

getActiveBaggage: (() => Baggage | undefined)

Type declaration

    • (): Baggage | undefined

    • Retrieve the current baggage from the active/current context

      Returns Baggage | undefined

      Extracted baggage from the context

getBaggage

getBaggage: ((context) => Baggage | undefined)

Type declaration

    • (context): Baggage | undefined

    • Retrieve the current baggage from the given context

      Parameters

      Returns Baggage | undefined

      Extracted baggage from the context

setBaggage

setBaggage: ((context, baggage) => Context)

Type declaration

    • (context, baggage): Context

    • Store a baggage in the given context

      Parameters

      • context: Context
      • baggage: Baggage

        that will be set in the actual context

      Returns Context

Static Private Optional _instance

_instance?: any

Methods

disable

  • Remove the global propagator

    Returns void

extract

  • Extract context from a carrier

    Type Parameters

    • Carrier

    Parameters

    • context: Context

      Context which the newly created context will inherit from

    • carrier: Carrier

      Carrier to extract context from

    • Optional getter: TextMapGetter<Carrier>

      Function used to extract keys from a carrier

      Optional

    Returns Context

fields

  • Return a list of all fields which may be used by the propagator.

    Returns string[]

inject

  • Inject context into a carrier to be propagated inter-process

    Type Parameters

    • Carrier

    Parameters

    • context: Context

      Context carrying tracing data to inject

    • carrier: Carrier

      carrier to inject context into

    • Optional setter: TextMapSetter<Carrier>

      Function used to set values on the carrier

      Optional

    Returns void

setGlobalPropagator

  • Set the current propagator.

    Parameters

    Returns boolean

    true if the propagator was successfully registered, else false

Static getInstance

  • Get the singleton instance of the Propagator API

    Returns PropagationAPI

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc