Interface TelemetryConfig

Configuration for the telemetry system

interface TelemetryConfig {
    appName: string;
    appVersion?: string;
    otlpEndpoint?: string;
    otlpHeaders?: Record<string, string>;
    environment?: string;
    enableTracing?: boolean;
    enableMetrics?: boolean;
    enableAutoInstrumentation?: boolean;
    debug?: boolean;
    captureMessageContent?: boolean;
    samplingRatio?: number;
    metricExportIntervalMs?: number;
    resourceAttributes?: Record<string, string | number | boolean>;
}

Properties

appName appVersion? otlpEndpoint? otlpHeaders? environment? enableTracing? enableMetrics? enableAutoInstrumentation? debug? captureMessageContent? samplingRatio? metricExportIntervalMs? resourceAttributes?

Properties

appName

appName: string

Application name (used as service name)

OptionalappVersion

appVersion?: string

Application version (optional)

OptionalotlpEndpoint

otlpEndpoint?: string

OTLP endpoint for traces (e.g., http://localhost:4318/v1/traces)

OptionalotlpHeaders

otlpHeaders?: Record<string, string>

Custom headers for OTLP exporter

Optionalenvironment

environment?: string

Deployment environment (e.g., development, staging, production)

OptionalenableTracing

enableTracing?: boolean

Enable tracing (default: true)

OptionalenableMetrics

enableMetrics?: boolean

Enable metrics (default: true)

OptionalenableAutoInstrumentation

enableAutoInstrumentation?: boolean

Enable auto-instrumentation for HTTP, databases, etc. (default: true)

Optionaldebug

debug?: boolean

Enable debug mode (default: false). When enabled, in-memory exporter is active.

OptionalcaptureMessageContent

captureMessageContent?: boolean

Capture message content in traces (default: true, set false for privacy)

OptionalsamplingRatio

samplingRatio?: number

Sampling ratio for traces (0.0 to 1.0, default: 1.0 = 100%)

OptionalmetricExportIntervalMs

metricExportIntervalMs?: number

Metric export interval in milliseconds (default: 60000 = 1 minute)

OptionalresourceAttributes

resourceAttributes?: Record<string, string | number | boolean>

Additional resource attributes

Settings

Member Visibility

On This Page

Properties