Skip to main content

Configuration

Default configuration keys for @quik/telemetry. See Config Keys and Environment Variables for the full generated table.

  • telemetry.enabled (env TELEMETRY_ENABLED) turns the OpenTelemetry SDK on; when unset, getTelemetry() still works but returns a no-op implementation (QDefaultTelemetry) whose spans do nothing.
  • telemetry.serviceName (env TELEMETRY_SERVICE_NAME) sets OTEL_SERVICE_NAME for the SDK.
  • telemetry.autoInstrumentations (env TELEMETRY_AUTO_INSTRUMENTATIONS) enables OpenTelemetry auto-instrumentations.
  • telemetry.exporter.otlp.endpoint (env TELEMETRY_OTLP_ENDPOINT) is the OTLP collector endpoint traces are exported to.
  • telemetry.logging.bridge (env TELEMETRY_LOGGING_BRIDGE) attaches log records to the active span via TelemetryLogger.
  • telemetry.logging.passthrough (env TELEMETRY_LOGGING_PASSTHROUGH) also forwards bridged logs to the existing logger.

No-op by default​

getTelemetry() (re-exported from @quik/core) never throws or returns undefined — without @quik/telemetry registered and telemetry.enabled set, it resolves to a default implementation whose startSpan()/withSpan() are no-ops. This means telemetry-instrumented code (including QObject's own startSpan helper) is always safe to call.