CHANGELOG.md

Change Log

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning. The format is based on Keep a Changelog.

Version 1.7.0 - tbd

Added

Changed

Fixed

• Prefer VCAP_APPLICATION.name over name in package.json for app name resolution

Removed

Version 1.6.0 - 2025-12-16

Added

• Provide custom resource attributes via cds.requires.telemetry.resource.attributes
• Added new queue statistic queue.processing_failed that tracks the number of failed attempts at processing tasks per instance, per tenant, per service
• Support for optimized queue runner (in @sap/cds^9.6)
• Support for @cap-js/hana's built-in pool

Changed

• W3CBaggagePropagator added to the list of default propagators (cds.requires.telemetry.tracing.propagators)

Fixed

• Resolving of OTEL_LOG_LEVEL
• Skip registration of queue metrics collection for unknown service
• queue.med_storage_time_in_seconds is now correctly calculated per service and ignoring cold entries
• queue.min_storage_time_in_seconds and queue.max_storage_time_in_seconds are no longer switched up
• Trace propagation in production by ensuring https gets wrapped

Version 1.5.4 - 2025-10-27

Fixed

• Handle pre-initialized LoggerProvider

Version 1.5.3 - 2025-09-01

Fixed

• Skip persistent queue metrics setup if no database is connected

Version 1.5.2 - 2025-08-18

Fixed

• SAP Passport propagation with cds.requires.telemetry.tracing._hana_prom = true

Version 1.5.1 - 2025-08-11

Fixed

• Ensure initialization of persistent queue statistics

Version 1.5.0 - 2025-07-16

Added

• Adopt stable semantic conventions
• Observation of Persistent Queue metrics (beta)
  • Disable via config cds.requires.telemetry.metrics._queue = false

Version 1.4.1 - 2025-06-27

Fixed

• Missing SQL-related attributes with cds.requires.telemetry.tracing._hana_prom = true

Version 1.4.0 - 2025-06-05

Added

• Support for @sap/cds^9

Fixed

• Remove stack from log message, if present

Version 1.3.1 - 2025-04-30

Fixed

• Version check in TypeScript projects

Version 1.3.0 - 2025-04-25

Added

• Skip instrumentation of HANA driver, if it does it itself
• telemetry-to-otlp: Automatically switch to gRPC (from default http/protobuf) when exporting to an endpoint with port 4317
• Version check for @opentelemetry dependencies (OpenTelemetry SDK 2.0 is not yet supported)

Changed

• By default, @cap-js/hana's promisification of the driver API is wrapped
  • Disable via config cds.requires.telemetry.tracing._hana_prom = false

Fixed

• NonRecordingSpans do not have attributes

Removed

• Inofficial instrumentation of legacy OData server

Version 1.2.4 - 2025-04-09

Fixed

• User-provided instances of SAP Cloud Logging should have either tag cloud-logging or Cloud Logging

Version 1.2.3 - 2025-03-10

Fixed

• Database span attributes
• Don't crash in case there are errors while determining the attributes for the current span

Version 1.2.2 - 2025-03-03

Fixed

• Handle SAP Passport inside tracer.startActiveSpan()

Version 1.2.1 - 2025-02-25

Fixed

• Don't crash in case property instrumentationLibrary of parent span is undefined

Version 1.2.0 - 2025-02-14

Added

• Improved support for tracing messaging services and cds.spawn
• Support for adding custom spans to trace hierarchy via tracer.startActiveSpan()
• Trace attribute db.client.response.returned_rows for queries via cds.ql
• Option to pass custom config to span processor via cds.requires.telemetry.tracing.processor.config
• Support for loading instrumentation hooks via path relative to cds.root.
  • The respective module must export either a function or, for bundling purposes, an object with a function named after the respective hook.
  • Example based on @opentelemetry/instrumentation-http:

    "instrumentations": {
      "http": {
        "config": {
          "ignoreIncomingRequestHook": "./lib/MyIgnoreIncomingRequestHook.js"
        }
      }
    }

• Support for ignoring incoming requests that match a certain base path via cds.requires.telemetry.tracing.sampler.ignoreIncomingPaths = [] (beta)
• Experimental!: Trace HANA interaction via @cap-js/hana's promisification of the driver API for increased accuracy
  • Enable via config cds.requires.telemetry.tracing._hana_prom
  • Requires @cap-js/hana^1.7.0
• Experimental!: Intercept and export application logs (cf. cds.log()) via OpenTelemetry
  • Enable by adding section logging to cds.requires.telemetry as follows (using grpc as an example):

    "logging": {
      "exporter": {
        "module": "@opentelemetry/exporter-logs-otlp-grpc",
        "class": "OTLPLogExporter"
      }
    }

  • Requires additional dependencies @opentelemetry/api-logs, @opentelemetry/sdk-logs, and the configured exporter module (cds.requires.telemetry.logging.module)

Changed

• Default config ignoreIncomingPaths: ['/health'] moved from cds.requires.telemetry.instrumentations.http.config to cds.requires.telemetry.tracing.sampler

Fixed

• User-provided instances of SAP Cloud Logging should have a tag cloud-logging (not a name matching cloud-logging)

Removed

• Internal cds._telemetry

Version 1.1.2 - 2024-12-10

Fixed

• ConsoleSpanExporter: cds.context may be undefined in local scripting scenarios

Version 1.1.1 - 2024-11-28

Fixed

• Use attribute url.path (with fallback to deprecated http.target) for sampling decision

Version 1.1.0 - 2024-11-27

Added

• Predefined kind telemetry-to-otlp that creates exporters based on OTLP exporter configuration via environment variables
• If @opentelemetry/instrumentation-runtime-node is in the project's dependencies but not in cds.requires.telemetry.instrumentations, it is registered automatically
  • Disable via cds.requires.telemetry.instrumentations.instrumentation-runtime-node = false
• Experimental!: Propagate W3C trace context to SAP HANA via session context SAP_PASSPORT
  • Enable via environment variable SAP_PASSPORT

Changed

• Base config moved to new cds.requires.kinds.telemetry for improved config merging

Fixed

• Built-in ConsoleMetricExporter uses correct attribute name process.cpu.state while exporting host metrics
• Exporting traces to the console in the presence of a traceparent header

Version 1.0.1 - 2024-08-10

Fixed

• Explicitly pass own providers when registering instrumentations (the global providers may be influenced by, for example, Dynatrace OneAgent)

Version 1.0.0 - 2024-08-08

Added

• Support for tracing native db statements (i.e., cds.run('SELECT * FROM DUMMY'))
• Support for SAP Cloud Logging credentials via user-provided service
• Support for adding @opentelemetry/instrumentation-runtime-node
  • npm add @opentelemetry/instrumentation-runtime-node
  • To cds.requires.telemetry.instrumentations, add:

    "instrumentation-runtime-node": {
      "class": "RuntimeNodeInstrumentation",
      "module": "@opentelemetry/instrumentation-runtime-node"
    }

Changed

• Instrumentations are registered after tracing and metrics are set up
• telemetry-to-dynatrace: Regardless of whether Dynatrace OneAgent is present or not, if dependency @opentelemetry/exporter-trace-otlp-proto is present, @cap-js/telemetry will export the traces via OpenTelemetry.

Fixed

• Tracing of db statements without active span

Version 0.2.3 - 2024-06-17

Fixed

• Only startup plugin if invoked for runtime (e.g., via cli cds serve)

Version 0.2.2 - 2024-06-03

Fixed

• Detect build job started via @sap/cds-dk/bin/cds.js

Version 0.2.1 - 2024-05-23

Fixed

• Avoid credentials validation during cds build

Version 0.2.0 - 2024-05-17

Added

• Support for local modules (e.g., exporters) via [...].module = '<path relative to cds.root>'
• Disable pool metrics via cds.requires.telemetry.metrics._db_pool = false (beta)

Fixed

• Get credentials from cds.env
• Validate existence of credentials only for configured kind
• HTTP attributes only for root spans (reduces trace payload size)

Version 0.1.0 - 2024-03-22

Added

• Support for own, high resolution timestamps
  • Enable via cds.requires.telemetry.tracing.hrtime = true
  • Enabled by default in development profile

Version 0.0.5 - 2024-03-11

Added

• Register span processor also if tracer provider is initialized by a different module
• Support for so-called Pull Metric Exporter (e.g., @opentelemetry/exporter-prometheus)
• Tenant-dependent DB attributes

Changed

• By default, all system.* metrics collected by @opentelemetry/host-metrics are ignored
  • Disable change via environment variable HOST_METRICS_RETAIN_SYSTEM=true
• Metric exporter's property temporalityPreference always gets defaulted to DELTA
  • Was previously only done for kind telemetry-to-dynatrace
  • Set custom value via cds.requires.telemetry.metrics.exporter.config.temporalityPreference

Fixed

• Identification of first-level spans in built-in ConsoleSpanExporter

Version 0.0.4 - 2024-02-09

Added

• Re-use TracerProvider and MeterProvider that were initialized by a different module (OpenTelemetry only allows one-time initialization)

Fixed

• NonRecordingSpans are handled correctly

Version 0.0.3 - 2024-01-30

Added

• Support for exporting traces to Dynatrace via OpenTelemetry exporter (instead of Dynatrace OneAgent)
• Support for Dynatrace credentials via user-provided service
• @opentelemetry/host-metrics is automatically fired up, if it is in the project's dependencies

Version 0.0.2 - 2024-01-15

Added

• Predefined kind for SAP Cloud Logging (telemetry-to-cloud-logging)
• Built-in ConsoleMetricExporter prints DB pool and other metrics separately

Version 0.0.1 - 2024-01-04

Added

• Initial release