@opentelemetry/instrumentation

Index

Modules

<internal>

Classes

Interfaces

Type Aliases

InstrumentationOption

Functions

Type Aliases

InstrumentationOption

InstrumentationOption: typeof InstrumentationBase | typeof InstrumentationBase[] | Instrumentation | Instrumentation[]

Functions

isWrapped

isWrapped(func: unknown): func is ShimWrapped

- Defined in experimental/packages/opentelemetry-instrumentation/src/utils.ts:76
Checks if certain function has been already wrapped

Parameters
- func: unknown
Returns func is ShimWrapped

registerInstrumentations

registerInstrumentations(options: AutoLoaderOptions): (() => void)

- Defined in experimental/packages/opentelemetry-instrumentation/src/autoLoader.ts:31
It will register instrumentations and plugins

Parameters
- options: AutoLoaderOptions
Returns (() => void)
returns function to unload instrumentation and plugins that were registered
- - (): void
  - It will register instrumentations and plugins
    
    Returns void
    returns function to unload instrumentation and plugins that were registered

safeExecuteInTheMiddle

safeExecuteInTheMiddle<T>(execute: (() => T), onFinish: ((e: undefined | Error, result: undefined | T) => void), preventThrowingError?: boolean): T

- Defined in experimental/packages/opentelemetry-instrumentation/src/utils.ts:24
function to execute patched function and being able to catch errors

Type Parameters
- T
Parameters
- execute: (() => T)
  
  function to be executed
  - - (): T
    - Returns T
- onFinish: ((e: undefined | Error, result: undefined | T) => void)
  
  callback to run when execute finishes
  - - (e: undefined | Error, result: undefined | T): void
    - Parameters
      - e: undefined | Error
      - result: undefined | T
      Returns void
- Optional preventThrowingError: boolean
Returns T

safeExecuteInTheMiddleAsync

safeExecuteInTheMiddleAsync<T>(execute: (() => T), onFinish: ((e: undefined | Error, result: undefined | T) => void), preventThrowingError?: boolean): Promise<T>

- Defined in experimental/packages/opentelemetry-instrumentation/src/utils.ts:51
Async function to execute patched function and being able to catch errors

Type Parameters
- T
Parameters
- execute: (() => T)
  
  function to be executed
  - - (): T
    - Returns T
- onFinish: ((e: undefined | Error, result: undefined | T) => void)
  
  callback to run when execute finishes
  - - (e: undefined | Error, result: undefined | T): void
    - Parameters
      - e: undefined | Error
      - result: undefined | T
      Returns void
- Optional preventThrowingError: boolean
Returns Promise<T>

Index

Modules

Classes

Interfaces

Type Aliases

Functions

Type Aliases

InstrumentationOption

Functions

isWrapped

Parameters

func: unknown

Returns func is ShimWrapped

registerInstrumentations

Parameters

options: AutoLoaderOptions

Returns (() => void)

Returns void

safeExecuteInTheMiddle

Type Parameters

T

Parameters

execute: (() => T)

Returns T

onFinish: ((e: undefined | Error, result: undefined | T) => void)

Parameters

e: undefined | Error

result: undefined | T

Returns void

Optional preventThrowingError: boolean

Returns T

safeExecuteInTheMiddleAsync

Type Parameters

T

Parameters

execute: (() => T)

Returns T

onFinish: ((e: undefined | Error, result: undefined | T) => void)

Parameters

e: undefined | Error

result: undefined | T

Returns void

Optional preventThrowingError: boolean

Returns Promise<T>