Export setupOpenTelemetryLoggerfrom node-core and use in node

Author: andreiborza

packages/node-core/README.md

@@ -36,7 +36,9 @@ yarn add @sentry/node-core @sentry/opentelemetry @opentelemetry/api @opentelemet
 
 Sentry should be initialized as early in your app as possible. It is essential that you call `Sentry.init` before you
 require any other modules in your application, otherwise any auto-instrumentation will **not** work.
-You also need to set up OpenTelemetry, if you prefer not to, consider using the `@sentry/node` SDK instead.
+
+You also **have to** set up OpenTelemetry, if you prefer not to, consider using the `@sentry/node` SDK instead.
+Without setting up OpenTelemetry, you only get basic error tracking out of the box without proper scope isolation.
 
 You need to create a file named `instrument.js` that imports and initializes Sentry:
 
@@ -57,23 +59,29 @@ const sentryClient = Sentry.init({
   // ...
 });
 
-// Note: This could be BasicTracerProvider or any other provider depending on how you want to use the
-// OpenTelemetry SDK
-const provider = new NodeTracerProvider({
-  // Ensure the correct subset of traces is sent to Sentry
-  // This also ensures trace propagation works as expected
-  sampler: sentryClient ? new SentrySampler(sentryClient) : undefined,
-  spanProcessors: [
-    // Ensure spans are correctly linked & sent to Sentry
-    new SentrySpanProcessor(),
-    // Add additional processors here
-  ],
-});
-
-trace.setGlobalTracerProvider(provider);
-propagation.setGlobalPropagator(new SentryPropagator());
-context.setGlobalContextManager(new Sentry.SentryContextManager());
-
+if (sentryClient) {
+  // Note: This could be BasicTracerProvider or any other provider depending on how you want to use the
+  // OpenTelemetry SDK
+  const provider = new NodeTracerProvider({
+    // Ensure the correct subset of traces is sent to Sentry
+    // This also ensures trace propagation works as expected
+    sampler: new SentrySampler(sentryClient),
+    spanProcessors: [
+      // Ensure spans are correctly linked & sent to Sentry
+      new SentrySpanProcessor(),
+      // Add additional processors here
+    ],
+  });
+
+  trace.setGlobalTracerProvider(provider);
+  propagation.setGlobalPropagator(new SentryPropagator());
+  context.setGlobalContextManager(new Sentry.SentryContextManager());
+}
+
+// Set up the OpenTelemetry logger to use Sentry's logger
+Sentry.setupOpenTelemetryLogger();
+
+// validate your setup
 Sentry.validateOpenTelemetrySetup();
 ```
 

packages/node-core/src/index.ts

@@ -24,6 +24,7 @@ export { childProcessIntegration } from './integrations/childProcess';
 export { createSentryWinstonTransport } from './integrations/winston';
 
 export { SentryContextManager } from './otel/contextManager';
+export { setupOpenTelemetryLogger } from './otel/logger';
 export { generateInstrumentOnce, instrumentWhenWrapped, INSTRUMENTED } from './otel/instrument';
 
 export { init, getDefaultIntegrations, initWithoutDefaultIntegrations, validateOpenTelemetrySetup } from './sdk';

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

@@ -0,0 +1,18 @@
+import { diag, DiagLogLevel } from '@opentelemetry/api';
+import { logger } from '@sentry/core';
+
+/**
+ * Setup the OTEL logger to use our own logger.
+ */
+export 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

@@ -1,4 +1,3 @@
-import { diag, DiagLogLevel } from '@opentelemetry/api';
 import type { Integration, Options } from '@sentry/core';
 import {
   consoleIntegration,
@@ -133,10 +132,6 @@ function _init(
 
   updateScopeFromEnvVariables();
 
-  if (options.debug) {
-    setupOpenTelemetryLogger();
-  }
-
   enhanceDscWithOpenTelemetryRootSpanName(client);
   setupEventContextTrace(client);
 
@@ -249,19 +244,3 @@ 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/src/sdk/initOtel.ts

@@ -8,8 +8,7 @@ import {
   SEMRESATTRS_SERVICE_NAMESPACE,
 } from '@opentelemetry/semantic-conventions';
 import { consoleSandbox, GLOBAL_OBJ, logger, SDK_VERSION } from '@sentry/core';
-import type { NodeClient } from '@sentry/node-core';
-import { isCjs, SentryContextManager } from '@sentry/node-core';
+import { type NodeClient, isCjs, SentryContextManager, setupOpenTelemetryLogger } from '@sentry/node-core';
 import { SentryPropagator, SentrySampler, SentrySpanProcessor } from '@sentry/opentelemetry';
 import { createAddHookMessageChannel } from 'import-in-the-middle';
 import moduleModule from 'module';
@@ -28,6 +27,10 @@ interface AdditionalOpenTelemetryOptions {
  * Initialize OpenTelemetry for Node.
  */
 export function initOpenTelemetry(client: NodeClient, options: AdditionalOpenTelemetryOptions = {}): void {
+  if (client.getOptions().debug) {
+    setupOpenTelemetryLogger();
+  }
+
   const provider = setupOtel(client, options);
   client.traceProvider = provider;
 }