apply common attributes

Author: Lms24

.size-limit.js

@@ -40,6 +40,13 @@ module.exports = [
     gzip: true,
     limit: '41 KB',
   },
+  {
+    name: '@sentry/browser (incl. Tracing with Span Streaming)',
+    path: 'packages/browser/build/npm/esm/index.js',
+    import: createImport('init', 'browserTracingIntegration', 'spanStreamingIntegration'),
+    gzip: true,
+    limit: '41.5 KB',
+  },
   {
     name: '@sentry/browser (incl. Tracing, Replay)',
     path: 'packages/browser/build/npm/esm/index.js',

packages/browser/src/integrations/spanstreaming.ts

@@ -1,12 +1,24 @@
-import type { Client, IntegrationFn, Span, SpanV2JSON } from '@sentry/core';
+import type { Client, IntegrationFn, Span, SpanAttributes, SpanAttributeValue, SpanV2JSON } from '@sentry/core';
 import {
   createSpanV2Envelope,
   debug,
   defineIntegration,
+  getCapturedScopesOnSpan,
   getDynamicSamplingContextFromSpan,
+  getGlobalScope,
   getRootSpan as getSegmentSpan,
   isV2BeforeSendSpanCallback,
+  mergeScopeData,
   reparentChildSpans,
+  SEMANTIC_ATTRIBUTE_SENTRY_ENVIRONMENT,
+  SEMANTIC_ATTRIBUTE_SENTRY_RELEASE,
+  SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME,
+  SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION,
+  SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME,
+  SEMANTIC_ATTRIBUTE_USER_EMAIL,
+  SEMANTIC_ATTRIBUTE_USER_ID,
+  SEMANTIC_ATTRIBUTE_USER_IP_ADDRESS,
+  SEMANTIC_ATTRIBUTE_USER_USERNAME,
   shouldIgnoreSpan,
   showSpanDropWarning,
   spanToV2JSON,
@@ -91,6 +103,9 @@ interface SpanProcessingOptions {
   beforeSendSpan: ((span: SpanV2JSON) => SpanV2JSON) | undefined;
 }
 
+/**
+ * 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}`;
 }
@@ -107,13 +122,17 @@ function processAndSendSpans(
     spanTreeMap.delete(spanTreeMapKey);
     return;
   }
+  const segmentSpanJson = spanToV2JSON(segmentSpan);
 
-  const { ignoreSpans } = client.getOptions();
+  for (const span of spansOfTrace) {
+    applyCommonSpanAttributes(span, segmentSpanJson, client);
+  }
 
-  // TODO: Apply scopes to spans
+  // TODO: Apply scope data and contexts to segment span
+
+  const { ignoreSpans } = client.getOptions();
 
   // 1. Check if the entire span tree is ignored by ignoreSpans
-  const segmentSpanJson = spanToV2JSON(segmentSpan);
   if (ignoreSpans?.length && shouldIgnoreSpan(segmentSpanJson, ignoreSpans)) {
     client.recordDroppedEvent('before_send', 'span', spansOfTrace.size);
     spanTreeMap.delete(spanTreeMapKey);
@@ -166,6 +185,41 @@ function processAndSendSpans(
   spanTreeMap.delete(spanTreeMapKey);
 }
 
+function applyCommonSpanAttributes(span: Span, serializedSegmentSpan: SpanV2JSON, client: Client): void {
+  const sdk = client.getSdkMetadata();
+  const { release, environment, sendDefaultPii } = client.getOptions();
+
+  const { isolationScope: spanIsolationScope, scope: spanScope } = getCapturedScopesOnSpan(span);
+
+  const originalAttributeKeys = Object.keys(spanToV2JSON(span).attributes ?? {});
+
+  // TODO: Extract this scope data merge to a helper in core. It's used in multiple places.
+  const finalScopeData = getGlobalScope().getScopeData();
+  if (spanIsolationScope) {
+    mergeScopeData(finalScopeData, spanIsolationScope.getScopeData());
+  }
+  if (spanScope) {
+    mergeScopeData(finalScopeData, spanScope.getScopeData());
+  }
+
+  // avoid overwriting any previously set attributes (from users or potentially our SDK instrumentation)
+  setAttributesIfNotPresent(span, originalAttributeKeys, {
+    [SEMANTIC_ATTRIBUTE_SENTRY_RELEASE]: release,
+    [SEMANTIC_ATTRIBUTE_SENTRY_ENVIRONMENT]: environment,
+    [SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME]: serializedSegmentSpan.name,
+    [SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME]: sdk?.sdk?.name,
+    [SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION]: sdk?.sdk?.version,
+    ...(sendDefaultPii
+      ? {
+          [SEMANTIC_ATTRIBUTE_USER_ID]: finalScopeData.user?.id,
+          [SEMANTIC_ATTRIBUTE_USER_EMAIL]: finalScopeData.user?.email,
+          [SEMANTIC_ATTRIBUTE_USER_IP_ADDRESS]: finalScopeData.user?.ip_address ?? undefined,
+          [SEMANTIC_ATTRIBUTE_USER_USERNAME]: finalScopeData.user?.username,
+        }
+      : {}),
+  });
+}
+
 function applyBeforeSendSpanCallback(span: SpanV2JSON, beforeSendSpan: (span: SpanV2JSON) => SpanV2JSON): SpanV2JSON {
   const modifedSpan = beforeSendSpan(span);
   if (!modifedSpan) {
@@ -174,3 +228,11 @@ function applyBeforeSendSpanCallback(span: SpanV2JSON, beforeSendSpan: (span: Sp
   }
   return modifedSpan;
 }
+
+function setAttributesIfNotPresent(span: Span, originalAttributeKeys: string[], newAttributes: SpanAttributes): void {
+  Object.keys(newAttributes).forEach(key => {
+    if (!originalAttributeKeys.includes(key)) {
+      span.setAttribute(key, newAttributes[key]);
+    }
+  });
+}

packages/core/src/semanticAttributes.ts

@@ -77,3 +77,33 @@ export const SEMANTIC_ATTRIBUTE_URL_FULL = 'url.full';
  * @see https://develop.sentry.dev/sdk/telemetry/traces/span-links/#link-types
  */
 export const SEMANTIC_LINK_ATTRIBUTE_LINK_TYPE = 'sentry.link.type';
+
+// some attributes for now exclusively used for span streaming
+// @see https://develop.sentry.dev/sdk/telemetry/spans/span-protocol/#common-attribute-keys
+
+/** The release version of the application */
+export const SEMANTIC_ATTRIBUTE_SENTRY_RELEASE = 'sentry.release';
+/** The environment name (e.g., "production", "staging", "development") */
+export const SEMANTIC_ATTRIBUTE_SENTRY_ENVIRONMENT = 'sentry.environment';
+/** The segment name (e.g., "GET /users") */
+export const SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME = 'sentry.segment_name';
+/** The operating system name (e.g., "Linux", "Windows", "macOS") */
+export const SEMANTIC_ATTRIBUTE_OS_NAME = 'os.name';
+/** The browser name (e.g., "Chrome", "Firefox", "Safari") */
+export const SEMANTIC_ATTRIBUTE_BROWSER_VERSION = 'browser.name';
+/** The user ID (gated by sendDefaultPii) */
+export const SEMANTIC_ATTRIBUTE_USER_ID = 'user.id';
+/** The user email (gated by sendDefaultPii) */
+export const SEMANTIC_ATTRIBUTE_USER_EMAIL = 'user.email';
+/** The user IP address (gated by sendDefaultPii) */
+export const SEMANTIC_ATTRIBUTE_USER_IP_ADDRESS = 'user.ip_address';
+/** The user username (gated by sendDefaultPii) */
+export const SEMANTIC_ATTRIBUTE_USER_USERNAME = 'user.username';
+/** The thread ID */
+export const SEMANTIC_ATTRIBUTE_THREAD_ID = 'thread.id';
+/** The thread name */
+export const SEMANTIC_ATTRIBUTE_THREAD_NAME = 'thread.name';
+/** The name of the Sentry SDK (e.g., "sentry.php", "sentry.javascript") */
+export const SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME = 'sentry.sdk.name';
+/** The version of the Sentry SDK */
+export const SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION = 'sentry.sdk.version';