PR feedback: Expose proper setupGlobalHub method

Author: mydea

packages/node-experimental/README.md

@@ -82,7 +82,7 @@ const span = Sentry.startSpan({ description: 'non-active span' });
 
 doSomethingSlow();
 
-span?.finish();
+span.finish();
 ```
 
 Finally you can also get the currently active span, if you need to do more with it:

packages/node-experimental/src/sdk/init.ts

@@ -1,7 +1,7 @@
 import { hasTracingEnabled } from '@sentry/core';
 import type { NodeClient } from '@sentry/node';
 import { defaultIntegrations as defaultNodeIntegrations, init as initNode } from '@sentry/node';
-import { getCurrentHub, setOpenTelemetryContextAsyncContextStrategy } from '@sentry/opentelemetry';
+import { setOpenTelemetryContextAsyncContextStrategy, setupGlobalHub } from '@sentry/opentelemetry';
 import type { Integration } from '@sentry/types';
 import { parseSemver } from '@sentry/utils';
 
@@ -29,9 +29,7 @@ if (NODE_VERSION.major && NODE_VERSION.major >= 16) {
  * Initialize Sentry for Node.
  */
 export function init(options: NodeExperimentalOptions | undefined = {}): void {
-  // Ensure we register our own global hub before something else does
-  // This will register the OpenTelemetryHub as the global hub
-  getCurrentHub();
+  setupGlobalHub();
 
   const isTracingEnabled = hasTracingEnabled(options);
 

packages/node-experimental/test/integration/scope.test.ts

@@ -1,4 +1,4 @@
-import { getCurrentHub } from '@sentry/opentelemetry';
+import { getCurrentHub, getSpanScope } from '@sentry/opentelemetry';
 
 import * as Sentry from '../../src/';
 import type { NodeExperimentalClient } from '../../src/types';
@@ -13,7 +13,7 @@ describe('Integration | Scope', () => {
     ['with tracing', true],
     ['without tracing', false],
   ])('%s', (_name, enableTracing) => {
-    it('correctly syncs OTEL context & Sentry hub/scope ', async () => {
+    it('correctly syncs OTEL context & Sentry hub/scope', async () => {
       const beforeSend = jest.fn(() => null);
       const beforeSendTransaction = jest.fn(() => null);
 
@@ -41,8 +41,10 @@ describe('Integration | Scope', () => {
           scope2.setTag('tag3', 'val3');
 
           Sentry.startSpan({ name: 'outer' }, span => {
-            spanId = span?.spanContext().spanId;
-            traceId = span?.spanContext().traceId;
+            expect(getSpanScope(span)).toBe(enableTracing ? scope2 : undefined);
+
+            spanId = span.spanContext().spanId;
+            traceId = span.spanContext().traceId;
 
             Sentry.setTag('tag4', 'val4');
 
@@ -138,8 +140,8 @@ describe('Integration | Scope', () => {
           scope2.setTag('tag3', 'val3a');
 
           Sentry.startSpan({ name: 'outer' }, span => {
-            spanId1 = span?.spanContext().spanId;
-            traceId1 = span?.spanContext().traceId;
+            spanId1 = span.spanContext().spanId;
+            traceId1 = span.spanContext().traceId;
 
             Sentry.setTag('tag4', 'val4a');
 
@@ -155,8 +157,8 @@ describe('Integration | Scope', () => {
           scope2.setTag('tag3', 'val3b');
 
           Sentry.startSpan({ name: 'outer' }, span => {
-            spanId2 = span?.spanContext().spanId;
-            traceId2 = span?.spanContext().traceId;
+            spanId2 = span.spanContext().spanId;
+            traceId2 = span.spanContext().traceId;
 
             Sentry.setTag('tag4', 'val4b');
 

packages/opentelemetry/README.md

@@ -38,7 +38,7 @@ This package exposes a few building blocks you can add to your OpenTelemetry set
 
 This is how you can use this in your app:
 
-1. Call custom `getCurrentHub()` before anything else, to ensure we have the correct global hub registered
+1. Setup the global hub for OpenTelemetry compatibility - ensure `setupGlobalHub()` is called before anything else!
 1. Initialize Sentry, e.g. `@sentry/node` - make sure to set `instrumenter: 'otel'` in the SDK `init({})`!
 1. Call `setupEventContextTrace(client)`
 1. Add `SentrySampler` as sampler
@@ -53,6 +53,7 @@ For example, you could set this up as follows:
 import * as Sentry from '@sentry/node';
 import {
   getCurrentHub,
+  setupGlobalHub,
   SentryPropagator,
   SentrySampler,
   SentrySpanProcessor,
@@ -63,7 +64,7 @@ import {
 import { AsyncLocalStorageContextManager } from '@opentelemetry/context-async-hooks';
 
 function setupSentry() {
-  getCurrentHub();
+  setupGlobalHub();
 
   Sentry.init({
     dsn: 'xxx',

packages/opentelemetry/src/custom/hub.ts

@@ -72,6 +72,20 @@ export function getCurrentHub(): Hub {
   return getGlobalHub(registry);
 }
 
+/**
+ * Ensure the global hub is an OpenTelemetryHub.
+ */
+export function setupGlobalHub(): void {
+  const globalRegistry = getMainCarrier();
+
+  if (getGlobalHub(globalRegistry) instanceof OpenTelemetryHub) {
+    return;
+  }
+
+  // If the current global hub is not correct, ensure we overwrite it
+  setHubOnCarrier(globalRegistry, new OpenTelemetryHub());
+}
+
 /**
  * This will create a new {@link Hub} and add to the passed object on
  * __SENTRY__.hub.

packages/opentelemetry/src/index.ts

@@ -24,7 +24,7 @@ export { isSentryRequestSpan } from './utils/isSentryRequest';
 export { getActiveSpan, getRootSpan } from './utils/getActiveSpan';
 export { startSpan, startInactiveSpan } from './trace';
 
-export { getCurrentHub } from './custom/hub';
+export { getCurrentHub, setupGlobalHub } from './custom/hub';
 export { addTracingExtensions } from './custom/hubextensions';
 export { setupEventContextTrace } from './setupEventContextTrace';
 

packages/opentelemetry/test/helpers/mockSdkInit.ts

@@ -4,7 +4,7 @@ import type { ClientOptions, Options } from '@sentry/types';
 import { GLOBAL_OBJ } from '@sentry/utils';
 
 import { setOpenTelemetryContextAsyncContextStrategy } from '../../src/asyncContextStrategy';
-import { getCurrentHub } from '../../src/custom/hub';
+import { setupGlobalHub } from '../../src/custom/hub';
 import { initOtel } from './initOtel';
 import { init as initTestClient } from './TestClient';
 
@@ -14,9 +14,7 @@ const PUBLIC_DSN = 'https://username@domain/123';
  * Initialize Sentry for Node.
  */
 function init(options: Partial<Options> | undefined = {}): void {
-  // Ensure we register our own global hub before something else does
-  // This will register the NodeExperimentalHub as the global hub
-  getCurrentHub();
+  setupGlobalHub();
 
   const fullOptions: Partial<Options> = {
     instrumenter: 'otel',

packages/opentelemetry/test/integration/otelTimedEvents.test.ts

@@ -20,12 +20,12 @@ describe('Integration | OTEL TimedEvents', () => {
     const client = hub.getClient() as TestClientInterface;
 
     startSpan({ name: 'test' }, span => {
-      span?.addEvent('exception', {
+      span.addEvent('exception', {
         [SemanticAttributes.EXCEPTION_MESSAGE]: 'test-message',
         'test-span-event-attr': 'test-span-event-attr-value',
       });
 
-      span?.addEvent('other', {
+      span.addEvent('other', {
         [SemanticAttributes.EXCEPTION_MESSAGE]: 'test-message-2',
         'test-span-event-attr': 'test-span-event-attr-value',
       });

packages/opentelemetry/test/integration/scope.test.ts

@@ -3,6 +3,7 @@ import { captureException, setTag, withScope } from '@sentry/core';
 import { getCurrentHub, OpenTelemetryHub } from '../../src/custom/hub';
 import { OpenTelemetryScope } from '../../src/custom/scope';
 import { startSpan } from '../../src/trace';
+import { getSpanScope } from '../../src/utils/spanData';
 import { cleanupOtel, mockSdkInit } from '../helpers/mockSdkInit';
 import type { TestClientInterface } from '../helpers/TestClient';
 
@@ -46,8 +47,10 @@ describe('Integration | Scope', () => {
           scope2.setTag('tag3', 'val3');
 
           startSpan({ name: 'outer' }, span => {
-            spanId = span?.spanContext().spanId;
-            traceId = span?.spanContext().traceId;
+            expect(getSpanScope(span)).toBe(enableTracing ? scope2 : undefined);
+
+            spanId = span.spanContext().spanId;
+            traceId = span.spanContext().traceId;
 
             setTag('tag4', 'val4');
 
@@ -147,8 +150,8 @@ describe('Integration | Scope', () => {
           scope2.setTag('tag3', 'val3a');
 
           startSpan({ name: 'outer' }, span => {
-            spanId1 = span?.spanContext().spanId;
-            traceId1 = span?.spanContext().traceId;
+            spanId1 = span.spanContext().spanId;
+            traceId1 = span.spanContext().traceId;
 
             setTag('tag4', 'val4a');
 
@@ -164,8 +167,8 @@ describe('Integration | Scope', () => {
           scope2.setTag('tag3', 'val3b');
 
           startSpan({ name: 'outer' }, span => {
-            spanId2 = span?.spanContext().spanId;
-            traceId2 = span?.spanContext().traceId;
+            spanId2 = span.spanContext().spanId;
+            traceId2 = span.spanContext().traceId;
 
             setTag('tag4', 'val4b');