better trace flags & comments

Author: mydea

packages/astro/test/server/meta.test.ts

@@ -3,13 +3,15 @@ import { vi } from 'vitest';
 
 import { getTracingMetaTags, isValidBaggageString } from '../../src/server/meta';
 
+const TRACE_FLAG_SAMPLED = 0x1;
+
 const mockedSpan = {
   isRecording: () => true,
   spanContext: () => {
     return {
       traceId: '12345678901234567890123456789012',
       spanId: '1234567890123456',
-      traceFlags: TraceFlagSampled,
+      traceFlags: TRACE_FLAG_SAMPLED,
     };
   },
   transaction: {
@@ -19,9 +21,6 @@ const mockedSpan = {
   },
 } as any;
 
-// eslint-disable-next-line no-bitwise
-const TraceFlagSampled = 0x1 << 0;
-
 const mockedClient = {} as any;
 
 const mockedScope = {
@@ -83,7 +82,7 @@ describe('getTracingMetaTags', () => {
           return {
             traceId: '12345678901234567890123456789012',
             spanId: '1234567890123456',
-            traceFlags: TraceFlagSampled,
+            traceFlags: TRACE_FLAG_SAMPLED,
           };
         },
         transaction: undefined,
@@ -111,7 +110,7 @@ describe('getTracingMetaTags', () => {
           return {
             traceId: '12345678901234567890123456789012',
             spanId: '1234567890123456',
-            traceFlags: TraceFlagSampled,
+            traceFlags: TRACE_FLAG_SAMPLED,
           };
         },
         transaction: undefined,

packages/core/src/tracing/span.ts

@@ -17,8 +17,8 @@ import { dropUndefinedKeys, logger, timestampInSeconds, uuid4 } from '@sentry/ut
 
 import { DEBUG_BUILD } from '../debug-build';
 import {
-  TraceFlagNone,
-  TraceFlagSampled,
+  TRACE_FLAG_NONE,
+  TRACE_FLAG_SAMPLED,
   spanTimeInputToSeconds,
   spanToTraceContext,
   spanToTraceHeader,
@@ -240,7 +240,7 @@ export class Span implements SpanInterface {
     return {
       spanId,
       traceId,
-      traceFlags: sampled ? TraceFlagSampled : TraceFlagNone,
+      traceFlags: sampled ? TRACE_FLAG_SAMPLED : TRACE_FLAG_NONE,
     };
   }
 

packages/core/src/utils/spanUtils.ts

@@ -2,15 +2,15 @@ import type { Span, SpanJSON, SpanTimeInput, TraceContext } from '@sentry/types'
 import { dropUndefinedKeys, generateSentryTraceHeader, timestampInSeconds } from '@sentry/utils';
 import type { Span as SpanClass } from '../tracing/span';
 
-export const TraceFlagNone = 0x0;
-// eslint-disable-next-line no-bitwise
-export const TraceFlagSampled = 0x1 << 0;
+// These are aligned with OpenTelemetry trace flags
+export const TRACE_FLAG_NONE = 0x0;
+export const TRACE_FLAG_SAMPLED = 0x1;
 
 /**
  * Convert a span to a trace context, which can be sent as the `trace` context in an event.
  */
 export function spanToTraceContext(span: Span): TraceContext {
-  const { spanId: span_id, traceId: trace_id } = span;
+  const { spanId: span_id, traceId: trace_id } = span.spanContext();
   const { data, description, op, parent_span_id, status, tags, origin } = spanToJSON(span);
 
   return dropUndefinedKeys({
@@ -102,7 +102,9 @@ function spanIsSpanClass(span: Span): span is SpanClass {
  * So in the case where this distinction is important, use this method.
  */
 export function spanIsSampled(span: Span): boolean {
+  // We align our trace flags with the ones OpenTelemetry use
+  // So we also check for sampled the same way they do.
   const { traceFlags } = span.spanContext();
   // eslint-disable-next-line no-bitwise
-  return Boolean(traceFlags & TraceFlagSampled);
+  return Boolean(traceFlags & TRACE_FLAG_SAMPLED);
 }

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

@@ -1,6 +1,6 @@
 import { timestampInSeconds } from '@sentry/utils';
 import { Span } from '../../../src';
-import { TraceFlagNone, TraceFlagSampled } from '../../../src/utils/spanUtils';
+import { TRACE_FLAG_NONE, TRACE_FLAG_SAMPLED } from '../../../src/utils/spanUtils';
 
 describe('span', () => {
   it('works with name', () => {
@@ -233,7 +233,7 @@ describe('span', () => {
       expect(span.spanContext()).toEqual({
         spanId: span['_spanId'],
         traceId: span['_traceId'],
-        traceFlags: TraceFlagNone,
+        traceFlags: TRACE_FLAG_NONE,
       });
     });
 
@@ -242,7 +242,7 @@ describe('span', () => {
       expect(span.spanContext()).toEqual({
         spanId: span['_spanId'],
         traceId: span['_traceId'],
-        traceFlags: TraceFlagSampled,
+        traceFlags: TRACE_FLAG_SAMPLED,
       });
     });
 
@@ -251,7 +251,7 @@ describe('span', () => {
       expect(span.spanContext()).toEqual({
         spanId: span['_spanId'],
         traceId: span['_traceId'],
-        traceFlags: TraceFlagNone,
+        traceFlags: TRACE_FLAG_NONE,
       });
     });
   });

packages/core/test/lib/utils/spanUtils.test.ts

@@ -1,6 +1,6 @@
 import { TRACEPARENT_REGEXP, timestampInSeconds } from '@sentry/utils';
 import { Span, spanToTraceHeader } from '../../../src';
-import { spanTimeInputToSeconds, spanToJSON, spanIsSampled } from '../../../src/utils/spanUtils';
+import { spanIsSampled, spanTimeInputToSeconds, spanToJSON } from '../../../src/utils/spanUtils';
 
 describe('spanToTraceHeader', () => {
   test('simple', () => {
@@ -51,8 +51,8 @@ describe('spanToJSON', () => {
   it('works with a simple span', () => {
     const span = new Span();
     expect(spanToJSON(span)).toEqual({
-      span_id: span.spanId,
-      trace_id: span.traceId,
+      span_id: span.spanContext().spanId,
+      trace_id: span.spanContext().traceId,
       origin: 'manual',
       start_timestamp: span.startTimestamp,
     });

packages/types/src/span.ts

@@ -43,10 +43,10 @@ export interface SpanJSON {
   origin?: SpanOrigin;
 }
 
-const TraceFlagNone = 0x0;
-// eslint-disable-next-line no-bitwise
-const TraceFlagSampled = 0x1 << 0;
-export type TraceFlag = typeof TraceFlagNone | typeof TraceFlagSampled;
+// These are aligned with OpenTelemetry trace flags
+type TraceFlagNone = 0x0;
+type TraceFlagSampled = 0x1;
+export type TraceFlag = TraceFlagNone | TraceFlagSampled;
 
 export interface SpanContextData {
   /**