Remove auto-otel init and fix unit tests

Author: andreiborza

packages/node-core/src/index.ts

@@ -19,7 +19,6 @@ export { SentryContextManager } from './otel/contextManager';
 export { generateInstrumentOnce } from './otel/instrument';
 
 export { init, getDefaultIntegrations, initWithoutDefaultIntegrations, validateOpenTelemetrySetup } from './sdk';
-export { initOpenTelemetry } from './sdk/initOtel';
 export { getSentryRelease, defaultStackParser } from './sdk/api';
 export { createGetModuleFromFilename } from './utils/module';
 export { makeNodeTransport } from './transports';

packages/node-core/src/otel/resources.ts

@@ -0,0 +1,31 @@
+import { consoleSandbox, GLOBAL_OBJ, logger } from '@sentry/core';
+import { createAddHookMessageChannel } from 'import-in-the-middle';
+import moduleModule from 'module';
+
+/** Initialize the ESM loader. */
+export function maybeInitializeEsmLoader(): void {
+  const [nodeMajor = 0, nodeMinor = 0] = process.versions.node.split('.').map(Number);
+
+  // Register hook was added in v20.6.0 and v18.19.0
+  if (nodeMajor >= 21 || (nodeMajor === 20 && nodeMinor >= 6) || (nodeMajor === 18 && nodeMinor >= 19)) {
+    if (!GLOBAL_OBJ._sentryEsmLoaderHookRegistered) {
+      try {
+        const { addHookMessagePort } = createAddHookMessageChannel();
+        // @ts-expect-error register is available in these versions
+        moduleModule.register('import-in-the-middle/hook.mjs', import.meta.url, {
+          data: { addHookMessagePort, include: [] },
+          transferList: [addHookMessagePort],
+        });
+      } catch (error) {
+        logger.warn('Failed to register ESM hook', error);
+      }
+    }
+  } else {
+    consoleSandbox(() => {
+      // eslint-disable-next-line no-console
+      console.warn(
+        `[Sentry] You are using Node.js v${process.versions.node} in ESM mode ("import syntax"). The Sentry Node.js SDK is not compatible with ESM in Node.js versions before 18.19.0 or before 20.6.0. Please either build your application with CommonJS ("require() syntax"), or upgrade your Node.js version.`,
+      );
+    });
+  }
+}

packages/node-core/src/sdk/esmLoader.ts

@@ -1,3 +1,4 @@
+import { diag, DiagLogLevel } from '@opentelemetry/api';
 import type { Integration, Options } from '@sentry/core';
 import {
   consoleIntegration,
@@ -37,7 +38,7 @@ import { isCjs } from '../utils/commonjs';
 import { envToBool } from '../utils/envToBool';
 import { defaultStackParser, getSentryRelease } from './api';
 import { NodeClient } from './client';
-import { initOpenTelemetry, maybeInitializeEsmLoader } from './initOtel';
+import { maybeInitializeEsmLoader } from './esmLoader';
 
 function getCjsOnlyIntegrations(): Integration[] {
   return isCjs() ? [modulesIntegration()] : [];
@@ -136,14 +137,7 @@ function _init(
 
   updateScopeFromEnvVariables();
 
-  // If users opt-out of this, they _have_ to set up OpenTelemetry themselves
-  // There is no way to use this SDK without OpenTelemetry!
-  if (!options.skipOpenTelemetrySetup) {
-    initOpenTelemetry(client, {
-      spanProcessors: options.openTelemetrySpanProcessors,
-    });
-    validateOpenTelemetrySetup();
-  }
+  setupOpenTelemetryLogger();
 
   enhanceDscWithOpenTelemetryRootSpanName(client);
   setupEventContextTrace(client);
@@ -257,3 +251,19 @@ function updateScopeFromEnvVariables(): void {
     getCurrentScope().setPropagationContext(propagationContext);
   }
 }
+
+/**
+ * Setup the OTEL logger to use our own logger.
+ */
+function setupOpenTelemetryLogger(): void {
+  const otelLogger = new Proxy(logger as typeof logger & { verbose: (typeof logger)['debug'] }, {
+    get(target, prop, receiver) {
+      const actualProp = prop === 'verbose' ? 'debug' : prop;
+      return Reflect.get(target, actualProp, receiver);
+    },
+  });
+
+  // Disable diag, to ensure this works even if called multiple times
+  diag.disable();
+  diag.setLogger(otelLogger, DiagLogLevel.DEBUG);
+}

packages/node-core/src/sdk/index.ts

@@ -83,18 +83,6 @@ export interface BaseNodeOptions {
    */
   spotlight?: boolean | string;
 
-  /**
-   * If this is set to true, the SDK will not set up OpenTelemetry automatically.
-   * In this case, you _have_ to ensure to set it up correctly yourself, including:
-   * * The `SentrySpanProcessor`
-   * * The `SentryPropagator`
-   * * The `SentryContextManager`
-   * * The `SentrySampler`
-   *
-   * If you are registering your own OpenTelemetry Loader Hooks (or `import-in-the-middle` hooks), it is also recommended to set the `registerEsmLoaderHooks` option to false.
-   */
-  skipOpenTelemetrySetup?: boolean;
-
   /**
    * Provide an array of OpenTelemetry Instrumentations that should be registered.
    *

packages/node-core/src/sdk/initOtel.ts

@@ -1,8 +1,10 @@
 import { context, propagation, ProxyTracerProvider, trace } from '@opentelemetry/api';
 import { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
 import { getClient, getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
+import { SentryPropagator, SentrySampler, SentrySpanProcessor } from '@sentry/opentelemetry';
 import type { NodeClient } from '../../src';
-import { init } from '../../src/sdk';
+import { SentryContextManager } from '../../src/otel/contextManager';
+import { init, validateOpenTelemetrySetup } from '../../src/sdk';
 import type { NodeClientOptions } from '../../src/types';
 
 const PUBLIC_DSN = 'https://username@domain/123';
@@ -16,14 +18,28 @@ export function resetGlobals(): void {
 
 export function mockSdkInit(options?: Partial<NodeClientOptions>) {
   resetGlobals();
-  init({
+  const client = init({
     dsn: PUBLIC_DSN,
     defaultIntegrations: false,
     // We are disabling client reports because we would be acquiring resources with every init call and that would leak
     // memory every time we call init in the tests
     sendClientReports: false,
     ...options,
   });
+
+  const provider = new BasicTracerProvider({
+    sampler: client ? new SentrySampler(client) : undefined,
+    spanProcessors: [new SentrySpanProcessor()],
+  });
+
+  provider.register({
+    propagator: new SentryPropagator(),
+    contextManager: new SentryContextManager(),
+  });
+
+  validateOpenTelemetrySetup();
+
+  return provider;
 }
 
 export function cleanupOtel(_provider?: BasicTracerProvider): void {

packages/node-core/src/types.ts

@@ -1,3 +1,4 @@
+import type { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
 import { addBreadcrumb, captureException, withIsolationScope, withScope } from '@sentry/core';
 import { startSpan } from '@sentry/opentelemetry';
 import { afterEach, describe, expect, it, vi } from 'vitest';
@@ -8,16 +9,18 @@ import { cleanupOtel, mockSdkInit } from '../helpers/mockSdkInit';
 describe('Integration | breadcrumbs', () => {
   const beforeSendTransaction = vi.fn(() => null);
 
+  let provider: BasicTracerProvider | undefined;
+
   afterEach(() => {
-    cleanupOtel();
+    cleanupOtel(provider);
   });
 
   describe('without tracing', () => {
     it('correctly adds & retrieves breadcrumbs', async () => {
       const beforeSend = vi.fn(() => null);
       const beforeBreadcrumb = vi.fn(breadcrumb => breadcrumb);
 
-      mockSdkInit({ beforeSend, beforeBreadcrumb });
+      provider = mockSdkInit({ beforeSend, beforeBreadcrumb });
 
       const client = getClient() as NodeClient;
 
@@ -53,7 +56,7 @@ describe('Integration | breadcrumbs', () => {
       const beforeSend = vi.fn(() => null);
       const beforeBreadcrumb = vi.fn(breadcrumb => breadcrumb);
 
-      mockSdkInit({ beforeSend, beforeBreadcrumb });
+      provider = mockSdkInit({ beforeSend, beforeBreadcrumb });
 
       const client = getClient();
 
@@ -99,7 +102,7 @@ describe('Integration | breadcrumbs', () => {
     const beforeSend = vi.fn(() => null);
     const beforeBreadcrumb = vi.fn(breadcrumb => breadcrumb);
 
-    mockSdkInit({ beforeSend, beforeBreadcrumb, beforeSendTransaction, tracesSampleRate: 1 });
+    provider = mockSdkInit({ beforeSend, beforeBreadcrumb, beforeSendTransaction, tracesSampleRate: 1 });
 
     const client = getClient() as NodeClient;
 
@@ -144,7 +147,7 @@ describe('Integration | breadcrumbs', () => {
     const beforeSend = vi.fn(() => null);
     const beforeBreadcrumb = vi.fn(breadcrumb => breadcrumb);
 
-    mockSdkInit({ beforeSend, beforeBreadcrumb, beforeSendTransaction, tracesSampleRate: 1 });
+    provider = mockSdkInit({ beforeSend, beforeBreadcrumb, beforeSendTransaction, tracesSampleRate: 1 });
 
     const client = getClient() as NodeClient;
 
@@ -196,7 +199,7 @@ describe('Integration | breadcrumbs', () => {
     const beforeSend = vi.fn(() => null);
     const beforeBreadcrumb = vi.fn(breadcrumb => breadcrumb);
 
-    mockSdkInit({ beforeSend, beforeBreadcrumb, beforeSendTransaction, tracesSampleRate: 1 });
+    provider = mockSdkInit({ beforeSend, beforeBreadcrumb, beforeSendTransaction, tracesSampleRate: 1 });
 
     const client = getClient() as NodeClient;
 
@@ -237,7 +240,7 @@ describe('Integration | breadcrumbs', () => {
     const beforeSend = vi.fn(() => null);
     const beforeBreadcrumb = vi.fn(breadcrumb => breadcrumb);
 
-    mockSdkInit({ beforeSend, beforeBreadcrumb, beforeSendTransaction, tracesSampleRate: 1 });
+    provider = mockSdkInit({ beforeSend, beforeBreadcrumb, beforeSendTransaction, tracesSampleRate: 1 });
 
     const client = getClient() as NodeClient;