create span v2 envelope

Author: Lms24

packages/browser/src/integrations/spanstreaming.ts

@@ -1,6 +1,13 @@
-import type { Envelope, IntegrationFn, Span, SpanV2JSON } from '@sentry/core';
-import { createEnvelope, debug, defineIntegration, isV2BeforeSendSpanCallback, spanToV2JSON } from '@sentry/core';
+import type { IntegrationFn, Span, SpanV2JSON } from '@sentry/core';
+import {
+  debug,
+  defineIntegration,
+  getDynamicSamplingContextFromSpan,
+  isV2BeforeSendSpanCallback,
+  spanToV2JSON,
+} from '@sentry/core';
 import { DEBUG_BUILD } from '../debug-build';
+import { createSpanV2Envelope } from '@sentry/core/build/types/envelope';
 
 export interface SpanStreamingOptions {
   batchLimit: number;
@@ -35,13 +42,14 @@ const _spanStreamingIntegration = ((userOptions?: Partial<SpanStreamingOptions>)
       const initialMessage = 'spanStreamingIntegration requires';
       const fallbackMsg = 'Falling back to static trace lifecycle.';
 
-      if (DEBUG_BUILD && clientOptions.traceLifecycle !== 'streamed') {
-        debug.warn(`${initialMessage} \`traceLifecycle\` to be set to "streamed"! ${fallbackMsg}`);
+      if (clientOptions.traceLifecycle !== 'streamed') {
+        DEBUG_BUILD && debug.warn(`${initialMessage} \`traceLifecycle\` to be set to "streamed"! ${fallbackMsg}`);
         return;
       }
 
-      if (DEBUG_BUILD && beforeSendSpan && !isV2BeforeSendSpanCallback(beforeSendSpan)) {
-        debug.warn(`${initialMessage} a beforeSendSpan callback using \`makeV2Callback\`! ${fallbackMsg}`);
+      if (beforeSendSpan && !isV2BeforeSendSpanCallback(beforeSendSpan)) {
+        DEBUG_BUILD &&
+          debug.warn(`${initialMessage} a beforeSendSpan callback using \`makeV2Callback\`! ${fallbackMsg}`);
         return;
       }
 
@@ -54,6 +62,8 @@ const _spanStreamingIntegration = ((userOptions?: Partial<SpanStreamingOptions>)
         }
       });
 
+      // For now, we send all spans on local segment (root) span end.
+      // TODO: This will change once we have more concrete ideas about a universal SDK data buffer.
       client.on('segmentSpanEnd', segmentSpan => {
         const traceId = segmentSpan.spanContext().traceId;
         const spansOfTrace = traceMap.get(traceId);
@@ -65,25 +75,24 @@ const _spanStreamingIntegration = ((userOptions?: Partial<SpanStreamingOptions>)
 
         const serializedSpans = Array.from(spansOfTrace ?? []).map(span => {
           const serializedSpan = spanToV2JSON(span);
-          const finalSpan = beforeSendSpan ? beforeSendSpan(serializedSpan) : serializedSpan;
-          return finalSpan;
+          return beforeSendSpan ? beforeSendSpan(serializedSpan) : serializedSpan;
         });
 
         const batches: SpanV2JSON[][] = [];
         for (let i = 0; i < serializedSpans.length; i += options.batchLimit) {
           batches.push(serializedSpans.slice(i, i + options.batchLimit));
         }
 
-        debug.log(`Sending trace ${traceId} in ${batches.length} batche${batches.length === 1 ? '' : 's'}`);
+        DEBUG_BUILD &&
+          debug.log(`Sending trace ${traceId} in ${batches.length} batche${batches.length === 1 ? '' : 's'}`);
 
         // TODO: Apply scopes to spans
-
-        // TODO: Apply beforeSendSpan to spans
-
         // TODO: Apply ignoreSpans to spans
 
+        const dsc = getDynamicSamplingContextFromSpan(segmentSpan);
+
         for (const batch of batches) {
-          const envelope = createSpanStreamEnvelope(batch);
+          const envelope = createSpanV2Envelope(batch, dsc, client);
           // no need to handle client reports for network errors,
           // buffer overflows or rate limiting here. All of this is handled
           // by client and transport.
@@ -99,7 +108,3 @@ const _spanStreamingIntegration = ((userOptions?: Partial<SpanStreamingOptions>)
 }) satisfies IntegrationFn;
 
 export const spanStreamingIntegration = defineIntegration(_spanStreamingIntegration);
-
-function createSpanStreamEnvelope(serializedSpans: StreamedSpanJSON[]): Envelope {
-  return createEnvelope<SpanEnvelope>(headers, [item]);
-}

packages/core/src/envelope.ts

@@ -11,13 +11,16 @@ import type {
   RawSecurityItem,
   SessionEnvelope,
   SessionItem,
+  SpanContainerItem,
   SpanEnvelope,
   SpanItem,
+  SpanV2Envelope,
 } from './types-hoist/envelope';
 import type { Event } from './types-hoist/event';
 import type { SdkInfo } from './types-hoist/sdkinfo';
 import type { SdkMetadata } from './types-hoist/sdkmetadata';
 import type { Session, SessionAggregates } from './types-hoist/session';
+import { SpanV2JSON } from './types-hoist/span';
 import { isV2BeforeSendSpanCallback } from './utils/beforeSendSpan';
 import { dsnToString } from './utils/dsn';
 import {
@@ -121,10 +124,6 @@ export function createEventEnvelope(
  * Takes an optional client and runs spans through `beforeSendSpan` if available.
  */
 export function createSpanEnvelope(spans: [SentrySpan, ...SentrySpan[]], client?: Client): SpanEnvelope {
-  function dscHasRequiredProps(dsc: Partial<DynamicSamplingContext>): dsc is DynamicSamplingContext {
-    return !!dsc.trace_id && !!dsc.public_key;
-  }
-
   // For the moment we'll obtain the DSC from the first span in the array
   // This might need to be changed if we permit sending multiple spans from
   // different segments in one envelope
@@ -180,6 +179,33 @@ export function createSpanEnvelope(spans: [SentrySpan, ...SentrySpan[]], client?
   return createEnvelope<SpanEnvelope>(headers, items);
 }
 
+/**
+ * Creates a span v2 envelope
+ */
+export function createSpanV2Envelope(
+  serializedSpans: SpanV2JSON[],
+  dsc: Partial<DynamicSamplingContext>,
+  client: Client,
+): SpanV2Envelope {
+  const dsn = client?.getDsn();
+  const tunnel = client?.getOptions().tunnel;
+  const sdk = client?.getOptions()._metadata?.sdk;
+
+  const headers: SpanV2Envelope[0] = {
+    sent_at: new Date().toISOString(),
+    ...(dscHasRequiredProps(dsc) && { trace: dsc }),
+    ...(sdk && { sdk: sdk }),
+    ...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
+  };
+
+  const spanContainer: SpanContainerItem = [
+    { type: 'span', item_count: serializedSpans.length, content_type: 'application/vnd.sentry.items.span.v2+json' },
+    { items: serializedSpans },
+  ];
+
+  return createEnvelope<SpanV2Envelope>(headers, [spanContainer]);
+}
+
 /**
  * Create an Envelope from a CSP report.
  */
@@ -202,3 +228,7 @@ export function createRawSecurityEnvelope(
 
   return createEnvelope<RawSecurityEnvelope>(envelopeHeaders, [eventItem]);
 }
+
+function dscHasRequiredProps(dsc: Partial<DynamicSamplingContext>): dsc is DynamicSamplingContext {
+  return !!dsc.trace_id && !!dsc.public_key;
+}

packages/core/src/index.ts

@@ -355,6 +355,7 @@ export type {
   ProfileChunkEnvelope,
   ProfileChunkItem,
   SpanEnvelope,
+  SpanV2Envelope,
   SpanItem,
   LogEnvelope,
 } from './types-hoist/envelope';

packages/core/src/types-hoist/envelope.ts

@@ -88,9 +88,9 @@ type CheckInItemHeaders = { type: 'check_in' };
 type ProfileItemHeaders = { type: 'profile' };
 type ProfileChunkItemHeaders = { type: 'profile_chunk' };
 type SpanItemHeaders = { type: 'span' };
-type SpanV2ItemHeaders = {
+type SpanContainerItemHeaders = {
   /**
-   * Same as v1 span item type but this envelope is distinguished by {@link SpanV2ItemHeaders.content_type}.
+   * Same as v1 span item type but this envelope is distinguished by {@link SpanContainerItemHeaders.content_type}.
    */
   type: 'span';
   /**
@@ -130,7 +130,7 @@ export type FeedbackItem = BaseEnvelopeItem<FeedbackItemHeaders, FeedbackEvent>;
 export type ProfileItem = BaseEnvelopeItem<ProfileItemHeaders, Profile>;
 export type ProfileChunkItem = BaseEnvelopeItem<ProfileChunkItemHeaders, ProfileChunk>;
 export type SpanItem = BaseEnvelopeItem<SpanItemHeaders, Partial<SpanJSON>>;
-export type SpanV2Item = BaseEnvelopeItem<SpanV2ItemHeaders, SerializedSpanContainer>;
+export type SpanContainerItem = BaseEnvelopeItem<SpanContainerItemHeaders, SerializedSpanContainer>;
 export type LogContainerItem = BaseEnvelopeItem<LogContainerItemHeaders, SerializedLogContainer>;
 export type RawSecurityItem = BaseEnvelopeItem<RawSecurityHeaders, LegacyCSPReport>;
 
@@ -140,7 +140,7 @@ type CheckInEnvelopeHeaders = { trace?: DynamicSamplingContext };
 type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;
 type ReplayEnvelopeHeaders = BaseEnvelopeHeaders;
 type SpanEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };
-type SpanV2EnvelopeHeaders = BaseEnvelopeHeaders & { trace: DynamicSamplingContext };
+type SpanV2EnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };
 type LogEnvelopeHeaders = BaseEnvelopeHeaders;
 export type EventEnvelope = BaseEnvelope<
   EventEnvelopeHeaders,
@@ -151,7 +151,7 @@ export type ClientReportEnvelope = BaseEnvelope<ClientReportEnvelopeHeaders, Cli
 export type ReplayEnvelope = [ReplayEnvelopeHeaders, [ReplayEventItem, ReplayRecordingItem]];
 export type CheckInEnvelope = BaseEnvelope<CheckInEnvelopeHeaders, CheckInItem>;
 export type SpanEnvelope = BaseEnvelope<SpanEnvelopeHeaders, SpanItem>;
-export type SpanV2Envelope = BaseEnvelope<SpanV2EnvelopeHeaders, SpanV2Item>;
+export type SpanV2Envelope = BaseEnvelope<SpanV2EnvelopeHeaders, SpanContainerItem>;
 export type ProfileChunkEnvelope = BaseEnvelope<BaseEnvelopeHeaders, ProfileChunkItem>;
 export type RawSecurityEnvelope = BaseEnvelope<BaseEnvelopeHeaders, RawSecurityItem>;
 export type LogEnvelope = BaseEnvelope<LogEnvelopeHeaders, LogContainerItem>;
@@ -164,6 +164,7 @@ export type Envelope =
   | ReplayEnvelope
   | CheckInEnvelope
   | SpanEnvelope
+  | SpanV2Envelope
   | RawSecurityEnvelope
   | LogEnvelope;
 export type EnvelopeItem = Envelope[1][number];

packages/core/src/types-hoist/span.ts

@@ -1,4 +1,4 @@
-import { SerializedAttributes } from './attributes';
+import type { SerializedAttributes } from './attributes';
 import type { SpanLink, SpanLinkJSON } from './link';
 import type { Measurements } from './measurement';
 import type { HrTime } from './opentelemetry';