Setu-TS
    Preparing search index...

    Interface TelemetryPluginOptions

    Options for the TelemetryPlugin.

    0.2.0

    interface TelemetryPluginOptions {
        contextManagerFactory?: () => Promise<
            { disable(): unknown; enable(): unknown },
        >;
        contextPropagation?: boolean;
        diagnostics?: TraceDiagnosticsOptions;
        endpoint?: string;
        exporter?: SpanExporterKind;
        headers?: Record<string, string>;
        instrumentations?: InstrumentationsConfig;
        middleware?: boolean;
        queryParameters?: "omit" | "redact";
        redaction?: RedactionPolicy | IRedactionService;
        sampling?: SamplingConfig;
        serviceName?: string;
        serviceVersion?: string;
        spanProcessor?: SpanProcessorKind;
        tracerProviderFactory?: () => Promise<TracerHost>;
    }
    Index
    contextManagerFactory? contextPropagation? diagnostics? endpoint? exporter? headers? instrumentations? middleware? queryParameters? redaction? sampling? serviceName? serviceVersion? spanProcessor? tracerProviderFactory?
    contextManagerFactory?: () => Promise<{ disable(): unknown; enable(): unknown }>

    Injectable loader for the OTel context manager.

    contextPropagation?: boolean

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

    diagnostics?: TraceDiagnosticsOptions

    Opt-in minimized completed-span observations for the local diagnostics connector (M98g). Absent, the plugin still registers an ITraceDiagnosticsSource, but it answers disabled and observes nothing. Present with the built-in OTel provider, an additional span processor retains bounded, minimized records for approved operations only; the exporter and its processor are untouched.

    0.8.0

    endpoint?: string

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

    exporter?: SpanExporterKind

    Which exporter to use. Absent = noop mode.

    headers?: Record<string, string>

    Optional headers sent with OTLP requests.

    instrumentations?: InstrumentationsConfig

    Auto-instrumentation configuration.

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

    0.2.0

    middleware?: boolean

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

    queryParameters?: "omit" | "redact"

    Query-string handling for http.url; defaults to 'omit'.

    redaction?: RedactionPolicy | IRedactionService

    Optional policy or service used to redact retained query parameter values.

    sampling?: SamplingConfig

    Sampling configuration.

    serviceName?: string

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

    serviceVersion?: string

    Service version (default: '1.0.0').

    spanProcessor?: SpanProcessorKind

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

    0.2.0

    tracerProviderFactory?: () => Promise<TracerHost>

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

    Settings
    Member Visibility

    On This Page
    Properties