feat(core): Deprecate StartSpanOptions.origin in favour of passing attribute

Author: Lms24

packages/core/src/tracing/span.ts

@@ -134,7 +134,10 @@ export class Span implements SpanInterface {
     // eslint-disable-next-line deprecation/deprecation
     this.instrumenter = spanContext.instrumenter || 'sentry';
 
-    this.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, spanContext.origin || 'manual');
+    this.setAttribute(
+      SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
+      spanContext.origin || this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] || 'manual',
+    );
 
     // eslint-disable-next-line deprecation/deprecation
     this._name = spanContext.name || spanContext.description;

packages/core/src/tracing/trace.ts

@@ -20,7 +20,7 @@ import { handleCallbackErrors } from '../utils/handleCallbackErrors';
 import { hasTracingEnabled } from '../utils/hasTracingEnabled';
 import { spanTimeInputToSeconds, spanToJSON } from '../utils/spanUtils';
 
-interface StartSpanOptions extends TransactionContext {
+interface StartSpanOptions extends Omit<TransactionContext, 'origin'> {
   /** A manually specified start time for the created `Span` object. */
   startTime?: SpanTimeInput;
 
@@ -33,7 +33,11 @@ interface StartSpanOptions extends TransactionContext {
   /** An op for the span. This is a categorization for spans. */
   op?: string;
 
-  /** The origin of the span - if it comes from auto instrumenation or manual instrumentation. */
+  /**
+   * The origin of the span - if it comes from auto instrumentation or manual instrumentation.
+   *
+   * @deprecated Set `attributes['sentry.origin']` instead.
+   */
   origin?: SpanOrigin;
 
   /** Attributes for the span. */
@@ -387,5 +391,17 @@ function normalizeContext(context: StartSpanOptions): TransactionContext {
     return ctx;
   }
 
+  // TODO (v8): Remove this normalization once we remove top-level context.origin
+  // eslint-disable-next-line deprecation/deprecation
+  if (context.origin) {
+    context.attributes = {
+      // eslint-disable-next-line deprecation/deprecation
+      'sentry.origin': context.origin,
+      ...context.attributes, // potentially set attributes value takes precedence
+    };
+    // eslint-disable-next-line deprecation/deprecation
+    delete context.origin;
+  }
+
   return context;
 }

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

@@ -229,6 +229,40 @@ describe('startSpan', () => {
       expect(ref.spanRecorder.spans).toHaveLength(2);
       expect(spanToJSON(ref.spanRecorder.spans[1]).op).toEqual('db.query');
     });
+
+    it.each([
+      { origin: 'auto.http.browser' },
+      { attributes: { 'sentry.origin': 'auto.http.browser' } },
+      // attribute should take precedence over top level origin
+      { origin: 'manual', attributes: { 'sentry.origin': 'auto.http.browser' } },
+    ])('correctly sets the span origin', async () => {
+      let ref: any = undefined;
+      client.on('finishTransaction', transaction => {
+        ref = transaction;
+      });
+      try {
+        await startSpan({ name: 'GET users/[id]', origin: 'auto.http.browser' }, () => {
+          return callback();
+        });
+      } catch (e) {
+        //
+      }
+
+      const jsonSpan = spanToJSON(ref);
+      expect(jsonSpan).toEqual({
+        data: {
+          'sentry.origin': 'auto.http.browser',
+          'sentry.sample_rate': 0,
+        },
+        origin: 'auto.http.browser',
+        description: 'GET users/[id]',
+        span_id: expect.any(String),
+        start_timestamp: expect.any(Number),
+        status: isError ? 'internal_error' : undefined,
+        timestamp: expect.any(Number),
+        trace_id: expect.any(String),
+      });
+    });
   });
 
   it('creates & finishes span', async () => {

packages/types/src/span.ts

@@ -23,7 +23,12 @@ export type SpanAttributeValue =
   | Array<null | undefined | number>
   | Array<null | undefined | boolean>;
 
-export type SpanAttributes = Record<string, SpanAttributeValue | undefined>;
+export type SpanAttributes = {
+  'sentry.origin': string;
+  'sentry.op': string;
+  'sentry.source': string;
+  'sentry.sample_rate': number;
+} & Record<string, SpanAttributeValue | undefined>;
 
 /** This type is aligned with the OpenTelemetry TimeInput type. */
 export type SpanTimeInput = HrTime | number | Date;