feat(opentelemetry): Add new @sentry/opentelemetry package

Author: mydea

.craft.yml

@@ -24,6 +24,10 @@ targets:
   - name: npm
     id: '@sentry/replay'
     includeNames: /^sentry-replay-\d.*\.tgz$/
+  ## 1.6. OpenTelemetry package
+  - name: npm
+    id: '@sentry/opentelemetry'
+    includeNames: /^sentry-opentelemetry-\d.*\.tgz$/
 
   ## 2. Browser & Node SDKs
   - name: npm

package.json

@@ -60,6 +60,7 @@
     "packages/node-integration-tests",
     "packages/node-experimental",
     "packages/opentelemetry-node",
+    "packages/opentelemetry",
     "packages/react",
     "packages/remix",
     "packages/replay",

packages/node-experimental/package.json

@@ -24,26 +24,26 @@
   },
   "dependencies": {
     "@opentelemetry/api": "~1.6.0",
-    "@opentelemetry/context-async-hooks": "~1.17.0",
-    "@opentelemetry/core": "~1.17.0",
-    "@opentelemetry/instrumentation": "~0.43.0",
-    "@opentelemetry/instrumentation-express": "~0.33.1",
-    "@opentelemetry/instrumentation-fastify": "~0.32.3",
-    "@opentelemetry/instrumentation-graphql": "~0.35.1",
-    "@opentelemetry/instrumentation-http": "~0.43.0",
-    "@opentelemetry/instrumentation-mongodb": "~0.37.0",
-    "@opentelemetry/instrumentation-mongoose": "~0.33.1",
-    "@opentelemetry/instrumentation-mysql": "~0.34.1",
-    "@opentelemetry/instrumentation-mysql2": "~0.34.1",
-    "@opentelemetry/instrumentation-nestjs-core": "~0.33.1",
-    "@opentelemetry/instrumentation-pg": "~0.36.1",
-    "@opentelemetry/resources": "~1.17.0",
-    "@opentelemetry/sdk-trace-base": "~1.17.0",
-    "@opentelemetry/semantic-conventions": "~1.17.0",
-    "@prisma/instrumentation": "~5.3.1",
+    "@opentelemetry/core": "~1.17.1",
+    "@opentelemetry/context-async-hooks": "~1.17.1",
+    "@opentelemetry/instrumentation": "0.44.0",
+    "@opentelemetry/instrumentation-express": "0.33.2",
+    "@opentelemetry/instrumentation-fastify": "0.32.3",
+    "@opentelemetry/instrumentation-graphql": "0.35.2",
+    "@opentelemetry/instrumentation-http": "0.44.0",
+    "@opentelemetry/instrumentation-mongodb": "0.37.1",
+    "@opentelemetry/instrumentation-mongoose": "0.33.2",
+    "@opentelemetry/instrumentation-mysql": "0.34.2",
+    "@opentelemetry/instrumentation-mysql2": "0.34.2",
+    "@opentelemetry/instrumentation-nestjs-core": "0.33.2",
+    "@opentelemetry/instrumentation-pg": "0.36.2",
+    "@opentelemetry/resources": "~1.17.1",
+    "@opentelemetry/sdk-trace-base": "~1.17.1",
+    "@opentelemetry/semantic-conventions": "~1.17.1",
+    "@prisma/instrumentation": "5.4.2",
     "@sentry/core": "7.74.0",
     "@sentry/node": "7.74.0",
-    "@sentry/opentelemetry-node": "7.74.0",
+    "@sentry/opentelemetry": "7.74.0",
     "@sentry/types": "7.74.0",
     "@sentry/utils": "7.74.0",
     "opentelemetry-instrumentation-fetch-node": "1.1.0"

packages/node-experimental/src/constants.ts

@@ -11,11 +11,10 @@ export { init } from './sdk/init';
 export { INTEGRATIONS as Integrations };
 export { getAutoPerformanceIntegrations } from './integrations/getAutoPerformanceIntegrations';
 export * as Handlers from './sdk/handlers';
-export * from './sdk/trace';
-export { getActiveSpan } from './utils/getActiveSpan';
-export { getCurrentHub, getHubFromCarrier } from './sdk/hub';
 export type { Span } from './types';
 
+export { startSpan, startInactiveSpan, getCurrentHub, getActiveSpan } from '@sentry/opentelemetry';
+
 export {
   makeNodeTransport,
   defaultStackParser,

packages/node-experimental/src/index.ts

@@ -3,17 +3,14 @@ import { SpanKind } from '@opentelemetry/api';
 import { registerInstrumentations } from '@opentelemetry/instrumentation';
 import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
 import { hasTracingEnabled, isSentryRequestUrl } from '@sentry/core';
+import { _INTERNAL, getCurrentHub, getSpanKind, setSpanMetadata } from '@sentry/opentelemetry';
 import type { EventProcessor, Hub, Integration } from '@sentry/types';
 import { stringMatchesSomePattern } from '@sentry/utils';
 import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';
 
-import { OTEL_ATTR_ORIGIN } from '../constants';
-import { setSpanMetadata } from '../opentelemetry/spanData';
-import type { NodeExperimentalClient } from '../sdk/client';
-import { getCurrentHub } from '../sdk/hub';
-import { getRequestSpanData } from '../utils/getRequestSpanData';
+import type { NodeExperimentalClient } from '../types';
+import { addOriginToSpan } from '../utils/addOriginToSpan';
 import { getRequestUrl } from '../utils/getRequestUrl';
-import { getSpanKind } from '../utils/getSpanKind';
 
 interface HttpOptions {
   /**
@@ -148,7 +145,7 @@ export class Http implements Integration {
 
   /** Update the span with data we need. */
   private _updateSpan(span: Span, request: ClientRequest | IncomingMessage): void {
-    span.setAttribute(OTEL_ATTR_ORIGIN, 'auto.http.otel.http');
+    addOriginToSpan(span, 'auto.http.otel.http');
 
     if (getSpanKind(span) === SpanKind.SERVER) {
       setSpanMetadata(span, { request });
@@ -161,7 +158,7 @@ export class Http implements Integration {
       return;
     }
 
-    const data = getRequestSpanData(span);
+    const data = _INTERNAL.getRequestSpanData(span);
     getCurrentHub().addBreadcrumb(
       {
         category: 'http',

packages/node-experimental/src/integrations/http.ts

@@ -2,14 +2,12 @@ import type { Span } from '@opentelemetry/api';
 import { SpanKind } from '@opentelemetry/api';
 import { registerInstrumentations } from '@opentelemetry/instrumentation';
 import { hasTracingEnabled } from '@sentry/core';
+import { _INTERNAL, getCurrentHub, getSpanKind } from '@sentry/opentelemetry';
 import type { EventProcessor, Hub, Integration } from '@sentry/types';
 import { FetchInstrumentation } from 'opentelemetry-instrumentation-fetch-node';
 
-import { OTEL_ATTR_ORIGIN } from '../constants';
-import type { NodeExperimentalClient } from '../sdk/client';
-import { getCurrentHub } from '../sdk/hub';
-import { getRequestSpanData } from '../utils/getRequestSpanData';
-import { getSpanKind } from '../utils/getSpanKind';
+import type { NodeExperimentalClient } from '../types';
+import { addOriginToSpan } from '../utils/addOriginToSpan';
 
 interface NodeFetchOptions {
   /**
@@ -102,7 +100,7 @@ export class NodeFetch implements Integration {
 
   /** Update the span with data we need. */
   private _updateSpan(span: Span): void {
-    span.setAttribute(OTEL_ATTR_ORIGIN, 'auto.http.otel.node_fetch');
+    addOriginToSpan(span, 'auto.http.otel.node_fetch');
   }
 
   /** Add a breadcrumb for outgoing requests. */
@@ -111,7 +109,7 @@ export class NodeFetch implements Integration {
       return;
     }
 
-    const data = getRequestSpanData(span);
+    const data = _INTERNAL.getRequestSpanData(span);
     getCurrentHub().addBreadcrumb({
       category: 'http',
       data: {

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

@@ -1,23 +1,7 @@
-import type { Tracer } from '@opentelemetry/api';
-import { trace } from '@opentelemetry/api';
-import type { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
-import type { EventHint, Scope } from '@sentry/node';
 import { NodeClient, SDK_VERSION } from '@sentry/node';
-import type { Event } from '@sentry/types';
-
-import type {
-  NodeExperimentalClient as NodeExperimentalClientInterface,
-  NodeExperimentalClientOptions,
-} from '../types';
-import { NodeExperimentalScope } from './scope';
-
-/**
- * A client built on top of the NodeClient, which provides some otel-specific things on top.
- */
-export class NodeExperimentalClient extends NodeClient implements NodeExperimentalClientInterface {
-  public traceProvider: BasicTracerProvider | undefined;
-  private _tracer: Tracer | undefined;
+import { wrapClientClass } from '@sentry/opentelemetry';
 
+class NodeExperimentalBaseClient extends NodeClient {
   public constructor(options: ConstructorParameters<typeof NodeClient>[0]) {
     options._metadata = options._metadata || {};
     options._metadata.sdk = options._metadata.sdk || {
@@ -33,56 +17,6 @@ export class NodeExperimentalClient extends NodeClient implements NodeExperiment
 
     super(options);
   }
-
-  /** Get the OTEL tracer. */
-  public get tracer(): Tracer {
-    if (this._tracer) {
-      return this._tracer;
-    }
-
-    const name = '@sentry/node-experimental';
-    const version = SDK_VERSION;
-    const tracer = trace.getTracer(name, version);
-    this._tracer = tracer;
-
-    return tracer;
-  }
-
-  /**
-   * Get the options for the node preview client.
-   */
-  public getOptions(): NodeExperimentalClientOptions {
-    // Just a type-cast, basically
-    return super.getOptions();
-  }
-
-  /**
-   * @inheritDoc
-   */
-  public async flush(timeout?: number): Promise<boolean> {
-    const provider = this.traceProvider;
-    const spanProcessor = provider?.activeSpanProcessor;
-
-    if (spanProcessor) {
-      await spanProcessor.forceFlush();
-    }
-
-    return super.flush(timeout);
-  }
-
-  /**
-   * Extends the base `_prepareEvent` so that we can properly handle `captureContext`.
-   * This uses `Scope.clone()`, which we need to replace with `NodeExperimentalScope.clone()` for this client.
-   */
-  protected _prepareEvent(event: Event, hint: EventHint, scope?: Scope): PromiseLike<Event | null> {
-    let actualScope = scope;
-
-    // Remove `captureContext` hint and instead clone already here
-    if (hint && hint.captureContext) {
-      actualScope = NodeExperimentalScope.clone(scope);
-      delete hint.captureContext;
-    }
-
-    return super._prepareEvent(event, hint, actualScope);
-  }
 }
+
+export const NodeExperimentalClient = wrapClientClass(NodeExperimentalBaseClient);