Cannot find module '@opentelemetry/semantic-conventions/incubating' from 'node_modules/@opentelemetry/auto-instrumentations-node/node_modules/@opentelemetry/instrumentation-aws-lambda/build/src/instrumentation.js'

[GuidoGagliardini]

Hello Community

I have encountered this issue and would like to know if I should report it as a bug or if anyone has found a solution.

Node version: 16.14.0

First package.json version I have tried-->

"@opentelemetry/api": "^1.9.0",
"@opentelemetry/auto-instrumentations-node": "^0.55.1",
"@opentelemetry/exporter-metrics-otlp-grpc": "^0.57.0",
"@opentelemetry/exporter-metrics-otlp-http": "^0.57.0",
"@opentelemetry/exporter-trace-otlp-http": "^0.57.0",
"@opentelemetry/instrumentation-express": "^0.47.0",
"@opentelemetry/instrumentation-http": "^0.57.0",
"@opentelemetry/resources": "^1.30.0",
"@opentelemetry/sdk-metrics": "^1.30.0",
"@opentelemetry/sdk-node": "^0.57.0",
"@opentelemetry/sdk-trace-node": "^1.30.0",
"@opentelemetry/semantic-conventions": "^1.28.0"

I receive the following error when running the tests using npm run test:

FAIL  tests/controllers/healt.test.ts
 ● Test suite failed to run

  Cannot find module '@opentelemetry/semantic-conventions/incubating' from 'node_modules/@opentelemetry/auto-instrumentations-node/node_modules/@opentelemetry/instrumentation-aws-lambda/build/src/instrumentation.js'

  Require stack:
    node_modules/@opentelemetry/auto-instrumentations-node/node_modules/@opentelemetry/instrumentation-aws-lambda/build/src/instrumentation.js
    node_modules/@opentelemetry/auto-instrumentations-node/node_modules/@opentelemetry/instrumentation-aws-lambda/build/src/index.js
    node_modules/@opentelemetry/auto-instrumentations-node/build/src/utils.js
    node_modules/@opentelemetry/auto-instrumentations-node/build/src/index.js
    src/configuration/opentelemetry.ts
    src/server/index.ts
    tests/controllers/healt.test.ts

I also tried changing the package versions to:

"@opentelemetry/api": "^1.9.0",
"@opentelemetry/auto-instrumentations-node": "^0.56.1",
"@opentelemetry/exporter-metrics-otlp-grpc": "^0.57.2",
"@opentelemetry/exporter-metrics-otlp-http": "^0.57.2",
"@opentelemetry/exporter-trace-otlp-http": "^0.57.2",
"@opentelemetry/instrumentation-aws-lambda": "^0.51.0",
"@opentelemetry/instrumentation-express": "^0.48.0",
"@opentelemetry/instrumentation-grpc": "^0.51.0",
"@opentelemetry/instrumentation-http": "^0.57.2",
"@opentelemetry/resources": "^1.30.1",
"@opentelemetry/sdk-metrics": "^1.30.1",
"@opentelemetry/sdk-node": "^0.57.2",
"@opentelemetry/sdk-trace-node": "^1.30.1",
"@opentelemetry/semantic-conventions": "^1.30.0",

But I received the following error:

FAIL  tests/index.test.ts
 ● Test suite failed to run

  ENOENT: no such file or directory, open 'events'

    at Runtime.readFile (node_modules/jest-runtime/build/index.js:1987:21)
    at Object.<anonymous> (node_modules/google-logging-utils/src/logging-utils.ts:15:1)

This is the component where I implement Opentelemetry:

import opentelemetry from '@opentelemetry/api';
import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-http';
import { AggregationTemporality, PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics';
import { MeterProvider } from '@opentelemetry/sdk-metrics';
import { Resource } from '@opentelemetry/resources';
import { environment } from '../configuration/environment'; // Adjust the path to your config file
import { ATTR_SERVICE_NAME, ATTR_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';
import { BatchSpanProcessor, NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
import fs from 'fs';

// Dynatrace Metadata
let dtmetadata = new Resource({});
for (const name of [
    'dt_metadata_e617c525669e072eebe3d0f08212e8f2.json',
    '/var/lib/dynatrace/enrichment/dt_metadata.json',
    '/var/lib/dynatrace/enrichment/dt_host_metadata.json',
]) {
    try {
        dtmetadata = dtmetadata.merge(
            new Resource(
                JSON.parse(
                    fs
                        .readFileSync(name.startsWith('/var') ? name : fs.readFileSync(name).toString('utf-8').trim())
                        .toString('utf-8'),
                ),
            ),
        );
        break;
    } catch {}
}

const resource = Resource.default()
    .merge(
        new Resource({
            [ATTR_SERVICE_NAME]: 'test-test-test-test',
            [ATTR_SERVICE_VERSION]: '1.0.0',
        }),
    )
    .merge(dtmetadata);

const traceExporter = new OTLPTraceExporter({
    url: environment.OTEL_EXPORTER_OTLP_ENDPOINT_TRACES,
    headers: {
        Authorization: 'Api-Token xxxxxxxxx',
    },
});

const processor = new BatchSpanProcessor(traceExporter);

const provider = new NodeTracerProvider({
    resource: resource,
    spanProcessors: [processor],
});
provider.register();

const metricExporter = new OTLPMetricExporter({
    url: environment.OTEL_EXPORTER_OTLP_METRICS_ENDPOINT,
    headers: {
        Authorization: 'Api-Token xxxxxxxxxxxxx',
    },
    temporalityPreference: AggregationTemporality.DELTA,
});

const metricReader = new PeriodicExportingMetricReader({
    exporter: metricExporter,
    exportIntervalMillis: 60000,
});

const meterProvider = new MeterProvider({
    resource: resource,
    readers: [metricReader],
});

opentelemetry.metrics.setGlobalMeterProvider(meterProvider);
const instrumentations = getNodeAutoInstrumentations();
instrumentations.forEach((instrumentation) => {
    instrumentation.enable();
});

Expected Behavior:

The tests should run successfully.

Question or discussion:

• Has anyone encountered this issue before?
• Is my implementation incorrect?
• Or is this a bug that should be reported?

Thanks in advance!

• This only affects the JavaScript OpenTelemetry library
• This may affect other libraries, but I would like to get opinions here first

[sodabrew]

subscribe. also seeing this in Honeycomb: honeycombio/honeycomb-opentelemetry-web#500

[pichlermarc]

Hi, thanks for reaching out. Your setup seems to be correct.

This was a bug that has since been fixed. It seems that if you're updating to a later version (auto-instrumentations-node: v0.56.1) where we've stopped using this entrypoint (fixed the bug), this is actually resolved (it includes this PR that fixed it: open-telemetry/opentelemetry-js-contrib#2670)

Please note that we're not providing back port fixes to older versions of contrib packages.

Once updated, you seem to be running into an OTel-unreleated error instead.

FAIL  tests/index.test.ts
 ● Test suite failed to run

  ENOENT: no such file or directory, open 'events'

    at Runtime.readFile (node_modules/jest-runtime/build/index.js:1987:21)
    at Object.<anonymous> (node_modules/google-logging-utils/src/logging-utils.ts:15:1)

[pichlermarc]

@sodabrew thanks for reaching out.

The problem with @opentelemetry/web-common should also be fixed in the latest version (unintenionally though, through a refactor #5446). Though I'd say it is up to Honeycomb to update their distro to pull in that change.

[GuidoGagliardini]

Hi, thanks for reaching out. Your setup seems to be correct.

This was a bug that has since been fixed. It seems that if you're updating to a later version (auto-instrumentations-node: v0.56.1) where we've stopped using this entrypoint (fixed the bug), this is actually resolved (it includes this PR that fixed it: open-telemetry/opentelemetry-js-contrib#2670)

Please note that we're not providing back port fixes to older versions of contrib packages.

Once updated, you seem to be running into an OTel-unreleated error instead.

FAIL  tests/index.test.ts
 ● Test suite failed to run

  ENOENT: no such file or directory, open 'events'

    at Runtime.readFile (node_modules/jest-runtime/build/index.js:1987:21)
    at Object.<anonymous> (node_modules/google-logging-utils/src/logging-utils.ts:15:1)

Hello, thank you for your reply and sorry for the late reply.
I have tried upgrading the version to its latest version and I can't fix the node events error when running the tests.

I also tried upgrading the node version to node 18.
But I always get the same error.
`
● Test suite failed to run

ENOENT: no such file or directory, open 'events'

  1 | import opentelemetry from '@opentelemetry/api';
> 2 | import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
    | ^
  3 | import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
  4 | import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-http';
  5 | import { AggregationTemporality, PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics';

  at Runtime.readFile (node_modules/jest-runtime/build/index.js:1987:21)
  at Object.<anonymous> (node_modules/@opentelemetry/instrumentation-grpc/src/serverUtils.ts:23:1)
  at Object.<anonymous> (node_modules/@opentelemetry/instrumentation-grpc/src/instrumentation.ts:66:1)
  at Object.<anonymous> (node_modules/@opentelemetry/instrumentation-grpc/src/index.ts:17:1)
  at Object.<anonymous> (node_modules/@opentelemetry/auto-instrumentations-node/src/utils.ts:34:1)
  at Object.<anonymous> (node_modules/@opentelemetry/auto-instrumentations-node/src/index.ts:17:1)
  at Object.<anonymous> (src/configuration/opentelemetry.ts:2:1)
  at Object.<anonymous> (src/server/index.ts:11:1)
  at Object.<anonymous> (tests/controllers/getValidationSucces.test.ts:3:1)`

any ideas or solutions?
thank you very much

[pichlermarc]

Hmm, are you using an older version of jest by any chance?
I think you may be hitting jestjs/jest#11637

[pichlermarc]

cc @GuidoGagliardini (not sure if you saw my above comment)

[GuidoGagliardini]

cc @GuidoGagliardini (not sure if you saw my above comment)

Hi! sorry for the delay in getting back to you.
We were testing on this problem we are having.
We changed the version of Jest, as you recommended, but the error is still the same.
We should try again uploading the Node and Jest version, we haven't tested that yet.
It will take a while to answer if the latter helps, we have closed this task because of this error for the moment and we have to reopen the task.
thank you very much for the help and predisposition.

[sodabrew]

I filed #5618 and it sure looks similar. I wanted to make sure to post up my set of facts without hijacking this ticket. I'm on Node v20.18 and Jest v26.6

Update: try Jest v29.4 or higher. You might end up in a warm boiling ocean of package updates to get there, but give it a shot, I think we were seeing the same issue play out in different packages doing submodule imports.

[sodabrew]

Try this workaround in jest.config.js

  moduleNameMapper: {
+    '^@opentelemetry/([^/]+)/(.+)$': '<rootDir>/node_modules/@opentelemetry/$1/build/src/index-$2',
  }

[GuidoGagliardini]

Try this workaround in jest.config.js

  moduleNameMapper: {
+    '^@opentelemetry/([^/]+)/(.+)$': '<rootDir>/node_modules/@opentelemetry/$1/build/src/index-$2',
  }

Hello my friend!

Sorry for the delay, I just tried this solution, and the problem is not solved. But, I have different error with your workaround:

`FAIL tests/controllers/getValidationSucces.test.ts
● Test suite failed to run

Configuration: Could not parse user-provided export URL: ''

  39 |     )
  40 |     .merge(dtmetadata);
> 41 | const traceExporter = new OTLPTraceExporter({
     |                       ^
  42 |     url: environment.OTEL_EXPORTER_OTLP_ENDPOINT_TRACES,
  43 |     headers: {
  44 |         Authorization:

  at validateUserProvidedUrl (node_modules/@opentelemetry/otlp-exporter-base/src/configuration/otlp-http-configuration.ts:68:11)
  at mergeOtlpHttpConfigurationWithDefaults (node_modules/@opentelemetry/otlp-exporter-base/src/configuration/otlp-http-configuration.ts:96:7)
  at convertLegacyHttpOptions (node_modules/@opentelemetry/otlp-exporter-base/src/configuration/convert-legacy-node-http-options.ts:68:48)
  at new OTLPTraceExporter (node_modules/@opentelemetry/exporter-trace-otlp-http/src/platform/node/OTLPTraceExporter.ts:39:33)
  at Object.<anonymous> (src/configuration/opentelemetry.ts:41:23)
  at Object.<anonymous> (src/server/index.ts:11:1)

`
I will keep trying solutions and alternatives, and I will leave it here, but the error has not been solved.

Now i'm using Node 20

[pichlermarc]

Hi @GuidoGagliardini - it looks like the reason in in the error message:

Configuration: Could not parse user-provided export URL: ''
Looks like the exporter URL is not set. Likely the value 'environment.OTEL_EXPORTER_OTLP_ENDPOINT_TRACES` that's passed as an URL is incorrect.

[GuidoGagliardini]

Hi @GuidoGagliardini - it looks like the reason in in the error message:

Configuration: Could not parse user-provided export URL: '' Looks like the exporter URL is not set. Likely the value 'environment.OTEL_EXPORTER_OTLP_ENDPOINT_TRACES` that's passed as an URL is incorrect.

I fixed with:
NODE 22

in **jest.config.js** --> 

  moduleNameMapper: {
+    '^@opentelemetry/([^/]+)/(.+)$': '<rootDir>/node_modules/@opentelemetry/$1/build/src/index-$2',
  } 

setupFiles: ['<rootDir>/jest.env.js'],

and add new file jest.env.js -->
add this line:
require('dotenv').config();

this worked for me.
thanks @sodabrew for workaround.