align span & function names

Use regular `Span` type from `@opentelemetry/api` wherever possible.

Author: mydea

packages/node-experimental/src/index.ts

@@ -14,6 +14,7 @@ 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 {
   makeNodeTransport,
@@ -67,10 +68,8 @@ export type {
   Exception,
   Session,
   SeverityLevel,
-  Span,
   StackFrame,
   Stacktrace,
   Thread,
-  Transaction,
   User,
 } from '@sentry/node';

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

@@ -2,7 +2,7 @@ import type { Instrumentation } from '@opentelemetry/instrumentation';
 import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
 import type { Integration } from '@sentry/types';
 
-import { addOriginToOtelSpan } from '../utils/addOriginToSpan';
+import { addOriginToSpan } from '../utils/addOriginToSpan';
 import { NodePerformanceIntegration } from './NodePerformanceIntegration';
 
 /**
@@ -31,7 +31,7 @@ export class Express extends NodePerformanceIntegration<void> implements Integra
     return [
       new ExpressInstrumentation({
         requestHook(span) {
-          addOriginToOtelSpan(span, 'auto.http.otel.express');
+          addOriginToSpan(span, 'auto.http.otel.express');
         },
       }),
     ];

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

@@ -2,7 +2,7 @@ import type { Instrumentation } from '@opentelemetry/instrumentation';
 import { FastifyInstrumentation } from '@opentelemetry/instrumentation-fastify';
 import type { Integration } from '@sentry/types';
 
-import { addOriginToOtelSpan } from '../utils/addOriginToSpan';
+import { addOriginToSpan } from '../utils/addOriginToSpan';
 import { NodePerformanceIntegration } from './NodePerformanceIntegration';
 
 /**
@@ -31,7 +31,7 @@ export class Fastify extends NodePerformanceIntegration<void> implements Integra
     return [
       new FastifyInstrumentation({
         requestHook(span) {
-          addOriginToOtelSpan(span, 'auto.http.otel.fastify');
+          addOriginToSpan(span, 'auto.http.otel.fastify');
         },
       }),
     ];

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

@@ -2,7 +2,7 @@ import type { Instrumentation } from '@opentelemetry/instrumentation';
 import { GraphQLInstrumentation } from '@opentelemetry/instrumentation-graphql';
 import type { Integration } from '@sentry/types';
 
-import { addOriginToOtelSpan } from '../utils/addOriginToSpan';
+import { addOriginToSpan } from '../utils/addOriginToSpan';
 import { NodePerformanceIntegration } from './NodePerformanceIntegration';
 
 /**
@@ -32,7 +32,7 @@ export class GraphQL extends NodePerformanceIntegration<void> implements Integra
       new GraphQLInstrumentation({
         ignoreTrivialResolveSpans: true,
         responseHook(span) {
-          addOriginToOtelSpan(span, 'auto.graphql.otel.graphql');
+          addOriginToSpan(span, 'auto.graphql.otel.graphql');
         },
       }),
     ];

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

@@ -1,3 +1,4 @@
+import type { Span } from '@opentelemetry/api';
 import { SpanKind } from '@opentelemetry/api';
 import { registerInstrumentations } from '@opentelemetry/instrumentation';
 import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
@@ -7,12 +8,12 @@ import { stringMatchesSomePattern } from '@sentry/utils';
 import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';
 
 import { OTEL_ATTR_ORIGIN } from '../constants';
-import { setOtelSpanMetadata } from '../opentelemetry/spanData';
+import { setSpanMetadata } from '../opentelemetry/spanData';
 import type { NodeExperimentalClient } from '../sdk/client';
 import { getCurrentHub } from '../sdk/hub';
-import type { OtelSpan } from '../types';
 import { getRequestSpanData } from '../utils/getRequestSpanData';
 import { getRequestUrl } from '../utils/getRequestUrl';
+import { getSpanKind } from '../utils/getSpanKind';
 
 interface HttpOptions {
   /**
@@ -128,10 +129,10 @@ export class Http implements Integration {
           requireParentforOutgoingSpans: true,
           requireParentforIncomingSpans: false,
           requestHook: (span, req) => {
-            this._updateSpan(span as unknown as OtelSpan, req);
+            this._updateSpan(span, req);
           },
           responseHook: (span, res) => {
-            this._addRequestBreadcrumb(span as unknown as OtelSpan, res);
+            this._addRequestBreadcrumb(span, res);
           },
         }),
       ],
@@ -146,17 +147,17 @@ export class Http implements Integration {
   }
 
   /** Update the span with data we need. */
-  private _updateSpan(span: OtelSpan, request: ClientRequest | IncomingMessage): void {
+  private _updateSpan(span: Span, request: ClientRequest | IncomingMessage): void {
     span.setAttribute(OTEL_ATTR_ORIGIN, 'auto.http.otel.http');
 
-    if (span.kind === SpanKind.SERVER) {
-      setOtelSpanMetadata(span, { request });
+    if (getSpanKind(span) === SpanKind.SERVER) {
+      setSpanMetadata(span, { request });
     }
   }
 
   /** Add a breadcrumb for outgoing requests. */
-  private _addRequestBreadcrumb(span: OtelSpan, response: IncomingMessage | ServerResponse): void {
-    if (!this._breadcrumbs || span.kind !== SpanKind.CLIENT) {
+  private _addRequestBreadcrumb(span: Span, response: IncomingMessage | ServerResponse): void {
+    if (!this._breadcrumbs || getSpanKind(span) !== SpanKind.CLIENT) {
       return;
     }
 

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

@@ -2,7 +2,7 @@ import type { Instrumentation } from '@opentelemetry/instrumentation';
 import { MongoDBInstrumentation } from '@opentelemetry/instrumentation-mongodb';
 import type { Integration } from '@sentry/types';
 
-import { addOriginToOtelSpan } from '../utils/addOriginToSpan';
+import { addOriginToSpan } from '../utils/addOriginToSpan';
 import { NodePerformanceIntegration } from './NodePerformanceIntegration';
 
 /**
@@ -31,7 +31,7 @@ export class Mongo extends NodePerformanceIntegration<void> implements Integrati
     return [
       new MongoDBInstrumentation({
         responseHook(span) {
-          addOriginToOtelSpan(span, 'auto.db.otel.mongo');
+          addOriginToSpan(span, 'auto.db.otel.mongo');
         },
       }),
     ];

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

@@ -2,7 +2,7 @@ import type { Instrumentation } from '@opentelemetry/instrumentation';
 import { MongooseInstrumentation } from '@opentelemetry/instrumentation-mongoose';
 import type { Integration } from '@sentry/types';
 
-import { addOriginToOtelSpan } from '../utils/addOriginToSpan';
+import { addOriginToSpan } from '../utils/addOriginToSpan';
 import { NodePerformanceIntegration } from './NodePerformanceIntegration';
 
 /**
@@ -31,7 +31,7 @@ export class Mongoose extends NodePerformanceIntegration<void> implements Integr
     return [
       new MongooseInstrumentation({
         responseHook(span) {
-          addOriginToOtelSpan(span, 'auto.db.otel.mongoose');
+          addOriginToSpan(span, 'auto.db.otel.mongoose');
         },
       }),
     ];

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

@@ -2,7 +2,7 @@ import type { Instrumentation } from '@opentelemetry/instrumentation';
 import { MySQL2Instrumentation } from '@opentelemetry/instrumentation-mysql2';
 import type { Integration } from '@sentry/types';
 
-import { addOriginToOtelSpan } from '../utils/addOriginToSpan';
+import { addOriginToSpan } from '../utils/addOriginToSpan';
 import { NodePerformanceIntegration } from './NodePerformanceIntegration';
 
 /**
@@ -31,7 +31,7 @@ export class Mysql2 extends NodePerformanceIntegration<void> implements Integrat
     return [
       new MySQL2Instrumentation({
         responseHook(span) {
-          addOriginToOtelSpan(span, 'auto.db.otel.mysql2');
+          addOriginToSpan(span, 'auto.db.otel.mysql2');
         },
       }),
     ];

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

@@ -2,7 +2,7 @@ import type { Instrumentation } from '@opentelemetry/instrumentation';
 import { PgInstrumentation } from '@opentelemetry/instrumentation-pg';
 import type { Integration } from '@sentry/types';
 
-import { addOriginToOtelSpan } from '../utils/addOriginToSpan';
+import { addOriginToSpan } from '../utils/addOriginToSpan';
 import { NodePerformanceIntegration } from './NodePerformanceIntegration';
 
 /**
@@ -32,7 +32,7 @@ export class Postgres extends NodePerformanceIntegration<void> implements Integr
       new PgInstrumentation({
         requireParentSpan: true,
         requestHook(span) {
-          addOriginToOtelSpan(span, 'auto.db.otel.postgres');
+          addOriginToSpan(span, 'auto.db.otel.postgres');
         },
       }),
     ];

packages/node-experimental/src/opentelemetry/spanData.ts

@@ -1,50 +1,55 @@
-import type { Span as OtelSpan } from '@opentelemetry/api';
+import type { Span } from '@opentelemetry/api';
+import type { ReadableSpan } from '@opentelemetry/sdk-trace-base';
 import type { Hub, Scope, TransactionMetadata } from '@sentry/types';
 
+// We allow passing either a Span (=which is bascially a WriteableSpan), or a ReadableSpan
+// As we check by identity anyhow we don't really care
+type AbstractSpan = Span | ReadableSpan;
+
 // We store the parent span, scope & metadata in separate weakmaps, so we can access them for a given span
 // This way we can enhance the data that an OTEL Span natively gives us
 // and since we are using weakmaps, we do not need to clean up after ourselves
-const otelSpanScope = new WeakMap<OtelSpan, Scope>();
-const otelSpanHub = new WeakMap<OtelSpan, Hub>();
-const otelSpanParent = new WeakMap<OtelSpan, OtelSpan>();
-const otelSpanMetadata = new WeakMap<OtelSpan, Partial<TransactionMetadata>>();
+const SpanScope = new WeakMap<AbstractSpan, Scope>();
+const SpanHub = new WeakMap<AbstractSpan, Hub>();
+const SpanParent = new WeakMap<AbstractSpan, Span>();
+const SpanMetadata = new WeakMap<AbstractSpan, Partial<TransactionMetadata>>();
 
 /** Set the Sentry scope on an OTEL span. */
-export function setOtelSpanScope(span: OtelSpan, scope: Scope): void {
-  otelSpanScope.set(span, scope);
+export function setSpanScope(span: AbstractSpan, scope: Scope): void {
+  SpanScope.set(span, scope);
 }
 
 /** Get the Sentry scope of an OTEL span. */
-export function getOtelSpanScope(span: OtelSpan): Scope | undefined {
-  return otelSpanScope.get(span);
+export function getSpanScope(span: AbstractSpan): Scope | undefined {
+  return SpanScope.get(span);
 }
 
 /** Set the Sentry hub on an OTEL span. */
-export function setOtelSpanHub(span: OtelSpan, hub: Hub): void {
-  otelSpanHub.set(span, hub);
+export function setSpanHub(span: AbstractSpan, hub: Hub): void {
+  SpanHub.set(span, hub);
 }
 
 /** Get the Sentry hub of an OTEL span. */
-export function getOtelSpanHub(span: OtelSpan): Hub | undefined {
-  return otelSpanHub.get(span);
+export function getSpanHub(span: AbstractSpan): Hub | undefined {
+  return SpanHub.get(span);
 }
 
 /** Set the parent OTEL span on an OTEL span. */
-export function setOtelSpanParent(span: OtelSpan, parentSpan: OtelSpan): void {
-  otelSpanParent.set(span, parentSpan);
+export function setSpanParent(span: AbstractSpan, parentSpan: Span): void {
+  SpanParent.set(span, parentSpan);
 }
 
 /** Get the parent OTEL span of an OTEL span. */
-export function getOtelSpanParent(span: OtelSpan): OtelSpan | undefined {
-  return otelSpanParent.get(span);
+export function getSpanParent(span: AbstractSpan): Span | undefined {
+  return SpanParent.get(span);
 }
 
 /** Set metadata for an OTEL span. */
-export function setOtelSpanMetadata(span: OtelSpan, metadata: Partial<TransactionMetadata>): void {
-  otelSpanMetadata.set(span, metadata);
+export function setSpanMetadata(span: AbstractSpan, metadata: Partial<TransactionMetadata>): void {
+  SpanMetadata.set(span, metadata);
 }
 
 /** Get metadata for an OTEL span. */
-export function getOtelSpanMetadata(span: OtelSpan): Partial<TransactionMetadata> | undefined {
-  return otelSpanMetadata.get(span);
+export function getSpanMetadata(span: AbstractSpan): Partial<TransactionMetadata> | undefined {
+  return SpanMetadata.get(span);
 }