feat(core): Ensure url, http.query and http.fragment are directly added

Author: mydea

packages/core/src/fetch.ts

@@ -1,4 +1,11 @@
-import { HTTP_URL, URL_FULL } from '@sentry/conventions/attributes';
+import {
+  HTTP_FRAGMENT,
+  HTTP_METHOD,
+  HTTP_QUERY,
+  HTTP_URL,
+  SERVER_ADDRESS,
+  URL_FULL,
+} from '@sentry/conventions/attributes';
 import { getClient } from './currentScopes';
 import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from './semanticAttributes';
 import { setHttpStatus, SPAN_STATUS_ERROR, spanIsIgnored, startInactiveSpan } from './tracing';
@@ -387,7 +394,7 @@ function getFetchSpanAttributes(
   const attributes: SpanAttributes = {
     url: stripDataUrlContent(url),
     type: 'fetch',
-    'http.method': method,
+    [HTTP_METHOD]: method,
     [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
     [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.client',
   };
@@ -396,13 +403,13 @@ function getFetchSpanAttributes(
       // oxlint-disable-next-line typescript/no-deprecated
       attributes[HTTP_URL] = stripDataUrlContent(parsedUrl.href);
       attributes[URL_FULL] = stripDataUrlContent(parsedUrl.href);
-      attributes['server.address'] = parsedUrl.host;
+      attributes[SERVER_ADDRESS] = parsedUrl.host;
     }
     if (parsedUrl.search) {
-      attributes['http.query'] = parsedUrl.search;
+      attributes[HTTP_QUERY] = parsedUrl.search.slice(1) || undefined;
     }
     if (parsedUrl.hash) {
-      attributes['http.fragment'] = parsedUrl.hash;
+      attributes[HTTP_FRAGMENT] = parsedUrl.hash.slice(1) || undefined;
     }
   }
   return attributes;

packages/core/src/integrations/http/add-outgoing-request-breadcrumb.ts

@@ -24,8 +24,8 @@ export function addOutgoingRequestBreadcrumb(
         status_code: statusCode,
         url: getSanitizedUrlString(parsedUrl),
         'http.method': request.method || 'GET',
-        ...(parsedUrl.search ? { 'http.query': parsedUrl.search } : {}),
-        ...(parsedUrl.hash ? { 'http.fragment': parsedUrl.hash } : {}),
+        ...(parsedUrl.search ? { 'http.query': parsedUrl.search.slice(1) || undefined } : {}),
+        ...(parsedUrl.hash ? { 'http.fragment': parsedUrl.hash.slice(1) || undefined } : {}),
       },
       type: 'http',
       level,

packages/core/src/utils/url.ts

@@ -1,4 +1,17 @@
-import { URL_FULL } from '@sentry/conventions/attributes';
+import {
+  HTTP_FRAGMENT,
+  HTTP_QUERY,
+  HTTP_ROUTE,
+  SERVER_ADDRESS,
+  URL_DOMAIN,
+  URL_FRAGMENT,
+  URL_FULL,
+  URL_PATH,
+  URL_PORT,
+  URL_QUERY,
+  URL_SCHEME,
+  URL_TEMPLATE,
+} from '@sentry/conventions/attributes';
 import {
   SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
@@ -165,7 +178,7 @@ export function getHttpSpanDetailsFromUrlObject(
 
   if (routeName) {
     // This is based on https://opentelemetry.io/docs/specs/semconv/http/http-spans/#name
-    attributes[kind === 'server' ? 'http.route' : 'url.template'] = routeName;
+    attributes[kind === 'server' ? HTTP_ROUTE : URL_TEMPLATE] = routeName;
     attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
   }
 
@@ -175,13 +188,19 @@ export function getHttpSpanDetailsFromUrlObject(
 
   if (urlObject) {
     if (urlObject.search) {
-      attributes['url.query'] = urlObject.search;
+      const query = urlObject.search.slice(1) || undefined;
+      attributes[URL_QUERY] = query;
+      // legacy attribute
+      attributes[HTTP_QUERY] = query;
     }
     if (urlObject.hash) {
-      attributes['url.fragment'] = urlObject.hash;
+      const fragment = urlObject.hash.slice(1) || undefined;
+      attributes[URL_FRAGMENT] = fragment;
+      // legacy attribute
+      attributes[HTTP_FRAGMENT] = fragment;
     }
     if (urlObject.pathname) {
-      attributes['url.path'] = urlObject.pathname;
+      attributes[URL_PATH] = urlObject.pathname;
       if (urlObject.pathname === '/') {
         attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
       }
@@ -190,14 +209,15 @@ export function getHttpSpanDetailsFromUrlObject(
     if (!isURLObjectRelative(urlObject)) {
       attributes[URL_FULL] = urlObject.href;
       if (urlObject.port) {
-        attributes['url.port'] = urlObject.port;
+        attributes[URL_PORT] = urlObject.port;
       }
       if (urlObject.protocol) {
-        attributes['url.scheme'] = urlObject.protocol;
+        attributes[URL_SCHEME] = urlObject.protocol;
       }
       if (urlObject.hostname) {
-        attributes[kind === 'server' ? 'server.address' : 'url.domain'] = urlObject.hostname;
+        attributes[kind === 'server' ? SERVER_ADDRESS : URL_DOMAIN] = urlObject.hostname;
       }
+      attributes['url'] = getSanitizedUrlStringFromUrlObject(urlObject);
     }
   }
 

packages/node/src/integrations/http/httpServerSpansIntegration.ts

@@ -7,8 +7,10 @@ import { RPCType, setRPCMetadata } from '@opentelemetry/core';
 import {
   HTTP_CLIENT_IP,
   HTTP_FLAVOR,
+  HTTP_FRAGMENT,
   HTTP_HOST,
   HTTP_METHOD,
+  HTTP_QUERY,
   HTTP_RESPONSE_STATUS_CODE,
   HTTP_ROUTE,
   HTTP_SCHEME,
@@ -51,6 +53,7 @@ import {
   bindScopeToEmitter,
   startInactiveSpan,
   withActiveSpan,
+  getSanitizedUrlStringFromUrlObject,
   SPAN_KIND,
 } from '@sentry/core';
 import { DEBUG_BUILD } from '../../debug-build';
@@ -152,6 +155,7 @@ const _httpServerSpansIntegration = ((options: HttpServerSpansIntegrationOptions
 
           const fullUrl = normalizedRequest.url || request.url || '/';
           const urlObj = parseStringToURLObject(fullUrl);
+          const sanitizedUrl = urlObj ? getSanitizedUrlStringFromUrlObject(urlObj) : undefined;
 
           const headers = request.headers;
           const userAgent = headers['user-agent'];
@@ -166,6 +170,9 @@ const _httpServerSpansIntegration = ((options: HttpServerSpansIntegrationOptions
           const httpTargetWithoutQueryFragment = urlObj ? urlObj.pathname : stripUrlQueryAndFragment(fullUrl);
           const bestEffortTransactionName = `${method} ${httpTargetWithoutQueryFragment}`;
 
+          const query = urlObj?.search ? urlObj.search.slice(1) || undefined : undefined;
+          const fragment = urlObj?.hash ? urlObj.hash.slice(1) || undefined : undefined;
+
           const span = startInactiveSpan({
             name: bestEffortTransactionName,
             kind: SPAN_KIND.SERVER,
@@ -179,7 +186,10 @@ const _httpServerSpansIntegration = ((options: HttpServerSpansIntegrationOptions
               // Old Semantic Conventions attributes - added for compatibility with what `@opentelemetry/instrumentation-http` output before
               /* eslint-disable typescript/no-deprecated */
               [HTTP_URL]: fullUrl,
+              url: sanitizedUrl,
               [HTTP_METHOD]: normalizedRequest.method,
+              [HTTP_QUERY]: query,
+              [HTTP_FRAGMENT]: fragment,
               [HTTP_TARGET]: urlObj ? `${urlObj.pathname}${urlObj.search}` : httpTargetWithoutQueryFragment,
               [HTTP_HOST]: host,
               [NET_HOST_NAME]: hostname,

packages/node/src/integrations/node-fetch/undici-instrumentation.ts

@@ -215,6 +215,7 @@ function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage)
     // Skip instrumenting this request.
     return;
   }
+
   const urlScheme = requestUrl.protocol.replace(':', '');
   const requestMethod = getRequestMethod(request.method);
   const attributes: SpanAttributes = {