fixup! fixup! fixup! fixup! fixup! feat(http): portable node:http client instrumentation (#20393)

Author: isaacs

packages/core/src/index.ts

@@ -147,9 +147,9 @@ export { growthbookIntegration } from './integrations/featureFlags';
 export { conversationIdIntegration } from './integrations/conversationId';
 export { patchHttpModuleClient, patchHttpsModuleClient } from './integrations/http/client-patch';
 export { getHttpClientSubscriptions } from './integrations/http/client-subscriptions';
+export { addOutgoingRequestBreadcrumb } from './integrations/http/add-outgoing-request-breadcrumb';
 export {
   HTTP_ON_CLIENT_REQUEST,
-  HTTP_ON_CLIENT_REQUEST_FALLBACK,
   HTTP_ON_SERVER_REQUEST,
 } from './integrations/http/constants';
 export type {

packages/core/src/integrations/http/constants.ts

@@ -1,7 +1,5 @@
 export const LOG_PREFIX = '@sentry/instrumentation-http';
 export const HTTP_ON_CLIENT_REQUEST = 'http.client.request.created';
-/** Used by node-light SDK to instrument on older node versions */
-export const HTTP_ON_CLIENT_REQUEST_FALLBACK = 'http.client.request.start';
 export const HTTP_ON_SERVER_REQUEST = 'http.server.request.start';
 export type ClientSubscriptionName = typeof HTTP_ON_CLIENT_REQUEST;
 export type ServerSubscriptionName = typeof HTTP_ON_SERVER_REQUEST;

packages/node-core/src/light/integrations/httpIntegration.ts

@@ -1,23 +1,23 @@
 import { subscribe } from 'node:diagnostics_channel';
 import type { RequestOptions } from 'node:http';
-import type { Integration, IntegrationFn } from '@sentry/core';
+import type { HttpClientRequest, HttpIncomingMessage, Integration, IntegrationFn } from '@sentry/core';
 import {
+  addOutgoingRequestBreadcrumb,
   continueTrace,
   debug,
   generateSpanId,
   getCurrentScope,
   getHttpClientSubscriptions,
   getIsolationScope,
   HTTP_ON_CLIENT_REQUEST,
-  HTTP_ON_CLIENT_REQUEST_FALLBACK,
   httpRequestToRequestData,
   stripUrlQueryAndFragment,
   withIsolationScope,
 } from '@sentry/core';
 import type { ClientRequest, IncomingMessage, Server } from 'node:http';
 import { DEBUG_BUILD } from '../../debug-build';
 import { patchRequestToCaptureBody } from '../../utils/captureRequestBody';
-import { getRequestOptions } from '../../utils/outgoingHttpRequest';
+import { getClientRequestUrl, getRequestOptions } from '../../utils/outgoingHttpRequest';
 import type { LightNodeClient } from '../client';
 import { errorMonitor } from 'node:events';
 import { NODE_VERSION } from '../../nodeVersion';
@@ -106,10 +106,6 @@ const _httpIntegration = ((options: HttpIntegrationOptions = {}) => {
 
       const { ignoreOutgoingRequests } = _options;
 
-      const channel = FULLY_SUPPORTS_HTTP_DIAGNOSTICS_CHANNEL
-        ? HTTP_ON_CLIENT_REQUEST
-        : HTTP_ON_CLIENT_REQUEST_FALLBACK;
-
       const { [HTTP_ON_CLIENT_REQUEST]: onHttpClientRequestCreated } = getHttpClientSubscriptions({
         breadcrumbs: _options.breadcrumbs,
         propagateTrace: _options.tracePropagation,
@@ -122,13 +118,52 @@ const _httpIntegration = ((options: HttpIntegrationOptions = {}) => {
       });
 
       subscribe('http.server.request.start', onHttpServerRequestStart);
-      // Subscribe on the request creation in node versions that support it,
-      // or to the request start (ie, .end() being called) on older versions.
-      subscribe(channel, onHttpClientRequestCreated);
+
+      // Subscribe on the request creation in node versions that support it
+      subscribe(HTTP_ON_CLIENT_REQUEST, onHttpClientRequestCreated);
+
+      // fall back to just doing breadcrumbs on the request.end() channel
+      // if we do not have earlier access to the request object at creation
+      // time. The http.client.request.error channel is only available on
+      // the same node versions as client.request.created, so no help.
+      if (_options.breadcrumbs && !FULLY_SUPPORTS_HTTP_DIAGNOSTICS_CHANNEL) {
+        subscribe('http.client.response.finish', (data: unknown) => {
+          const { request, response } = data as {
+            request: HttpClientRequest;
+            response: HttpIncomingMessage;
+          };
+          onOutgoingResponseFinish(request, response, _options);
+        });
+      }
     },
   };
 }) satisfies IntegrationFn;
 
+function onOutgoingResponseFinish(
+  request: HttpClientRequest,
+  response: HttpIncomingMessage | undefined,
+  options: {
+    breadcrumbs: boolean;
+    ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;
+  },
+): void {
+  if (!options.breadcrumbs) {
+    return;
+  }
+  // Check if tracing is suppressed (e.g. for Sentry's own transport requests)
+  if (getCurrentScope().getScopeData().sdkProcessingMetadata.__SENTRY_SUPPRESS_TRACING__) {
+    return;
+  }
+  const { ignoreOutgoingRequests } = options;
+  if (ignoreOutgoingRequests) {
+    const url = getClientRequestUrl(request as ClientRequest);
+    if (ignoreOutgoingRequests(url, getRequestOptions(request as ClientRequest))) {
+      return;
+    }
+  }
+  addOutgoingRequestBreadcrumb(request, response);
+}
+
 /**
  * This integration handles incoming and outgoing HTTP requests in light mode (without OpenTelemetry).
  *