OpenTelemetry Instrumentation Issues

[AbhiPrasad]

This is a tracking list of all problems we've encountered around OpenTelemetry instrumentation

Dependency issues (either OTEL or OTEL instrumentation)

Preview Give feedback

1. Add esm support to @prisma/instrumentation prisma/prisma#23410
   domain/client kind/feature tech/typescript topic: esm topic: tracing +5
2. ESM tests are failing with Node v18.19.0 open-telemetry/opentelemetry-js-contrib#1872
   bug priority:p1 +2
   
3. @@toStringTag property not present on modules passed to hookFn DataDog/import-in-the-middle#57
   +0
4. fastify parent-child relationship of middleware and request handler is wrong open-telemetry/opentelemetry-js-contrib#2092
   bug pkg:instrumentation-fastify priority:p2 +3
   
5. Does not handle CallExpression in ExportDefaultDeclaration node DataDog/import-in-the-middle#77
   +0
6. Optimize OTEL js to be more treeshakable (concern for serverless and for profiling-node bundle)

Instrumentation Gaps compared to Sentry

Preview Give feedback

1. OpenTelemetry Express instrumentation does not match Sentry instrumentation #10168
   Package-Meta: OpenTelemetry Package: node Type: Bug +3
   
2. Problems with Next.js SDK + OTEL #11046
   Package-Meta: OpenTelemetry Package: nextjs +2

Documentation Requirements

Preview Give feedback

1. [v8] Docs Changes #11064
   4 of 22
   Type: Documentation +1

ESM Issues

Preview Give feedback

1. Need to expose easy way to use OTEL ESM loader from @sentry/node and metaframeworks (feat: Add loader file to node-based SDKs to support ESM monkeypatching #11338)
2. Auto-instrumentation does not work for Astro SDK + OTEL because of ESM (cannot provide --experimental-loader when starting Astro server)

Bundling

Preview Give feedback

1. [Node]: Support otel auto instrumentation when code is bundled #10940
   Package-Meta: OpenTelemetry +1
2. fix: Don't use require to load package.json files open-telemetry/opentelemetry-js#4593
   +0

OTEL + Sentry Combined Instrumentation

Preview Give feedback

1. What's the correct way to get a reference to tracer provider - What's the correct way to get a reference to tracer provider? #11235
2. expose way to add sentry to custom propagators

[jnicklas]

I am still getting the issue described in #11216 in the release version of 8.0. Commenting here since that issue is closed and references this one.

TypeError: prismaInstrumentation.PrismaInstrumentation is not a constructor
    at Object.setupOnce (file:///Users/jonas/Projects/capply/node_modules/@sentry/node/esm/index.js:2381:9)
    at setupIntegration (file:///Users/jonas/Projects/capply/node_modules/@sentry/core/esm/integration.js:111:17)
    at file:///Users/jonas/Projects/capply/node_modules/@sentry/core/esm/integration.js:82:7
    at Array.forEach (<anonymous>)
    at setupIntegrations (file:///Users/jonas/Projects/capply/node_modules/@sentry/core/esm/integration.js:79:16)
    at NodeClient._setupIntegrations (file:///Users/jonas/Projects/capply/node_modules/@sentry/core/esm/baseclient.js:375:26)
    at NodeClient.init (file:///Users/jonas/Projects/capply/node_modules/@sentry/core/esm/baseclient.js:251:12)
    at init (file:///Users/jonas/Projects/capply/node_modules/@sentry/node/esm/index.js:3516:12)
    at file:///Users/jonas/Projects/capply/build/consumer.mjs:4564:3
    at ModuleJob.run (node:internal/modules/esm/module_job:218:25)

[lforst]

@jnicklas responded over at #11216. Let's keep the discussion there since this is just a tracking issue for ourselves to coordinate.

[AbhiPrasad]

This is a bit hard to track now, I'm going to close this and re-open a new issue that summarizes this a bit better.