remove is_remote, add is_segment

Author: Lms24

packages/browser/src/integrations/spanstreaming.ts

@@ -1,14 +1,12 @@
 import type { Client, IntegrationFn, Scope, ScopeData, Span, SpanAttributes, SpanV2JSON } from '@sentry/core';
 import {
-  attributesFromObject,
   createSpanV2Envelope,
   debug,
   defineIntegration,
   getCapturedScopesOnSpan,
   getDynamicSamplingContextFromSpan,
   getGlobalScope,
-  getRootSpan as getSegmentSpan,
-  httpHeadersToSpanAttributes,
+  INTERNAL_getSegmentSpan,
   isV2BeforeSendSpanCallback,
   mergeScopeData,
   reparentChildSpans,
@@ -18,7 +16,6 @@ import {
   SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME,
   SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION,
   SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME,
-  SEMANTIC_ATTRIBUTE_URL_FULL,
   SEMANTIC_ATTRIBUTE_USER_EMAIL,
   SEMANTIC_ATTRIBUTE_USER_ID,
   SEMANTIC_ATTRIBUTE_USER_IP_ADDRESS,
@@ -28,7 +25,6 @@ import {
   spanToV2JSON,
 } from '@sentry/core';
 import { DEBUG_BUILD } from '../debug-build';
-import { getHttpRequestData } from '../helpers';
 
 export interface SpanStreamingOptions {
   batchLimit: number;
@@ -110,7 +106,7 @@ interface SpanProcessingOptions {
  * Just the traceid alone isn't enough because there can be multiple span trees with the same traceid.
  */
 function getSpanTreeMapKey(span: Span): string {
-  return `${span.spanContext().traceId}-${getSegmentSpan(span).spanContext().spanId}`;
+  return `${span.spanContext().traceId}-${INTERNAL_getSegmentSpan(span).spanContext().spanId}`;
 }
 
 function processAndSendSpans(
@@ -132,10 +128,6 @@ function processAndSendSpans(
     applyCommonSpanAttributes(span, segmentSpanJson, client);
   }
 
-  applyScopeToSegmentSpan(segmentSpan, segmentSpanJson, client);
-
-  // TODO: Apply scope data and contexts to segment span
-
   const { ignoreSpans } = client.getOptions();
 
   // 1. Check if the entire span tree is ignored by ignoreSpans
@@ -166,6 +158,7 @@ function processAndSendSpans(
     }
 
     // 3. Apply beforeSendSpan callback
+    // TODO: validate beforeSendSpan result/pass in a copy and merge afterwards
     const processedSpan = beforeSendSpan ? applyBeforeSendSpanCallback(span, beforeSendSpan) : span;
     processedSpans.push(processedSpan);
   }
@@ -224,38 +217,6 @@ function applyCommonSpanAttributes(span: Span, serializedSegmentSpan: SpanV2JSON
   });
 }
 
-/**
- * Adds span attributes from the scopes' contexts
- * TODO: It's not set in stone yet if we actually want to flatmap contexts into span attributes.
- * For now we do it but not yet extra or tags. It's still TBD how to proceed here.
- */
-function applyScopeToSegmentSpan(segmentSpan: Span, serializedSegmentSpan: SpanV2JSON, client: Client): void {
-  const { isolationScope, scope } = getCapturedScopesOnSpan(segmentSpan);
-  const finalScopeData = getFinalScopeData(isolationScope, scope);
-
-  const browserRequestData = getHttpRequestData();
-
-  const tags = finalScopeData.tags ?? {};
-
-  let contextAttributes = {};
-  Object.keys(finalScopeData.contexts).forEach(key => {
-    const context = finalScopeData.contexts[key];
-    if (context) {
-      contextAttributes = { ...contextAttributes, ...attributesFromObject(context) };
-    }
-  });
-
-  const extraAttributes = attributesFromObject(finalScopeData.extra);
-
-  setAttributesIfNotPresent(segmentSpan, Object.keys(serializedSegmentSpan.attributes ?? {}), {
-    [SEMANTIC_ATTRIBUTE_URL_FULL]: browserRequestData.url,
-    ...httpHeadersToSpanAttributes(browserRequestData.headers, client.getOptions().sendDefaultPii ?? false),
-    ...tags,
-    ...contextAttributes,
-    ...extraAttributes,
-  });
-}
-
 function applyBeforeSendSpanCallback(span: SpanV2JSON, beforeSendSpan: (span: SpanV2JSON) => SpanV2JSON): SpanV2JSON {
   const modifedSpan = beforeSendSpan(span);
   if (!modifedSpan) {

packages/core/src/index.ts

@@ -76,7 +76,7 @@ export {
   getSpanDescendants,
   getStatusMessage,
   getRootSpan,
-  getSegmentSpan,
+  INTERNAL_getSegmentSpan,
   getActiveSpan,
   addChildSpanToSpan,
   spanTimeInputToSeconds,

packages/core/src/tracing/sentrySpan.ts

@@ -263,7 +263,7 @@ export class SentrySpan implements Span {
       start_timestamp: this._startTime,
       // just in case _endTime is not set, we use the start time (i.e. duration 0)
       end_timestamp: this._endTime ?? this._startTime,
-      is_remote: false, // TODO: This has to be inferred from attributes SentrySpans. `false` is the default.
+      is_segment: this._isStandaloneSpan || this === getRootSpan(this),
       kind: 'internal', // TODO: This has to be inferred from attributes SentrySpans. `internal` is the default.
       status: getV2StatusMessage(this._status),
       attributes: getV2Attributes(this._attributes),

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

@@ -44,7 +44,7 @@ export interface SpanV2JSON {
   end_timestamp: number;
   status: 'ok' | 'error';
   kind: 'server' | 'client' | 'internal' | 'consumer' | 'producer';
-  is_remote: boolean;
+  is_segment: boolean;
   attributes?: SerializedAttributes;
   links?: SpanLinkJSON<SerializedAttributes>[];
 }

packages/core/src/utils/spanUtils.ts

@@ -216,7 +216,7 @@ export function spanToV2JSON(span: Span): SpanV2JSON {
     return span.getSpanV2JSON();
   }
 
-  const { spanId: span_id, traceId: trace_id, isRemote } = span.spanContext();
+  const { spanId: span_id, traceId: trace_id } = span.spanContext();
 
   // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
   if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
@@ -240,7 +240,7 @@ export function spanToV2JSON(span: Span): SpanV2JSON {
       parent_span_id: parentSpanId,
       start_timestamp: spanTimeInputToSeconds(startTime),
       end_timestamp: spanTimeInputToSeconds(endTime),
-      is_remote: isRemote || false,
+      is_segment: span === INTERNAL_getSegmentSpan(span),
       kind: 'internal', // TODO: Figure out how to get this from the OTel span as it's not publicly exposed
       status: getV2StatusMessage(status),
       attributes: getV2Attributes(attributes),
@@ -258,7 +258,7 @@ export function spanToV2JSON(span: Span): SpanV2JSON {
     end_timestamp: 0,
     status: 'ok',
     kind: 'internal',
-    is_remote: isRemote || false,
+    is_segment: span === INTERNAL_getSegmentSpan(span),
   };
 }
 
@@ -394,12 +394,12 @@ export function getSpanDescendants(span: SpanWithPotentialChildren): Span[] {
 /**
  * Returns the root span of a given span.
  */
-export const getRootSpan = getSegmentSpan;
+export const getRootSpan = INTERNAL_getSegmentSpan;
 
 /**
  * Returns the segment span of a given span.
  */
-export function getSegmentSpan(span: SpanWithPotentialChildren): Span {
+export function INTERNAL_getSegmentSpan(span: SpanWithPotentialChildren): Span {
   return span[ROOT_SPAN_FIELD] || span;
 }