fix(otel): capture application API copies through instrumentation

Regular dependencies let dd-trace's resolver win over an application-owned copy, which can leave bridge operations on a different global registry. Keep the fallback copies optional. Provider registration remains pinned to compatibility-max owners.

Fixes: #6882

Author: BridgeAR

.github/workflows/instrumentation.yml

@@ -405,6 +405,16 @@ jobs:
       - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
       - uses: ./.github/actions/instrumentations/test
 
+  instrumentation-otel-api:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    env:
+      PLUGINS: otel-api
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+      - uses: ./.github/actions/instrumentations/test
+
   instrumentation-otel-sdk-trace:
     runs-on: ubuntu-latest
     permissions:

docs/API.md

@@ -400,10 +400,10 @@ const tracerProvider = new tracer.TracerProvider()
 tracerProvider.register()
 ```
 
-dd-trace registers providers through its bundled, compatibility-max OpenTelemetry API copies.
-Application copies of `@opentelemetry/api` from 1.4.1 through 1.9.x and
-`@opentelemetry/api-logs` from 0.33.0 through 0.x consume those providers through OpenTelemetry's
-global API without becoming provider owners themselves.
+dd-trace captures application copies of `@opentelemetry/api` from 1.4.1 through 1.9.x and
+`@opentelemetry/api-logs` from 0.33.0 through 0.x for bridge operations. Provider registration stays
+on dd-trace's optional compatibility-max copies so every supported application copy can consume the
+providers through OpenTelemetry's global API.
 
 The `dd-trace/esbuild` and `dd-trace/webpack` plugins keep dd-trace's API copies inside relocated
 bundles even when application imports are configured as external. Application imports otherwise

integration-tests/helpers/otel-api-bundle.js

@@ -116,8 +116,8 @@ const apiLogs = holder.getApiLogs()`
     ? `if (api.trace !== globalThis.__ddRuntimeApi.trace || apiLogs.logs !== globalThis.__ddRuntimeApiLogs.logs) {
   throw new Error('Application OpenTelemetry APIs were bundled instead of loaded at runtime')
 }
-if (api.trace === holder.getApi().trace || apiLogs.logs === holder.getApiLogs().logs) {
-  throw new Error('Application and bridge APIs unexpectedly share a bundled module')
+if (api.trace !== holder.getApi().trace || apiLogs.logs !== holder.getApiLogs().logs) {
+  throw new Error('The bridge did not capture the application OpenTelemetry APIs')
 }
 `
     : ''

package.json

@@ -167,8 +167,6 @@
     "version.js"
   ],
   "dependencies": {
-    "@opentelemetry/api": "1.9.1",
-    "@opentelemetry/api-logs": "0.212.0",
     "dc-polyfill": "^0.1.11",
     "import-in-the-middle": "^3.3.1",
     "opentracing": ">=0.14.7"
@@ -181,6 +179,8 @@
     "@datadog/openfeature-node-server": "2.0.0",
     "@datadog/pprof": "5.15.1",
     "@datadog/wasm-js-rewriter": "5.0.1",
+    "@opentelemetry/api": "1.9.1",
+    "@opentelemetry/api-logs": "0.212.0",
     "oxc-parser": "^0.132.0"
   },
   "devDependencies": {

packages/datadog-esbuild/index.js

@@ -51,6 +51,8 @@ function addModuleOfInterest (name, file) {
 const modulesOfInterest = new Set()
 
 for (const [name, instrumentation] of Object.entries(instrumentations)) {
+  if (OTEL_API_PACKAGE_PATTERN.test(name)) continue
+
   for (const entry of instrumentation) {
     addModuleOfInterest(name, entry.file)
   }

packages/datadog-instrumentations/src/helpers/hooks.js

@@ -48,6 +48,8 @@ module.exports = {
   '@langchain/core': { esmFirst: true, fn: () => require('../langchain') },
   '@node-redis/client': () => require('../redis'),
   '@opensearch-project/opensearch': () => require('../opensearch'),
+  '@opentelemetry/api': { esmFirst: true, fn: () => require('../otel-api') },
+  '@opentelemetry/api-logs': { esmFirst: true, fn: () => require('../otel-api') },
   '@opentelemetry/sdk-trace': () => require('../otel-sdk-trace'),
   '@opentelemetry/sdk-trace-node': () => require('../otel-sdk-trace'),
   '@prisma/client': { esmFirst: true, fn: () => require('../prisma') },

packages/datadog-instrumentations/src/otel-api.js

@@ -0,0 +1,22 @@
+'use strict'
+
+const {
+  API_LOGS_VERSION_RANGE,
+  API_VERSION_RANGE,
+  setApi,
+  setApiLogs,
+} = require('../../dd-trace/src/opentelemetry/api')
+const { addHook } = require('./helpers/instrument')
+
+addHook({
+  name: '@opentelemetry/api',
+  versions: [API_VERSION_RANGE],
+  // The default export omits constants used by the bridge.
+  patchDefault: false,
+}, setApi)
+
+addHook({
+  name: '@opentelemetry/api-logs',
+  versions: [API_LOGS_VERSION_RANGE],
+  patchDefault: false,
+}, setApiLogs)

packages/datadog-instrumentations/test/otel-api.spec.js

@@ -0,0 +1,75 @@
+'use strict'
+
+const assert = require('node:assert/strict')
+
+const { describe, it, beforeEach } = require('mocha')
+const proxyquire = require('proxyquire')
+const sinon = require('sinon')
+
+describe('otel-api instrumentation', () => {
+  let addHook
+  let hooks
+  let setApi
+  let setApiLogs
+
+  function load () {
+    addHook = sinon.spy()
+    setApi = sinon.spy(api => api)
+    setApiLogs = sinon.spy(apiLogs => apiLogs)
+    proxyquire.noPreserveCache()
+    try {
+      proxyquire('../src/otel-api', {
+        './helpers/instrument': { addHook },
+        '../../dd-trace/src/opentelemetry/api': {
+          API_LOGS_VERSION_RANGE: '>=0.33.0 <1.0.0',
+          API_VERSION_RANGE: '>=1.4.1 <1.10.0',
+          setApi,
+          setApiLogs,
+        },
+      })
+    } finally {
+      proxyquire.preserveCache()
+    }
+    const hooks = new Map()
+    for (const call of addHook.getCalls()) {
+      hooks.set(call.args[0].name, call.args[1])
+    }
+    return hooks
+  }
+
+  beforeEach(() => {
+    hooks = load()
+  })
+
+  it('hooks @opentelemetry/api across the supported range', () => {
+    sinon.assert.calledWith(addHook, {
+      name: '@opentelemetry/api',
+      versions: ['>=1.4.1 <1.10.0'],
+      patchDefault: false,
+    }, setApi)
+  })
+
+  it('hooks @opentelemetry/api-logs across its published pre-1.0 range', () => {
+    sinon.assert.calledWith(addHook, {
+      name: '@opentelemetry/api-logs',
+      versions: ['>=0.33.0 <1.0.0'],
+      patchDefault: false,
+    }, setApiLogs)
+  })
+
+  it('passes the loaded core API to the holder unchanged', () => {
+    const api = { trace: {}, context: {} }
+    const hookMetadata = { moduleBaseDir: '/app/node_modules/@opentelemetry/api' }
+
+    assert.strictEqual(hooks.get('@opentelemetry/api')(api, '1.9.0', false, hookMetadata), api)
+    sinon.assert.calledOnceWithExactly(setApi, api, '1.9.0', false, hookMetadata)
+  })
+
+  it('passes the loaded Logs API to the holder unchanged', () => {
+    const apiLogs = { logs: {}, SeverityNumber: {} }
+    const hookMetadata = { moduleBaseDir: '/app/node_modules/@opentelemetry/api-logs' }
+
+    assert.strictEqual(hooks.get('@opentelemetry/api-logs')(apiLogs, '0.212.0', false, hookMetadata), apiLogs)
+    sinon.assert.calledOnceWithExactly(setApiLogs, apiLogs, '0.212.0', false, hookMetadata)
+  })
+})

packages/datadog-webpack/index.js

@@ -26,6 +26,8 @@ for (const hook of Object.values(hooks)) {
 const modulesOfInterest = new Set()
 
 for (const [name, instrumentation] of Object.entries(instrumentations)) {
+  if (OTEL_API_PACKAGE_PATTERN.test(name)) continue
+
   for (const entry of instrumentation) {
     if (entry.file) {
       modulesOfInterest.add(`${name}/${entry.file}`) // e.g. "redis/my/file.js"

packages/dd-trace/src/openfeature/eval-metrics-hook.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const log = require('../log')
-const { getApi } = require('../opentelemetry/api')
+const { getApiOwner } = require('../opentelemetry/api')
 
 const METER_NAME = 'dd-trace-js/openfeature'
 const COUNTER_NAME = 'feature_flag.evaluations'
@@ -54,7 +54,7 @@ class EvalMetricsHook {
     if (this.#counter) return this.#counter
 
     try {
-      const { metrics } = getApi()
+      const { metrics } = getApiOwner()
       const meter = metrics.getMeter(METER_NAME)
       this.#counter = meter.createCounter(COUNTER_NAME, {
         description: COUNTER_DESCRIPTION,