Class ContextAPI

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

Since

1.0.0

Index

Methods

active bind disable setGlobalContextManager with getInstance

Methods

active

active(): @opentelemetry/api.Context
Get the currently active context

Returns @opentelemetry/api.Context
- Defined in api/build/src/api/context.d.ts:22

bind

bind<T>(context: @opentelemetry/api.Context, target: T): T
Bind a context to a target function or event emitter
Type Parameters
- T
Parameters
- context: @opentelemetry/api.Context
  context to bind to the event emitter or function. Defaults to the currently active context
- target: T
  function or event emitter to bind
Returns T
- Defined in api/build/src/api/context.d.ts:38

disable

disable(): void
Disable and remove the global context manager

Returns void
- Defined in api/build/src/api/context.d.ts:41

setGlobalContextManager

setGlobalContextManager(
contextManager: @opentelemetry/api.ContextManager,
): boolean
Set the current context manager.
Parameters
- contextManager: @opentelemetry/api.ContextManager
Returns boolean
true if the context manager was successfully registered, else false
- Defined in api/build/src/api/context.d.ts:18

with

with<A extends unknown[], F extends (...args: A) => ReturnType<F>>(
    context: @opentelemetry/api.Context,
    fn: F,
    thisArg?: ThisParameterType<F>,
    ...args: A,
): ReturnType<F>
Execute a function with an active context
Type Parameters
- A extends unknown[]
- F extends (...args: A) => ReturnType<F>
Parameters
- context: @opentelemetry/api.Context
  context to be active during function execution
- fn: F
  function to execute in a context
- OptionalthisArg: ThisParameterType<F>
  optional receiver to be used for calling fn
- ...args: A
  optional arguments forwarded to fn
Returns ReturnType<F>
- Defined in api/build/src/api/context.d.ts:31

`Static`getInstance

getInstance(): @opentelemetry/api.ContextAPI
Get the singleton instance of the Context API

Returns @opentelemetry/api.ContextAPI
- Defined in api/build/src/api/context.d.ts:12