ref: Emit spanStart and spanEnd hooks

Author: mydea

packages/core/src/baseclient.ts

@@ -22,6 +22,7 @@ import type {
   Session,
   SessionAggregates,
   SeverityLevel,
+  Span,
   StartSpanOptions,
   Transaction,
   TransactionEvent,
@@ -422,6 +423,12 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
   /** @inheritdoc */
   public on(hook: 'finishTransaction', callback: (transaction: Transaction) => void): void;
 
+  /** @inheritdoc */
+  public on(hook: 'spanStart', callback: (span: Span) => void): void;
+
+  /** @inheritdoc */
+  public on(hook: 'spanEnd', callback: (span: Span) => void): void;
+
   /** @inheritdoc */
   public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 
@@ -472,6 +479,12 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
   /** @inheritdoc */
   public emit(hook: 'finishTransaction', transaction: Transaction): void;
 
+  /** @inheritdoc */
+  public emit(hook: 'spanStart', span: Span): void;
+
+  /** @inheritdoc */
+  public emit(hook: 'spanEnd', span: Span): void;
+
   /** @inheritdoc */
   public emit(hook: 'beforeEnvelope', envelope: Envelope): void;
 

packages/core/src/tracing/hubextensions.ts

@@ -48,6 +48,7 @@ function _startTransaction(
   }
   if (client) {
     client.emit('startTransaction', transaction);
+    client.emit('spanStart', transaction);
   }
   return transaction;
 }
@@ -95,6 +96,7 @@ export function startIdleTransaction(
   }
   if (client) {
     client.emit('startTransaction', transaction);
+    client.emit('spanStart', transaction);
   }
   return transaction;
 }

packages/core/src/tracing/sentrySpan.ts

@@ -13,6 +13,7 @@ import type {
   Transaction,
 } from '@sentry/types';
 import { dropUndefinedKeys, logger, timestampInSeconds, uuid4 } from '@sentry/utils';
+import { getClient } from '../currentScopes';
 
 import { DEBUG_BUILD } from '../debug-build';
 import { getMetricSummaryJsonForSpan } from '../metrics/metric-summary';
@@ -277,7 +278,7 @@ export class SentrySpan implements Span {
    * @deprecated Use `startSpan()`, `startSpanManual()` or `startInactiveSpan()` instead.
    */
   public startChild(
-    spanContext?: Pick<SpanContext, Exclude<keyof SpanContext, 'sampled' | 'traceId' | 'parentSpanId'>>,
+    spanContext: Pick<SpanContext, Exclude<keyof SpanContext, 'sampled' | 'traceId' | 'parentSpanId'>> = {},
   ): Span {
     const childSpan = new SentrySpan({
       ...spanContext,
@@ -315,6 +316,15 @@ export class SentrySpan implements Span {
       this._logMessage = logMessage;
     }
 
+    const client = getClient();
+    if (client) {
+      client.emit('spanStart', childSpan);
+      // If it has an endTimestamp, it's already ended
+      if (spanContext.endTimestamp) {
+        client.emit('spanEnd', childSpan);
+      }
+    }
+
     return childSpan;
   }
 
@@ -397,6 +407,8 @@ export class SentrySpan implements Span {
     }
 
     this._endTime = spanTimeInputToSeconds(endTimestamp);
+
+    this._onSpanEnded();
   }
 
   /**
@@ -499,4 +511,12 @@ export class SentrySpan implements Span {
 
     return hasData ? data : attributes;
   }
+
+  /** Emit `spanEnd` when the span is ended. */
+  private _onSpanEnded(): void {
+    const client = getClient();
+    if (client) {
+      client.emit('spanEnd', this);
+    }
+  }
 }

packages/core/test/lib/tracing/trace.test.ts

@@ -1168,3 +1168,54 @@ describe('continueTrace', () => {
     expect(ctx).toEqual(expectedContext);
   });
 });
+
+describe('span hooks', () => {
+  beforeEach(() => {
+    addTracingExtensions();
+
+    getCurrentScope().clear();
+    getIsolationScope().clear();
+    getGlobalScope().clear();
+
+    const options = getDefaultTestClientOptions({ tracesSampleRate: 0.0 });
+    client = new TestClient(options);
+    setCurrentClient(client);
+    client.init();
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('correctly emits span hooks', () => {
+    const startedSpans: string[] = [];
+    const endedSpans: string[] = [];
+
+    client.on('spanStart', span => {
+      startedSpans.push(spanToJSON(span).description || '');
+    });
+
+    client.on('spanEnd', span => {
+      endedSpans.push(spanToJSON(span).description || '');
+    });
+
+    startSpan({ name: 'span1' }, () => {
+      startSpan({ name: 'span2' }, () => {
+        const span = startInactiveSpan({ name: 'span3' });
+
+        startSpanManual({ name: 'span5' }, span => {
+          startInactiveSpan({ name: 'span4' });
+          span?.end();
+        });
+
+        span?.end();
+      });
+    });
+
+    expect(startedSpans).toHaveLength(5);
+    expect(endedSpans).toHaveLength(4);
+
+    expect(startedSpans).toEqual(['span1', 'span2', 'span3', 'span5', 'span4']);
+    expect(endedSpans).toEqual(['span5', 'span3', 'span2', 'span1']);
+  });
+});

packages/opentelemetry/src/custom/transaction.ts

@@ -18,6 +18,7 @@ export function startTransaction(hub: HubInterface, transactionContext: Transact
 
   if (client) {
     client.emit('startTransaction', transaction);
+    client.emit('spanStart', transaction);
   }
   return transaction;
 }

packages/opentelemetry/src/spanProcessor.ts

@@ -67,6 +67,9 @@ export class SentrySpanProcessor extends BatchSpanProcessor implements SpanProce
   public onStart(span: Span, parentContext: Context): void {
     onSpanStart(span, parentContext);
 
+    // TODO (v8): Trigger client `spanStart` & `spanEnd` in here,
+    // once we decoupled opentelemetry from SentrySpan
+
     DEBUG_BUILD && logger.log(`[Tracing] Starting span "${span.name}" (${span.spanContext().spanId})`);
 
     return super.onStart(span, parentContext);

packages/types/src/client.ts

@@ -14,6 +14,7 @@ import type { Scope } from './scope';
 import type { SdkMetadata } from './sdkmetadata';
 import type { Session, SessionAggregates } from './session';
 import type { SeverityLevel } from './severity';
+import type { Span } from './span';
 import type { StartSpanOptions } from './startSpanOptions';
 import type { Transaction } from './transaction';
 import type { Transport, TransportMakeRequestResponse } from './transport';
@@ -193,6 +194,18 @@ export interface Client<O extends ClientOptions = ClientOptions> {
    */
   on(hook: 'finishTransaction', callback: (transaction: Transaction) => void): void;
 
+  /**
+   * Register a callback for whenever a span is started.
+   * Receives the span as argument.
+   */
+  on(hook: 'spanStart', callback: (span: Span) => void): void;
+
+  /**
+   * Register a callback for whenever a span is ended.
+   * Receives the span as argument.
+   */
+  on(hook: 'spanEnd', callback: (span: Span) => void): void;
+
   /**
    * Register a callback for transaction start and finish.
    */
@@ -269,6 +282,12 @@ export interface Client<O extends ClientOptions = ClientOptions> {
    */
   emit(hook: 'finishTransaction', transaction: Transaction): void;
 
+  /** Fire a hook whener a span starts. */
+  emit(hook: 'spanStart', span: Span): void;
+
+  /** Fire a hook whener a span ends. */
+  emit(hook: 'spanEnd', span: Span): void;
+
   /*
    * Fire a hook event for envelope creation and sending. Expects to be given an envelope as the
    * second argument.