Skip to main content

Interface: TelemetryOptions

Defined in: src/observability/telemetry.ts:35

Configuration options for OpenTelemetry initialization.

Properties​

autoInstrumentation?​

readonly optional autoInstrumentation: object

Defined in: src/observability/telemetry.ts:94

Enable auto-instrumentation for specific libraries.

http?​

readonly optional http: boolean

pg?​

readonly optional pg: boolean

redis?​

readonly optional redis: boolean

Remarks​

Controls which auto-instrumentation plugins are enabled.

Default Value​

{ http: true, pg: true, redis: true }

environment?​

readonly optional environment: string

Defined in: src/observability/telemetry.ts:64

Deployment environment.

Remarks​

Appears in traces and metrics as deployment.environment.

Default Value​

process.env.NODE_ENV || 'development'

metricExportIntervalMs?​

readonly optional metricExportIntervalMs: number

Defined in: src/observability/telemetry.ts:84

Metric export interval in milliseconds.

Remarks​

How often metrics are sent to the collector.

Default Value​

15000 (15 seconds)

otlpEndpoint?​

readonly optional otlpEndpoint: string

Defined in: src/observability/telemetry.ts:74

OTEL Collector endpoint for traces.

Remarks​

The OTLP HTTP endpoint for sending traces.

Default Value​

process.env.OTEL_EXPORTER_OTLP_ENDPOINT || 'http://otel-collector:4318'

serviceName?​

readonly optional serviceName: string

Defined in: src/observability/telemetry.ts:44

Service name for trace attribution.

Remarks​

Appears in traces and metrics as service.name.

Default Value​

process.env.OTEL_SERVICE_NAME || 'chive-appview'

serviceVersion?​

readonly optional serviceVersion: string

Defined in: src/observability/telemetry.ts:54

Service version.

Remarks​

Appears in traces and metrics as service.version.

Default Value​

process.env.OTEL_SERVICE_VERSION || process.env.npm_package_version || '0.0.0'