feat: Deprecate addOpenTelemetryInstrumentation (#14485)

Author: Luca Forstner

docs/migration/draft-v9-migration-guide.md

@@ -106,5 +106,6 @@
 - Deprecated `processThreadBreadcrumbIntegration` in favor of `childProcessIntegration`. Functionally they are the same.
 - Deprecated `nestIntegration`. Use the NestJS SDK (`@sentry/nestjs`) instead.
 - Deprecated `setupNestErrorHandler`. Use the NestJS SDK (`@sentry/nestjs`) instead.
+- Deprecated `addOpenTelemetryInstrumentation`. Use the `openTelemetryInstrumentations` option in `Sentry.init()` or your custom Sentry Client instead.
 - Deprecated `registerEsmLoaderHooks.include` and `registerEsmLoaderHooks.exclude`. Set `onlyIncludeInstrumentedModules: true` instead.
 - `registerEsmLoaderHooks` will only accept `true | false | undefined` in the future. The SDK will default to wrapping modules that are used as part of OpenTelemetry Instrumentation.

packages/astro/src/index.server.ts

@@ -11,6 +11,7 @@ export {
   addBreadcrumb,
   addEventProcessor,
   addIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   addOpenTelemetryInstrumentation,
   // eslint-disable-next-line deprecation/deprecation
   addRequestDataToEvent,

packages/aws-serverless/package.json

@@ -64,6 +64,7 @@
     "access": "public"
   },
   "dependencies": {
+    "@opentelemetry/instrumentation": "^0.54.0",
     "@opentelemetry/instrumentation-aws-lambda": "0.44.0",
     "@opentelemetry/instrumentation-aws-sdk": "0.45.0",
     "@sentry/core": "8.41.0",

packages/aws-serverless/src/index.ts

@@ -120,6 +120,7 @@ export {
   spanToTraceHeader,
   spanToBaggageHeader,
   trpcMiddleware,
+  // eslint-disable-next-line deprecation/deprecation
   addOpenTelemetryInstrumentation,
   zodErrorsIntegration,
   profiler,

packages/aws-serverless/src/integration/aws.ts

@@ -1,24 +1,23 @@
+import { registerInstrumentations } from '@opentelemetry/instrumentation';
 import { AwsInstrumentation } from '@opentelemetry/instrumentation-aws-sdk';
 import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration } from '@sentry/core';
-import { addOpenTelemetryInstrumentation } from '@sentry/node';
-import type { IntegrationFn } from '@sentry/types';
 
-const _awsIntegration = (() => {
+/**
+ * Instrumentation for aws-sdk package
+ */
+export const awsIntegration = defineIntegration(() => {
   return {
     name: 'Aws',
     setupOnce() {
-      addOpenTelemetryInstrumentation(
-        new AwsInstrumentation({
-          preRequestHook(span) {
-            span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.otel.aws');
-          },
-        }),
-      );
+      registerInstrumentations({
+        instrumentations: [
+          new AwsInstrumentation({
+            preRequestHook(span) {
+              span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.otel.aws');
+            },
+          }),
+        ],
+      });
     },
   };
-}) satisfies IntegrationFn;
-
-/**
- * Instrumentation for aws-sdk package
- */
-export const awsIntegration = defineIntegration(_awsIntegration);
+});

packages/bun/src/index.ts

@@ -140,6 +140,7 @@ export {
   spanToTraceHeader,
   spanToBaggageHeader,
   trpcMiddleware,
+  // eslint-disable-next-line deprecation/deprecation
   addOpenTelemetryInstrumentation,
   zodErrorsIntegration,
   profiler,

packages/google-cloud-serverless/src/index.ts

@@ -117,6 +117,7 @@ export {
   spanToTraceHeader,
   spanToBaggageHeader,
   trpcMiddleware,
+  // eslint-disable-next-line deprecation/deprecation
   addOpenTelemetryInstrumentation,
   zodErrorsIntegration,
   profiler,

packages/node/src/index.ts

@@ -61,6 +61,7 @@ export type { NodeOptions } from './types';
 export { addRequestDataToEvent, DEFAULT_USER_INCLUDES, extractRequestData } from '@sentry/core';
 
 export {
+  // eslint-disable-next-line deprecation/deprecation
   addOpenTelemetryInstrumentation,
   // These are custom variants that need to be used instead of the core one
   // As they have slightly different implementations

packages/node/src/integrations/node-fetch.ts

@@ -1,9 +1,10 @@
+import { registerInstrumentations } from '@opentelemetry/instrumentation';
 import type { UndiciRequest, UndiciResponse } from '@opentelemetry/instrumentation-undici';
 import { UndiciInstrumentation } from '@opentelemetry/instrumentation-undici';
 import { LRUMap, getClient, getTraceData } from '@sentry/core';
 import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, addBreadcrumb, defineIntegration, hasTracingEnabled } from '@sentry/core';
 import { getBreadcrumbLogLevelFromHttpStatusCode, getSanitizedUrlString, parseUrl } from '@sentry/core';
-import { addOpenTelemetryInstrumentation, shouldPropagateTraceForUrl } from '@sentry/opentelemetry';
+import { shouldPropagateTraceForUrl } from '@sentry/opentelemetry';
 import type { IntegrationFn, SanitizedRequestData } from '@sentry/types';
 
 interface NodeFetchOptions {
@@ -74,7 +75,7 @@ const _nativeNodeFetchIntegration = ((options: NodeFetchOptions = {}) => {
         },
       });
 
-      addOpenTelemetryInstrumentation(instrumentation);
+      registerInstrumentations({ instrumentations: [instrumentation] });
     },
   };
 }) satisfies IntegrationFn;

packages/node/src/otel/instrument.ts

@@ -1,5 +1,4 @@
-import type { Instrumentation } from '@opentelemetry/instrumentation';
-import { addOpenTelemetryInstrumentation } from '@sentry/opentelemetry';
+import { type Instrumentation, registerInstrumentations } from '@opentelemetry/instrumentation';
 
 /** Exported only for tests. */
 export const INSTRUMENTED: Record<string, Instrumentation> = {};
@@ -26,7 +25,9 @@ export function generateInstrumentOnce<Options = unknown>(
       const instrumentation = creator(options);
       INSTRUMENTED[name] = instrumentation;
 
-      addOpenTelemetryInstrumentation(instrumentation);
+      registerInstrumentations({
+        instrumentations: [instrumentation],
+      });
     },
     { id: name },
   );