Missing @opentelemetry/api dependency on startup

[jomi-se]

I have a project using @elastic/opentelemetry-node. After a routine update to 1.1.1 from 1.0.0 we're getting an error on startup:

Error: Cannot find module '@opentelemetry/api'
Require stack:
- /workdir/node_modules/.pnpm/@elastic+opentelemetry-node@1.1.1_@opentelemetry+api@1.9.0/node_modules/@elastic/opentelemetry-node/lib/detector-gcp.js
- /workdir/node_modules/.pnpm/@elastic+opentelemetry-node@1.1.1_@opentelemetry+api@1.9.0/node_modules/@elastic/opentelemetry-node/lib/detectors.js
- /workdir/node_modules/.pnpm/@elastic+opentelemetry-node@1.1.1_@opentelemetry+api@1.9.0/node_modules/@elastic/opentelemetry-node/lib/sdk.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1212:15)
    at Module._load (node:internal/modules/cjs/loader:1043:27)
    at Module.require (node:internal/modules/cjs/loader:1298:19)
    at require (node:internal/modules/helpers:182:18)
    at Object.<anonymous> (/workdir/node_modules/.pnpm/@elastic+opentelemetry-node@1.1.1_@opentelemetry+api@1.9.0/node_modules/@elastic/opentelemetry-node/lib/detector-gcp.js:11:19)
    at Module._compile (node:internal/modules/cjs/loader:1529:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1613:10)
    at Module.load (node:internal/modules/cjs/loader:1275:32)
    at Module._load (node:internal/modules/cjs/loader:1096:12)
    at Module.require (node:internal/modules/cjs/loader:1298:19) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
    '/workdir/node_modules/.pnpm/@elastic+opentelemetry-node@1.1.1_@opentelemetry+api@1.9.0/node_modules/@elastic/opentelemetry-node/lib/detector-gcp.js',
    '/workdir/node_modules/.pnpm/@elastic+opentelemetry-node@1.1.1_@opentelemetry+api@1.9.0/node_modules/@elastic/opentelemetry-node/lib/detectors.js',
    '/workdir/node_modules/.pnpm/@elastic+opentelemetry-node@1.1.1_@opentelemetry+api@1.9.0/node_modules/@elastic/opentelemetry-node/lib/sdk.js'
  ]
}

I guess the detector-gcp.js was only released in the last version

[trentm]

@jomi-se Thanks for reporting this.

@opentelemetry/api is listed in peerDependencies, but I guess that isn't sufficient for the way pnpm installs things.
Listing @opentelemetry/api in peerDependencies is the same thing that the upstream resource-detector-gcp is doing: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/5909ad49d6ad5b1364b3b62e1593b918931b7ba6/detectors/node/opentelemetry-resource-detector-gcp/package.json#L57 so I would think the same issue might happen there.

[trentm]

I attempted to reproduce this, but could not. Here is what I tried:

% cat just-http-request.js
const http = require('http');
const url = 'http://www.google.com/';
const clientReq = http.request(url, function (cres) {
    console.log('client response: %s %s', cres.statusCode, cres.headers);
    const chunks = [];
    cres.on('data', function (chunk) {
        chunks.push(chunk);
    });
    cres.on('end', function () {
        const body = chunks.join('');
        console.log(
            'client response body (%d bytes): %s...',
            Buffer.byteLength(body),
            body.slice(0, 40)
        );
    });
});
clientReq.end();

% cat package.json
{
  "name": "asdf.20250618t092505",
  "version": "1.0.0",
  "main": "index.js",
  "dependencies": {
    "@elastic/opentelemetry-node": "^1.1.1"
  }
}

Use pnpm to install:

% npx pnpm install @elastic/opentelemetry-node
Packages: +163
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Progress: resolved 163, reused 163, downloaded 0, added 163, done

dependencies:
+ @elastic/opentelemetry-node 1.1.1

╭ Warning ───────────────────────────────────────────────────────────────────────────────────╮
│                                                                                            │
│   Ignored build scripts: protobufjs.                                                       │
│   Run "pnpm approve-builds" to pick which dependencies should be allowed to run scripts.   │
│                                                                                            │
╰────────────────────────────────────────────────────────────────────────────────────────────╯

Done in 2.4s using pnpm v10.12.1

Run my script using EDOT Node.js, which worked for me:

% node --import @elastic/opentelemetry-node just-http-request.js
{"name":"elastic-otel-node","level":30,"preamble":true,"distroVersion":"1.1.1","env":{"os":"darwin 24.5.0","arch":"arm64","runtime":"Node.js v20.19.1"},"config":{"logLevel":"info"},"msg":"start EDOT Node.js","time":"2025-06-18T16:46:26.931Z"}
{"name":"elastic-otel-node","level":40,"msg":"Unsupported OTLP metrics protocol: \"undefined\". Using http/protobuf.","time":"2025-06-18T16:46:26.952Z"}
client response: 200 {
  date: 'Wed, 18 Jun 2025 16:46:27 GMT',
  expires: '-1',
  'cache-control': 'private, max-age=0',
  'content-type': 'text/html; charset=ISO-8859-1',
  'content-security-policy-report-only': "object-src 'none';base-uri 'self';script-src 'nonce-sNA67ZM5-RU6RkcrHjuWYg' 'strict-dynamic' 'report-sample' 'unsafe-eval' 'unsafe-inline' https: http:;report-uri https://csp.withgoogle.com/csp/gws/other-hp",
  p3p: 'CP="This is not a P3P policy! See g.co/p3phelp for more info."',
  server: 'gws',
  'x-xss-protection': '0',
  'x-frame-options': 'SAMEORIGIN',
  'set-cookie': [Array],
  'accept-ranges': 'none',
  vary: 'Accept-Encoding',
  'transfer-encoding': 'chunked'
}
client response body (55199 bytes): <!doctype html><html itemscope="" itemty...

@jomi-se Could you show more details so that I can see how to reproduce the error? Thanks.

[trentm]

@jomi-se You closed #847 last week. Is this issue still an issue for you? Did you find some other fix or workaround? Thanks.