OpenTelemetryServerOptions (@defjs/opentelemetry-server)

Options for withOpenTelemetryServer: tracer, meter, logger, propagator, and per-transport settings.

@defjs/opentelemetry-server · Type

Signature

interface OpenTelemetryServerOptions {
  tracer?: Tracer;
  meter?: Meter;
  logger?: Logger;
  propagator?: TextMapPropagator;
  requireParentSpan?: boolean;
  http?: OpenTelemetryServerHttpOptions;
  sse?: OpenTelemetryServerSSEOptions;
  webSocket?: OpenTelemetryServerWebSocketOptions;
}

Pass application-owned OpenTelemetry Tracer, Meter, and/or Logger handles. This package does not initialize the OpenTelemetry SDK.

tracer — Optional. Without it there are no local spans and no span hooks.
meter — Optional. Without it no package metrics are recorded.
logger — Optional. A Logger from @opentelemetry/api-logs, not a Winston/Pino Logger. Without it no diagnostic LogRecords are emitted. Defjs never obtains a global logger or owns its provider.
propagator — Defaults to W3C Trace Context + Baggage.
requireParentSpan — Defaults to false. With a tracer, true bypasses all instrumentation, including logs, when no active parent span exists. Without a tracer it blocks neither metrics nor logs.
http, sse, webSocket — Per-transport options. Each defaults to {}; a transport is disabled only by { enabled: false }.

Members

Prop

Type

tracer? Tracer | undefined

Optional tracer; omitting it disables outbound spans and span hooks.

meter? Meter | undefined

Optional meter; when set, per-transport client metrics are recorded.

logger? Logger | undefined

Optional logger; emits WARN diagnostics for failed outbound requests and connections.

propagator? TextMapPropagator<any> | undefined

Context propagator. Defaults to W3C Trace Context + Baggage.

requireParentSpan? boolean | undefined

With a tracer, bypass instrumentation when no active parent span exists. Ignored without a tracer.

http? OpenTelemetryServerHttpOptions | undefined

HTTP transport instrumentation options.

sse? OpenTelemetryServerSSEOptions | undefined

SSE transport instrumentation options.

webSocket? OpenTelemetryServerWebSocketOptions | undefined

WebSocket transport instrumentation options.