OpenTelemetry SDK
    Preparing search index...

    Interface PropagationAPI

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

    1.0.0

    interface PropagationAPI {
        createBaggage: (
            entries?: Record<string, @opentelemetry/api.BaggageEntry>,
        ) => @opentelemetry/api.Baggage;
        deleteBaggage: (
            context: @opentelemetry/api.Context,
        ) => @opentelemetry/api.Context;
        getActiveBaggage: () => @opentelemetry/api.Baggage | undefined;
        getBaggage: (
            context: @opentelemetry/api.Context,
        ) => @opentelemetry/api.Baggage | undefined;
        setBaggage: (
            context: @opentelemetry/api.Context,
            baggage: @opentelemetry/api.Baggage,
        ) => @opentelemetry/api.Context;
        disable(): void;
        extract<Carrier>(
            context: @opentelemetry/api.Context,
            carrier: Carrier,
            getter?: @opentelemetry/api.TextMapGetter<Carrier>,
        ): @opentelemetry/api.Context;
        fields(): string[];
        inject<Carrier>(
            context: @opentelemetry/api.Context,
            carrier: Carrier,
            setter?: @opentelemetry/api.TextMapSetter<Carrier>,
        ): void;
        setGlobalPropagator(
            propagator: @opentelemetry/api.TextMapPropagator,
        ): boolean;
    }
    Index

    Properties

    createBaggage deleteBaggage getActiveBaggage getBaggage setBaggage

    Methods

    disable extract fields inject setGlobalPropagator

    Properties

    createBaggage: (
        entries?: Record<string, @opentelemetry/api.BaggageEntry>,
    ) => @opentelemetry/api.Baggage

    Type Declaration

    deleteBaggage: (
        context: @opentelemetry/api.Context,
    ) => @opentelemetry/api.Context

    Type Declaration

    getActiveBaggage: () => @opentelemetry/api.Baggage | undefined

    Type Declaration

    getBaggage: (
        context: @opentelemetry/api.Context,
    ) => @opentelemetry/api.Baggage | undefined

    Type Declaration

    setBaggage: (
        context: @opentelemetry/api.Context,
        baggage: @opentelemetry/api.Baggage,
    ) => @opentelemetry/api.Context

    Type Declaration

    Methods

    • Remove the global propagator

      Returns void

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

      Returns string[]

    Settings

    Member Visibility

    On This Page

    Properties
    Methods