interface TelemetryPluginOptions
Since 0.2.0

Options for the TelemetryPlugin.

Properties

optional
serviceName: string

Service name reported to the exporter (required when exporter is configured).

optional
serviceVersion: string

Service version (default: '1.0.0').

Which exporter to use. Absent = noop mode.

optional
endpoint: string

OTLP endpoint URL (required when exporter: 'otlp').

optional
headers: Record<string, string>

Optional headers sent with OTLP requests.

Sampling configuration.

optional
tracerProviderFactory: () => Promise<TracerHost>

Injectable factory that returns a pre-built TracerHost (test seam).

optional
middleware: boolean

Whether to register the request-span middleware (default: true).

optional
contextPropagation: boolean

Whether real OTel spans become active for nested work (default: true).

optional
contextManagerFactory: () => Promise<{ enable(): unknown; disable(): unknown; }>

Injectable loader for the OTel context manager.

Since 0.2.0
optional
spanProcessor: SpanProcessorKind

Span processor to use ('simple' by default, 'batch' as an option).

Auto-instrumentation configuration.

Each key enables one instrumentation on supported runtimes (Node only). Omitting a key leaves that instrumentation off.

Usage

import { type TelemetryPluginOptions } from "telemetry-plugin/src/index.ts";