Class PropagationAPI

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

Since

1.0.0

Index

Properties

createBaggage deleteBaggage getActiveBaggage getBaggage setBaggage

Methods

disable extract fields inject setGlobalPropagator getInstance

Properties

createBaggage

createBaggage: (entries?: Record<string, BaggageEntry>) => Baggage = createBaggage

Type declaration

- (entries?: Record<string, BaggageEntry>): Baggage
- Create a new Baggage with optional entries
  Parameters
  - entries: Record<string, BaggageEntry> = {}
    An array of baggage entries the new baggage should contain
  Returns Baggage

deleteBaggage

deleteBaggage: (context: Context) => Context = deleteBaggage

Type declaration

- (context: Context): Context
- Delete the baggage stored in the given context
  Parameters
  - context: Context
  Returns Context

getActiveBaggage

getActiveBaggage: () => undefined | Baggage = getActiveBaggage

Type declaration

- (): undefined | Baggage
- Retrieve the current baggage from the active/current context
  
  Returns undefined | Baggage
  Extracted baggage from the context

getBaggage

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

Type declaration

- (context: Context): undefined | Baggage
- Retrieve the current baggage from the given context
  Parameters
  - context: Context
  Returns undefined | Baggage
  Extracted baggage from the context

setBaggage

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

Type declaration

- (context: Context, baggage: Baggage): Context
- Store a baggage in the given context
  Parameters
  - context: Context
  - baggage: Baggage
    that will be set in the actual context
  Returns Context

Methods

disable

disable(): void
Remove the global propagator

Returns void
- Defined in api/propagation.ts:110

extract

extract<Carrier>(
    context: Context,
    carrier: Carrier,
    getter?: TextMapGetter<Carrier>,
): Context
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
- getter: TextMapGetter<Carrier> = defaultTextMapGetter
  Function used to extract keys from a carrier
Returns Context
- Defined in api/propagation.ts:94

fields

fields(): string[]
Return a list of all fields which may be used by the propagator.

Returns string[]
- Defined in api/propagation.ts:105

inject

inject<Carrier>(
    context: Context,
    carrier: Carrier,
    setter?: TextMapSetter<Carrier>,
): void
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
- setter: TextMapSetter<Carrier> = defaultTextMapSetter
  Function used to set values on the carrier
Returns void
- Defined in api/propagation.ts:79

setGlobalPropagator

setGlobalPropagator(propagator: TextMapPropagator): boolean
Set the current propagator.
Parameters
- propagator: TextMapPropagator
Returns boolean
true if the propagator was successfully registered, else false
- Defined in api/propagation.ts:68

`Static`getInstance

getInstance(): PropagationAPI
Get the singleton instance of the Propagator API

Returns PropagationAPI
- Defined in api/propagation.ts:55

Class PropagationAPI

Since

Index

Properties

Methods

Properties

createBaggage

Type declaration

Parameters

Returns Baggage

deleteBaggage

Type declaration

Parameters

Returns Context

getActiveBaggage

Type declaration

Returns undefined | Baggage

getBaggage

Type declaration

Parameters

Returns undefined | Baggage

setBaggage

Type declaration

Parameters

Returns Context

Methods

disable

Returns void

extract

Type Parameters

Parameters

Returns Context

fields

Returns string[]

inject

Type Parameters

Parameters

Returns void

setGlobalPropagator

Parameters

Returns boolean

StaticgetInstance

Returns PropagationAPI

Settings

On This Page

`Static`getInstance