ref: better tree shaking...

mydea · mydea · commit 5c780a3d221e · 2024-04-03T16:27:00.000+02:00
diff --git a/packages/angular/src/sdk.ts b/packages/angular/src/sdk.ts
@@ -12,7 +12,6 @@ import {
   dedupeIntegration,
   functionToStringIntegration,
   inboundFiltersIntegration,
-  spanLoggerIntegration,
 } from '@sentry/core';
 import type { Integration } from '@sentry/types';
 import { logger } from '@sentry/utils';
@@ -31,7 +30,7 @@ export function getDefaultIntegrations(): Integration[] {
   // see:
   //  - https://github.com/getsentry/sentry-javascript/issues/5417#issuecomment-1453407097
   //  - https://github.com/getsentry/sentry-javascript/issues/2744
-  const integrations: Integration[] = [
+  return [
     inboundFiltersIntegration(),
     functionToStringIntegration(),
     breadcrumbsIntegration(),
@@ -40,12 +39,6 @@ export function getDefaultIntegrations(): Integration[] {
     dedupeIntegration(),
     httpContextIntegration(),
   ];
-
-  if (IS_DEBUG_BUILD) {
-    integrations.push(spanLoggerIntegration());
-  }
-
-  return integrations;
 }
 
 /**
diff --git a/packages/aws-serverless/src/index.ts b/packages/aws-serverless/src/index.ts
@@ -99,7 +99,6 @@ export {
   extraErrorDataIntegration,
   rewriteFramesIntegration,
   sessionTimingIntegration,
-  spanLoggerIntegration,
 } from '@sentry/core';
 
 export { getDefaultIntegrations, init, tryPatchHandler, wrapHandler } from './awslambda';
diff --git a/packages/browser/src/index.ts b/packages/browser/src/index.ts
@@ -10,7 +10,6 @@ export {
   extraErrorDataIntegration,
   rewriteFramesIntegration,
   sessionTimingIntegration,
-  spanLoggerIntegration,
 } from '@sentry/core';
 
 export {
diff --git a/packages/browser/src/sdk.ts b/packages/browser/src/sdk.ts
@@ -1,4 +1,4 @@
-import { getCurrentScope, spanLoggerIntegration } from '@sentry/core';
+import { getCurrentScope } from '@sentry/core';
 import { functionToStringIntegration, inboundFiltersIntegration } from '@sentry/core';
 import {
   captureSession,
@@ -36,7 +36,7 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
    * Note: Please make sure this stays in sync with Angular SDK, which re-exports
    * `getDefaultIntegrations` but with an adjusted set of integrations.
    */
-  const integrations: Integration[] = [
+  return [
     inboundFiltersIntegration(),
     functionToStringIntegration(),
     browserApiErrorsIntegration(),
@@ -46,12 +46,6 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
     dedupeIntegration(),
     httpContextIntegration(),
   ];
-
-  if (DEBUG_BUILD) {
-    integrations.push(spanLoggerIntegration());
-  }
-
-  return integrations;
 }
 
 function applyDefaultOptions(optionsArg: BrowserOptions = {}): BrowserOptions {
diff --git a/packages/bun/src/index.ts b/packages/bun/src/index.ts
@@ -120,7 +120,6 @@ export {
   extraErrorDataIntegration,
   rewriteFramesIntegration,
   sessionTimingIntegration,
-  spanLoggerIntegration,
 } from '@sentry/core';
 
 export type { BunOptions } from './types';
diff --git a/packages/bun/src/sdk.ts b/packages/bun/src/sdk.ts
@@ -3,7 +3,6 @@ import {
   inboundFiltersIntegration,
   linkedErrorsIntegration,
   requestDataIntegration,
-  spanLoggerIntegration,
 } from '@sentry/core';
 import {
   consoleIntegration,
@@ -30,7 +29,6 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
     functionToStringIntegration(),
     linkedErrorsIntegration(),
     requestDataIntegration(),
-    spanLoggerIntegration(),
     // Native Wrappers
     consoleIntegration(),
     httpIntegration(),
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -99,7 +99,6 @@ export { dedupeIntegration } from './integrations/dedupe';
 export { extraErrorDataIntegration } from './integrations/extraerrordata';
 export { rewriteFramesIntegration } from './integrations/rewriteframes';
 export { sessionTimingIntegration } from './integrations/sessiontiming';
-export { spanLoggerIntegration } from './integrations/spanlogger';
 export { metrics } from './metrics/exports';
 export type { MetricData } from './metrics/exports';
 export { metricsDefault } from './metrics/exports-default';
diff --git a/packages/core/src/integrations/spanlogger.ts b/packages/core/src/integrations/spanlogger.ts
diff --git a/packages/core/src/tracing/index.ts b/packages/core/src/tracing/index.ts
@@ -18,3 +18,4 @@ export {
 export { getDynamicSamplingContextFromClient, getDynamicSamplingContextFromSpan } from './dynamicSamplingContext';
 export { setMeasurement } from './measurement';
 export { sampleSpan } from './sampling';
+export { logSpanEnd, logSpanStart } from './logSpans';
diff --git a/packages/core/src/tracing/logSpans.ts b/packages/core/src/tracing/logSpans.ts
@@ -0,0 +1,55 @@
+import type { Span } from '@sentry/types';
+import { logger } from '@sentry/utils';
+import { DEBUG_BUILD } from '../debug-build';
+import { getRootSpan, spanIsSampled, spanToJSON } from '../utils/spanUtils';
+
+/**
+ * Print a log message for a started span.
+ */
+export function logSpanStart(span: Span): void {
+  if (!DEBUG_BUILD) return;
+
+  const { description = '< unknown name >', op = '< unknown op >', parent_span_id: parentSpanId } = spanToJSON(span);
+  const { spanId } = span.spanContext();
+
+  const sampled = spanIsSampled(span);
+  const rootSpan = getRootSpan(span);
+  const isRootSpan = rootSpan === span;
+
+  const header = `[Tracing] Starting ${sampled ? 'sampled' : 'unsampled'} ${isRootSpan ? 'root ' : ''}span`;
+
+  const infoParts: string[] = [`op: ${op}`, `name: ${description}`, `ID: ${spanId}`];
+
+  if (parentSpanId) {
+    infoParts.push(`parent ID: ${parentSpanId}`);
+  }
+
+  if (!isRootSpan) {
+    const { op, description } = spanToJSON(rootSpan);
+    infoParts.push(`root ID: ${rootSpan.spanContext().spanId}`);
+    if (op) {
+      infoParts.push(`root op: ${op}`);
+    }
+    if (description) {
+      infoParts.push(`root description: ${description}`);
+    }
+  }
+
+  logger.log(`${header}
+  ${infoParts.join('\n  ')}`);
+}
+
+/**
+ * Print a log message for an ended span.
+ */
+export function logSpanEnd(span: Span): void {
+  if (!DEBUG_BUILD) return;
+
+  const { description = '< unknown name >', op = '< unknown op >' } = spanToJSON(span);
+  const { spanId } = span.spanContext();
+  const rootSpan = getRootSpan(span);
+  const isRootSpan = rootSpan === span;
+
+  const msg = `[Tracing] Finishing "${op}" ${isRootSpan ? 'root ' : ''}span "${description}" with ID ${spanId}`;
+  logger.log(msg);
+}
diff --git a/packages/core/src/tracing/sentrySpan.ts b/packages/core/src/tracing/sentrySpan.ts
@@ -14,13 +14,8 @@ import { getClient } from '../currentScopes';
 
 import { getMetricSummaryJsonForSpan } from '../metrics/metric-summary';
 import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '../semanticAttributes';
-import {
-  TRACE_FLAG_NONE,
-  TRACE_FLAG_SAMPLED,
-  getStatusMessage,
-  spanTimeInputToSeconds,
-  spanToJSON,
-} from '../utils/spanUtils';
+import { TRACE_FLAG_NONE, TRACE_FLAG_SAMPLED, getStatusMessage, spanTimeInputToSeconds } from '../utils/spanUtils';
+import { logSpanEnd } from './logSpans';
 
 /**
  * Span contains all data about a span
@@ -133,6 +128,7 @@ export class SentrySpan implements Span {
     }
 
     this._endTime = spanTimeInputToSeconds(endTimestamp);
+    logSpanEnd(this);
 
     this._onSpanEnded();
   }
diff --git a/packages/core/src/tracing/trace.ts b/packages/core/src/tracing/trace.ts
@@ -26,6 +26,7 @@ import {
   spanToJSON,
 } from '../utils/spanUtils';
 import { getDynamicSamplingContextFromSpan } from './dynamicSamplingContext';
+import { logSpanStart } from './logSpans';
 import { sampleSpan } from './sampling';
 import { SentryNonRecordingSpan } from './sentryNonRecordingSpan';
 import { SentrySpan } from './sentrySpan';
@@ -269,6 +270,8 @@ function createChildSpanOrTransaction({
     });
   }
 
+  logSpanStart(span);
+
   // TODO v8: Technically `startTransaction` can return undefined, which is not reflected by the types
   // This happens if tracing extensions have not been added
   // In this case, we just want to return a non-recording span
diff --git a/packages/deno/src/index.ts b/packages/deno/src/index.ts
@@ -68,7 +68,6 @@ export {
   extraErrorDataIntegration,
   rewriteFramesIntegration,
   sessionTimingIntegration,
-  spanLoggerIntegration,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
diff --git a/packages/deno/src/sdk.ts b/packages/deno/src/sdk.ts
@@ -1,5 +1,4 @@
 import type { ServerRuntimeClientOptions } from '@sentry/core';
-import { spanLoggerIntegration } from '@sentry/core';
 import {
   dedupeIntegration,
   functionToStringIntegration,
@@ -28,7 +27,6 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
     functionToStringIntegration(),
     linkedErrorsIntegration(),
     dedupeIntegration(),
-    spanLoggerIntegration(),
     // Deno Specific
     breadcrumbsIntegration(),
     denoContextIntegration(),
diff --git a/packages/google-cloud-serverless/src/index.ts b/packages/google-cloud-serverless/src/index.ts
@@ -99,7 +99,6 @@ export {
   extraErrorDataIntegration,
   rewriteFramesIntegration,
   sessionTimingIntegration,
-  spanLoggerIntegration,
 } from '@sentry/core';
 
 export { getDefaultIntegrations, init } from './sdk';
diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts
@@ -93,7 +93,6 @@ export {
   extraErrorDataIntegration,
   rewriteFramesIntegration,
   sessionTimingIntegration,
-  spanLoggerIntegration,
   metricsDefault as metrics,
   startSession,
   captureSession,
diff --git a/packages/node/src/sdk/init.ts b/packages/node/src/sdk/init.ts
@@ -9,7 +9,6 @@ import {
   inboundFiltersIntegration,
   linkedErrorsIntegration,
   requestDataIntegration,
-  spanLoggerIntegration,
   startSession,
 } from '@sentry/core';
 import { openTelemetrySetupCheck, setOpenTelemetryContextAsyncContextStrategy } from '@sentry/opentelemetry';
@@ -52,7 +51,6 @@ export function getDefaultIntegrations(options: Options): Integration[] {
     functionToStringIntegration(),
     linkedErrorsIntegration(),
     requestDataIntegration(),
-    spanLoggerIntegration(),
     // Native Wrappers
     consoleIntegration(),
     httpIntegration(),
diff --git a/packages/opentelemetry/src/spanProcessor.ts b/packages/opentelemetry/src/spanProcessor.ts
@@ -1,7 +1,14 @@
 import type { Context } from '@opentelemetry/api';
 import { ROOT_CONTEXT, trace } from '@opentelemetry/api';
 import type { ReadableSpan, Span, SpanProcessor as SpanProcessorInterface } from '@opentelemetry/sdk-trace-base';
-import { addChildSpanToSpan, getClient, getDefaultCurrentScope, getDefaultIsolationScope } from '@sentry/core';
+import {
+  addChildSpanToSpan,
+  getClient,
+  getDefaultCurrentScope,
+  getDefaultIsolationScope,
+  logSpanEnd,
+  logSpanStart,
+} from '@sentry/core';
 import { SEMANTIC_ATTRIBUTE_SENTRY_PARENT_IS_REMOTE } from './semanticAttributes';
 import { SentrySpanExporter } from './spanExporter';
 import { getScopesFromContext } from './utils/contextData';
@@ -38,13 +45,17 @@ function onSpanStart(span: Span, parentContext: Context): void {
     setSpanScopes(span, scopes);
   }
 
+  logSpanStart(span);
+
   const client = getClient();
   client?.emit('spanStart', span);
 }
 
-function onSpanEnd(span: ReadableSpan): void {
+function onSpanEnd(span: Span): void {
+  logSpanEnd(span);
+
   const client = getClient();
-  client?.emit('spanEnd', span as Span);
+  client?.emit('spanEnd', span);
 }
 
 /**
@@ -81,7 +92,7 @@ export class SentrySpanProcessor implements SpanProcessorInterface {
   }
 
   /** @inheritDoc */
-  public onEnd(span: ReadableSpan): void {
+  public onEnd(span: Span & ReadableSpan): void {
     onSpanEnd(span);
 
     this._exporter.export(span);
diff --git a/packages/vercel-edge/src/sdk.ts b/packages/vercel-edge/src/sdk.ts
@@ -5,7 +5,6 @@ import {
   initAndBind,
   linkedErrorsIntegration,
   requestDataIntegration,
-  spanLoggerIntegration,
 } from '@sentry/core';
 import type { Integration, Options } from '@sentry/types';
 import { GLOBAL_OBJ, createStackParser, nodeStackLineParser, stackParserFromStackParserOptions } from '@sentry/utils';
@@ -28,7 +27,6 @@ export function getDefaultIntegrations(options: Options): Integration[] {
   return [
     inboundFiltersIntegration(),
     functionToStringIntegration(),
-    spanLoggerIntegration(),
     linkedErrorsIntegration(),
     winterCGFetchIntegration(),
     ...(options.sendDefaultPii ? [requestDataIntegration()] : []),
