mirror of
https://github.com/oven-sh/setup-bun.git
synced 2025-07-18 12:38:24 +02:00
49 lines
No EOL
2 KiB
TypeScript
49 lines
No EOL
2 KiB
TypeScript
import { Context } from '../context/types';
|
|
import { TextMapGetter, TextMapPropagator, TextMapSetter } from '../propagation/TextMapPropagator';
|
|
import { getBaggage, getActiveBaggage, setBaggage, deleteBaggage } from '../baggage/context-helpers';
|
|
import { createBaggage } from '../baggage/utils';
|
|
/**
|
|
* Singleton object which represents the entry point to the OpenTelemetry Propagation API
|
|
*/
|
|
export declare class PropagationAPI {
|
|
private static _instance?;
|
|
/** Empty private constructor prevents end users from constructing a new instance of the API */
|
|
private constructor();
|
|
/** Get the singleton instance of the Propagator API */
|
|
static getInstance(): PropagationAPI;
|
|
/**
|
|
* Set the current propagator.
|
|
*
|
|
* @returns true if the propagator was successfully registered, else false
|
|
*/
|
|
setGlobalPropagator(propagator: TextMapPropagator): boolean;
|
|
/**
|
|
* Inject context into a carrier to be propagated inter-process
|
|
*
|
|
* @param context Context carrying tracing data to inject
|
|
* @param carrier carrier to inject context into
|
|
* @param setter Function used to set values on the carrier
|
|
*/
|
|
inject<Carrier>(context: Context, carrier: Carrier, setter?: TextMapSetter<Carrier>): void;
|
|
/**
|
|
* Extract context from a carrier
|
|
*
|
|
* @param context Context which the newly created context will inherit from
|
|
* @param carrier Carrier to extract context from
|
|
* @param getter Function used to extract keys from a carrier
|
|
*/
|
|
extract<Carrier>(context: Context, carrier: Carrier, getter?: TextMapGetter<Carrier>): Context;
|
|
/**
|
|
* Return a list of all fields which may be used by the propagator.
|
|
*/
|
|
fields(): string[];
|
|
/** Remove the global propagator */
|
|
disable(): void;
|
|
createBaggage: typeof createBaggage;
|
|
getBaggage: typeof getBaggage;
|
|
getActiveBaggage: typeof getActiveBaggage;
|
|
setBaggage: typeof setBaggage;
|
|
deleteBaggage: typeof deleteBaggage;
|
|
private _getGlobalPropagator;
|
|
}
|
|
//# sourceMappingURL=propagation.d.ts.map
|