apply data to breadcrumbs

getsentry · Mar 31, 2023 · 51eca27 · 51eca27
1 parent be4699f
commit 51eca27
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 27 deletions.
diff --git a/packages/node/src/integrations/http.ts b/packages/node/src/integrations/http.ts
@@ -1,6 +1,6 @@
 import type { Hub } from '@sentry/core';
 import { getCurrentHub } from '@sentry/core';
-import type { EventProcessor, Integration, RequestSpanData, Span, TracePropagationTargets } from '@sentry/types';
+import type { EventProcessor, Integration, SanitizedRequestData, Span, TracePropagationTargets } from '@sentry/types';
 import {
   dynamicSamplingContextToSentryBaggageHeader,
   fill,
@@ -194,7 +194,7 @@ function _createWrappedRequestMethodFactory(
 
       const scope = getCurrentHub().getScope();
 
-      const requestSpanData: RequestSpanData = {
+      const requestSpanData: SanitizedRequestData = {
         url: requestUrl,
         method: requestOptions.method || 'GET',
       };

diff --git a/packages/sveltekit/src/client/load.ts b/packages/sveltekit/src/client/load.ts
@@ -2,7 +2,7 @@ import type { BaseClient } from '@sentry/core';
 import { getCurrentHub, trace } from '@sentry/core';
 import type { Breadcrumbs, BrowserTracing } from '@sentry/svelte';
 import { captureException } from '@sentry/svelte';
-import type { ClientOptions, RequestSpanData } from '@sentry/types';
+import type { ClientOptions, SanitizedRequestData } from '@sentry/types';
 import {
   addExceptionMechanism,
   addTracingHeadersToFetchRequest,
@@ -170,21 +170,19 @@ function instrumentSvelteKitFetch(originalFetch: SvelteKitFetch): SvelteKitFetch
 
       let fetchPromise: Promise<Response>;
 
-      if (createSpan) {
-        const spanData: RequestSpanData = {
-          url: sanitizedUrl,
-          method,
-          'http.query': urlObject.search,
-          'http.fragment': urlObject.hash,
-        };
+      const spanData: SanitizedRequestData = {
+        url: sanitizedUrl,
+        method,
+        'http.query': urlObject.search,
+        'http.fragment': urlObject.hash,
+      };
 
+      if (createSpan) {
         fetchPromise = trace(
           {
             name: `${method} ${sanitizedUrl}`, // this will become the description of the span
             op: 'http.client',
-            data: {
-              ...spanData,
-            },
+            data: spanData,
             parentSpanId: activeSpan && activeSpan.spanId,
           },
           async span => {
@@ -200,19 +198,18 @@ function instrumentSvelteKitFetch(originalFetch: SvelteKitFetch): SvelteKitFetch
       }
 
       if (shouldAddFetchBreadcrumbs) {
-        addFetchBreadcrumbs(fetchPromise, method, sanitizedUrl, args);
+        addFetchBreadcrumb(fetchPromise, spanData, args);
       }
 
       return fetchPromise;
     },
   });
 }
 
-/* Adds breadcrumbs for the given fetch result */
-function addFetchBreadcrumbs(
+/* Adds a breadcrumb for the given fetch result */
+function addFetchBreadcrumb(
   fetchResult: Promise<Response>,
-  method: string,
-  sanitizedUrl: string,
+  spanData: SanitizedRequestData,
   args: Parameters<SvelteKitFetch>,
 ): void {
   const breadcrumbStartTimestamp = Date.now();
@@ -223,8 +220,7 @@ function addFetchBreadcrumbs(
           type: 'http',
           category: 'fetch',
           data: {
-            method: method,
-            url: sanitizedUrl,
+            ...spanData,
             status_code: response.status,
           },
         },
@@ -242,10 +238,7 @@ function addFetchBreadcrumbs(
           type: 'http',
           category: 'fetch',
           level: 'error',
-          data: {
-            method: method,
-            url: sanitizedUrl,
-          },
+          data: spanData,
         },
         {
           input: args,

diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
@@ -48,7 +48,7 @@ export type { ClientOptions, Options } from './options';
 export type { Package } from './package';
 export type { PolymorphicEvent, PolymorphicRequest } from './polymorphics';
 export type { ReplayEvent, ReplayRecordingData, ReplayRecordingMode } from './replay';
-export type { QueryParams, Request, RequestSpanData } from './request';
+export type { QueryParams, Request, SanitizedRequestData } from './request';
 export type { Runtime } from './runtime';
 export type { CaptureContext, Scope, ScopeContext } from './scope';
 export type { SdkInfo } from './sdkinfo';

diff --git a/packages/types/src/request.ts b/packages/types/src/request.ts
@@ -12,10 +12,11 @@ export interface Request {
 export type QueryParams = string | { [key: string]: string } | Array<[string, string]>;
 
 /**
- * span.data type for http.client spans
+ * Request data that is considered safe for `span.data` on `http.client` spans
+ * and for `http` breadcrumbs
  * See https://develop.sentry.dev/sdk/data-handling/#structuring-data
  */
-export type RequestSpanData = {
+export type SanitizedRequestData = {
   url: string;
   method: string;
   'http.fragment'?: string;