Options
All
  • Public
  • Public/Protected
  • All
Menu

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

since

1.0.0

Hierarchy

  • PropagationAPI

Index

Properties

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

Type declaration

    • 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: ((context: Context) => Context) = deleteBaggage

Type declaration

getActiveBaggage: (() => Baggage | undefined) = getActiveBaggage

Type declaration

    • Retrieve the current baggage from the active/current context

      Returns Baggage | undefined

      Extracted baggage from the context

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

Type declaration

    • Retrieve the current baggage from the given context

      Parameters

      Returns Baggage | undefined

      Extracted baggage from the context

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

Type declaration

Methods

  • disable(): void
  • 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

  • fields(): string[]
  • 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

Generated using TypeDoc