feat: Support for adding @opentelemetry/instrumentation-runtime-node (#210)

closes #166

Author: sjvans

CHANGELOG.md

@@ -9,9 +9,20 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 ### Added
 
 - 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:
+      ```json
+      "instrumentation-runtime-node": {
+        "class": "RuntimeNodeInstrumentation",
+        "module": "@opentelemetry/instrumentation-runtime-node"
+      }
+      ```
 
 ### Changed
 
+- Instrumentations are registered after tracing and metrics are set up
+
 ### Fixed
 
 ### Removed
@@ -52,8 +63,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 ### Added
 
 - Support for own, high resolution timestamps
-  + Enable via `cds.env.requires.telemetry.tracing.hrtime = true`
-  + Enabled by default in development profile
+  - Enable via `cds.env.requires.telemetry.tracing.hrtime = true`
+  - Enabled by default in development profile
 
 ## Version 0.0.5 - 2024-03-11
 
@@ -66,10 +77,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 ### Changed
 
 - By default, all `system.*` metrics collected by `@opentelemetry/host-metrics` are ignored
-  + Disable change via environment variable `HOST_METRICS_RETAIN_SYSTEM=true`
+  - 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.env.requires.telemetry.metrics.exporter.config.temporalityPreference`
+  - Was previously only done for kind `telemetry-to-dynatrace`
+  - Set custom value via `cds.env.requires.telemetry.metrics.exporter.config.temporalityPreference`
 
 ### Fixed
 

lib/exporter/ConsoleSpanExporter.js

@@ -4,6 +4,14 @@ const LOG = cds.log('telemetry')
 const path = require('path')
 
 const { ExportResultCode, hrTimeToMilliseconds } = require('@opentelemetry/core')
+const {
+  SEMATTRS_HTTP_TARGET,
+  SEMATTRS_CODE_FILEPATH,
+  SEMATTRS_CODE_LINENO
+  // SEMATTRS_CODE_COLUMN
+} = require('@opentelemetry/semantic-conventions')
+// REVISIT: SEMATTRS_CODE_COLUMN doesn't yet exist in semantic conventions 1.25
+const SEMATTRS_CODE_COLUMN = 'code.column'
 
 const _padded = v =>
   `${`${v}`.split('.')[0].padStart(3, ' ')}.${(`${v}`.split('.')[1] || '0').padEnd(2, '0').substring(0, 2)}`
@@ -18,25 +26,25 @@ const _span2line = (span, parentStartTime = 0) => {
   let result = `\n  ${_padded(start)} → ${_padded(end)} = ${_padded(duration)} ms`
 
   let name = span.name
-  if (name.match(/^[A-Z]+$/)) name = name + ' ' + span.attributes['http.target']
+  if (name.match(/^[A-Z]+$/)) name = name + ' ' + span.attributes[SEMATTRS_HTTP_TARGET]
   if (name.length > 80) name = name.substring(0, 79) + '…'
 
   result += '  ' + (span.___indent || '') + name
 
   // REVISIT: what is this for?
-  if (span.attributes['code.filepath'] !== undefined) {
+  if (span.attributes[SEMATTRS_CODE_FILEPATH] !== undefined) {
     if (
       path
-        .normalize(span.attributes['code.filepath'])
+        .normalize(span.attributes[SEMATTRS_CODE_FILEPATH])
         .match(new RegExp(path.normalize(cds.env._home).replaceAll('\\', '\\\\'), 'g')) &&
-      !path.normalize(span.attributes['code.filepath']).match(/node_modules/g)
+      !path.normalize(span.attributes[SEMATTRS_CODE_FILEPATH]).match(/node_modules/g)
     ) {
       result += `: .${path
-        .normalize(span.attributes['code.filepath'])
+        .normalize(span.attributes[SEMATTRS_CODE_FILEPATH])
         .substring(
           path.normalize(cds.env._home).length + 1,
-          path.normalize(span.attributes['code.filepath']).length
-        )}:${span.attributes['code.lineno']}:${span.attributes['code.column']}`
+          path.normalize(span.attributes[SEMATTRS_CODE_FILEPATH]).length
+        )}:${span.attributes[SEMATTRS_CODE_LINENO]}:${span.attributes[SEMATTRS_CODE_COLUMN]}`
     }
   }
 

lib/index.js

@@ -1,10 +1,22 @@
 const cds = require('@sap/cds')
 
 const { diag } = require('@opentelemetry/api')
+const { registerInstrumentations } = require('@opentelemetry/instrumentation')
+const { SEMRESATTRS_SERVICE_NAME, SEMRESATTRS_SERVICE_VERSION } = require('@opentelemetry/semantic-conventions')
 
 const tracing = require('./tracing')
 const metrics = require('./metrics')
-const { getDiagLogLevel, getResource } = require('./utils')
+const { getDiagLogLevel, getResource, _require } = require('./utils')
+
+function _getInstrumentations() {
+  const instrumentations = []
+  for (const each of Object.values(cds.env.requires.telemetry.instrumentations)) {
+    const module = _require(each.module)
+    if (!module[each.class]) throw new Error(`Unknown instrumentation "${each.class}" in module "${each.module}"`)
+    instrumentations.push(new module[each.class]({ ...(each.config || {}) }))
+  }
+  return instrumentations
+}
 
 module.exports = function () {
   // set logger and propagate log level
@@ -14,17 +26,22 @@ module.exports = function () {
 
   // REVISIT: better way to make available?
   cds._telemetry = {
-    name: resource.attributes['service.name'],
-    version: resource.attributes['service.version']
+    name: resource.attributes[SEMRESATTRS_SERVICE_NAME],
+    version: resource.attributes[SEMRESATTRS_SERVICE_VERSION]
   }
 
   /*
-   * add tracing
+   * setup tracing
    */
   tracing(resource)
 
   /*
-   * add metrics
+   * setup metrics
    */
   metrics(resource)
+
+  /*
+   * register instrumentations
+   */
+  registerInstrumentations({ instrumentations: _getInstrumentations() })
 }

lib/tracing/index.js

@@ -3,7 +3,6 @@ const LOG = cds.log('telemetry')
 
 const { trace } = require('@opentelemetry/api')
 const { Resource } = require('@opentelemetry/resources')
-const { registerInstrumentations } = require('@opentelemetry/instrumentation')
 const { BatchSpanProcessor, SimpleSpanProcessor, SamplingDecision } = require('@opentelemetry/sdk-trace-base')
 const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node')
 
@@ -63,16 +62,6 @@ function _getPropagator() {
   return new core.CompositePropagator({ propagators })
 }
 
-function _getInstrumentations() {
-  const instrumentations = []
-  for (const each of Object.values(cds.env.requires.telemetry.instrumentations)) {
-    const module = _require(each.module)
-    if (!module[each.class]) throw new Error(`Unknown instrumentation "${each.class}" in module "${each.module}"`)
-    instrumentations.push(new module[each.class]({ ...(each.config || {}) }))
-  }
-  return instrumentations
-}
-
 function _getExporter() {
   let {
     kind,
@@ -125,8 +114,6 @@ module.exports = resource => {
     resource = new Resource({}).merge(resource).merge(dtmetadata)
     tracerProvider = new NodeTracerProvider({ resource, sampler: _getSampler() })
     tracerProvider.register({ propagator: _getPropagator() })
-    const instrumentations = _getInstrumentations()
-    registerInstrumentations({ tracerProvider, instrumentations })
   } else {
     LOG._warn && LOG.warn('TracerProvider already initialized by a different module. It will be used as is.')
     tracerProvider = tracerProvider.getDelegate()

lib/tracing/trace.js

@@ -3,11 +3,12 @@ const cds = require('@sap/cds')
 const otel = require('@opentelemetry/api')
 const { SpanKind, SpanStatusCode, ROOT_CONTEXT } = otel
 const {
+  SEMATTRS_HTTP_TARGET,
   SEMATTRS_CODE_FUNCTION,
   SEMATTRS_CODE_FILEPATH,
   SEMATTRS_CODE_NAMESPACE,
   SEMATTRS_CODE_LINENO,
-  SEMATTRS_CODE_COLUMN,
+  // SEMATTRS_CODE_COLUMN,
   SEMATTRS_DB_SYSTEM,
   SEMATTRS_DB_NAME,
   SEMATTRS_DB_USER,
@@ -18,6 +19,8 @@ const {
   SEMATTRS_DB_OPERATION,
   SEMATTRS_DB_SQL_TABLE
 } = require('@opentelemetry/semantic-conventions')
+// REVISIT: SEMATTRS_CODE_COLUMN doesn't yet exist in semantic conventions 1.25
+const SEMATTRS_CODE_COLUMN = 'code.column'
 
 const { _hrnow } = require('../utils')
 
@@ -49,7 +52,8 @@ function _getParentSpan() {
       // root span gets request attributes
       _setAttributes(parent, _getRequestAttributes())
       if (HRTIME) parent.startTime = cds.context.http?.req?.__hrnow || _hrnow()
-      if (ADJUST_ROOT_NAME && parent.attributes['http.target']) parent.name += ' ' + parent.attributes['http.target']
+      if (ADJUST_ROOT_NAME && parent.attributes[SEMATTRS_HTTP_TARGET])
+        parent.name += ' ' + parent.attributes[SEMATTRS_HTTP_TARGET]
     }
     if (!parent?._is_async) cds.context._otelctx.setValue(cds.context._otelKey, parent)
   }

package.json

@@ -39,6 +39,7 @@
     "@opentelemetry/exporter-trace-otlp-proto": "^0.52.1",
     "@opentelemetry/host-metrics": "^0.35.0",
     "@opentelemetry/instrumentation": "^0.52.1",
+    "@opentelemetry/instrumentation-runtime-node": "^0.6.0",
     "@sap/cds-mtxs": "^2.0.5",
     "axios": "^1.6.7",
     "chai": "^4.4.1",

test/bookshop/package.json

@@ -4,6 +4,7 @@
     "@cap-js/telemetry": "*",
     "@cap-js/sqlite": "*",
     "@opentelemetry/host-metrics": "*",
+    "@opentelemetry/instrumentation-runtime-node": "*",
     "@sap/cds-mtxs": "*"
   },
   "cds": {
@@ -19,6 +20,10 @@
                 "/odata/v4/admin/Authors"
               ]
             }
+          },
+          "instrumentation-runtime-node": {
+            "class": "RuntimeNodeInstrumentation",
+            "module": "@opentelemetry/instrumentation-runtime-node"
           }
         },
         "_tracing": {