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

Apply suggestions from code review

Co-authored-by: Abhijeet Prasad <[email protected]>
PR feedback

PR feedback: Expose proper `setupGlobalHub` method

pr feedback & new release docs

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

docs/new-sdk-release-checklist.md

@@ -47,6 +47,8 @@ This page serves as a checklist of what to do when releasing a new SDK for the f
 
 - [ ] Make sure it is added to `bundlePlugins.ts:makeTSPlugin` as `paths`, otherwise it will not be ES5 transpiled correctly for CDN builds.
 
+- [ ] Make sure it is added to the [Verdaccio config](https://github.com/getsentry/sentry-javascript/blob/develop/packages/e2e-tests/verdaccio-config/config.yaml) for the E2E tests
+
 ## Cutting the Release
 
 When you’re ready to make the first release, there are a couple of steps that need to be performed in the **correct order**. Note that you can prepare the PRs at any time but the **merging oder** is important:
@@ -56,7 +58,7 @@ When you’re ready to make the first release, there are a couple of steps that
 ### Before the Release:
 
 - [ ]  1) If not yet done, be sure to remove the `private: true` property from your SDK’s `package.json`. Additionally, ensure that `"publishConfig": {"access": "public"}` is set.
-- [ ]  2) Make sure that the new SDK is **not added** in`[craft.yml](https://github.com/getsentry/sentry-javascript/blob/master/.craft.yml)` as a target for the **Sentry release registry**\
+- [ ]  2) Make sure that the new SDK is **not added** in`[craft.yml](https://github.com/getsentry/sentry-javascript/blob/develop/.craft.yml)` as a target for the **Sentry release registry**\
 *Once this is added, craft will try to publish an entry in the next release which does not work and caused failed release runs in the past*
 - [ ]  3) Add an `npm` target in `craft.yml` for the new package. Make sure to insert it in the right place, after all the Sentry dependencies of your package but before packages that depend on your new package (if applicable).
     ```yml
@@ -74,7 +76,7 @@ When you’re ready to make the first release, there are a couple of steps that
     You have to fork this repo and PR the files from your fork to the main repo \
     [Example PR](https://github.com/getsentry/sentry-release-registry/pull/80) from the Svelte SDK
 
-- [ ]  2) Add an entry to `[craft.yml](https://github.com/getsentry/sentry-javascript/blob/master/.craft.yml)` to add releases of your SDK to the Sentry release registry \
+- [ ]  2) Add an entry to [craft.yml](https://github.com/getsentry/sentry-javascript/blob/develop/.craft.yml) to add releases of your SDK to the Sentry release registry \
     [Example PR](https://github.com/getsentry/sentry-javascript/pull/5547) from the Svelte SDK \
     *Subsequent releases will now be added automatically to the registry*
 

package.json

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

packages/e2e-tests/verdaccio-config/config.yaml

@@ -122,6 +122,12 @@ packages:
     unpublish: $all
     # proxy: npmjs # Don't proxy for E2E tests!
 
+  '@sentry/opentelemetry':
+    access: $all
+    publish: $all
+    unpublish: $all
+    # proxy: npmjs # Don't proxy for E2E tests!
+
   '@sentry/react':
     access: $all
     publish: $all

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/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.1",
     "@sentry/node": "7.74.1",
-    "@sentry/opentelemetry-node": "7.74.1",
+    "@sentry/opentelemetry": "7.74.1",
     "@sentry/types": "7.74.1",
     "@sentry/utils": "7.74.1",
     "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 type { Instrumentation } from '@opentelemetry/instrumentation';
 import { hasTracingEnabled } from '@sentry/core';
+import { _INTERNAL, getCurrentHub, getSpanKind } from '@sentry/opentelemetry';
 import type { 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';
 import { NodePerformanceIntegration } from './NodePerformanceIntegration';
 
 interface NodeFetchOptions {
@@ -101,7 +99,7 @@ export class NodeFetch extends NodePerformanceIntegration<NodeFetchOptions> impl
 
   /** 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. */
@@ -110,7 +108,7 @@ export class NodeFetch extends NodePerformanceIntegration<NodeFetchOptions> impl
       return;
     }
 
-    const data = getRequestSpanData(span);
+    const data = _INTERNAL.getRequestSpanData(span);
     getCurrentHub().addBreadcrumb({
       category: 'http',
       data: {