Class FetchInstrumentation

Implements

Instrumentation

Index

Constructors

Properties

config instrumentationName instrumentationVersion originalFetch tracerProvider

Methods

disable enable getConfig instrumentFetch instrumentHttp setConfig setMeterProvider setTracerProvider shouldIgnore shouldPropagate startSpan

Constructors

constructor

new FetchInstrumentation(config?): FetchInstrumentation
Parameters
- config: FetchInstrumentationConfig = {}
Returns FetchInstrumentation

Properties

`Private` `Internal` config

config: FetchInstrumentationConfig

instrumentationName

instrumentationName: string = "@vercel/otel/fetch"

instrumentationVersion

instrumentationVersion: string = "1.0.0"

`Private` `Internal` originalFetch

originalFetch: undefined | ((input, init?) => Promise<Response>)

Type declaration

- (input, init?): Promise<Response>
- Parameters
  - input: URL | RequestInfo
  - Optional init: RequestInit
  Returns Promise<Response>

`Private` `Internal` tracerProvider

tracerProvider: undefined | TracerProvider

Methods

disable

disable(): void
Returns void
Implementation of Instrumentation.disable

enable

enable(): void
Returns void
Implementation of Instrumentation.enable

getConfig

getConfig(): FetchInstrumentationConfig
Returns FetchInstrumentationConfig
Implementation of Instrumentation.getConfig

instrumentFetch

instrumentFetch(): void
Returns void

instrumentHttp

instrumentHttp(httpModule, protocolFromModule): void
Parameters
- httpModule: __module | __module
- protocolFromModule: "https:" | "http:"
Returns void

setConfig

setConfig(): void
Returns void
Implementation of Instrumentation.setConfig

setMeterProvider

setMeterProvider(): void
Returns void
Implementation of Instrumentation.setMeterProvider

setTracerProvider

setTracerProvider(tracerProvider): void
Parameters
- tracerProvider: TracerProvider
Returns void
Implementation of Instrumentation.setTracerProvider

`Private` shouldIgnore

shouldIgnore(url, init?): boolean
Parameters
- url: URL
- Optional init: InternalRequestInit
Returns boolean

`Private` shouldPropagate

shouldPropagate(url, init?): boolean
Parameters
- url: URL
- Optional init: InternalRequestInit
Returns boolean

`Private` startSpan

startSpan(__namedParameters): Span
Parameters
- __namedParameters: {
      attributes?: Attributes;
      fetchType: "http" | "fetch";
      method?: string;
      name?: string;
      tracer: Tracer;
      url: URL;
  }
  - Optional attributes?: Attributes
  - fetchType: "http" | "fetch"
  - Optional method?: string
  - Optional name?: string
  - tracer: Tracer
  - url: URL
Returns Span