feat(core): Ensure url, http.query and http.fragment are directly added
#22547
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,17 @@ | ||
| 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[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route'; | ||
| } | ||
|
|
||
|
|
@@ -174,14 +187,22 @@ export function getHttpSpanDetailsFromUrlObject( | |
| } | ||
|
|
||
| if (urlObject) { | ||
| attributes['url'] = getSanitizedUrlStringFromUrlObject(urlObject); | ||
|
|
||
| if (urlObject.search) { | ||
| const query = urlObject.search.slice(1) || undefined; | ||
| attributes[URL_QUERY] = query; | ||
| // legacy attribute | ||
| attributes[HTTP_QUERY] = query; | ||
| } | ||
| if (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; | ||
| if (urlObject.pathname === '/') { | ||
| attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route'; | ||
| } | ||
|
|
@@ -190,13 +211,13 @@ export function getHttpSpanDetailsFromUrlObject( | |
| if (!isURLObjectRelative(urlObject)) { | ||
| attributes[URL_FULL] = urlObject.href; | ||
| if (urlObject.port) { | ||
| attributes[URL_PORT] = urlObject.port; | ||
| } | ||
| if (urlObject.protocol) { | ||
| attributes[URL_SCHEME] = urlObject.protocol; | ||
| } | ||
| if (urlObject.hostname) { | ||
| attributes[kind === 'server' ? SERVER_ADDRESS : URL_DOMAIN] = urlObject.hostname; | ||
| } | ||
| } | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -496,8 +496,8 @@ describe('instrumentFetchRequest', () => { | |
| 'http.url': url, | ||
| [URL_FULL]: url, | ||
| 'server.address': 'api.example.com', | ||
| 'http.query': 'include=profile', | ||
| 'http.fragment': 'bio', | ||
| }, | ||
| }); | ||
| }); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -81,7 +81,7 @@ describe('addOutgoingRequestBreadcrumb', () => { | |
|
|
||
| expect(breadcrumbsModule.addBreadcrumb).toHaveBeenCalledWith( | ||
| expect.objectContaining({ | ||
| data: expect.objectContaining({ 'http.query': 'foo=bar' }), | ||
| }), | ||
| expect.anything(), | ||
| ); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -415,6 +415,7 @@ describe('getHttpSpanDetailsFromUrlObject', () => { | |
| 'sentry.origin': 'test-origin', | ||
| 'sentry.source': 'url', | ||
| 'url.path': '/api/users', | ||
| url: '/api/users', | ||
| }); | ||
| }); | ||
|
|
||
|
|
@@ -426,9 +427,12 @@ describe('getHttpSpanDetailsFromUrlObject', () => { | |
| 'sentry.origin': 'test-origin', | ||
| 'sentry.source': 'url', | ||
| 'url.path': '/api/users', | ||
| 'url.query': 'q=test', | ||
| 'url.fragment': 'section', | ||
| 'http.query': 'q=test', | ||
| 'http.fragment': 'section', | ||
| 'url.full': 'https://example.com/api/users?q=test#section', | ||
| url: 'https://example.com/api/users', | ||
| 'server.address': 'example.com', | ||
| 'url.scheme': 'https:', | ||
| }); | ||
|
|
@@ -443,6 +447,7 @@ describe('getHttpSpanDetailsFromUrlObject', () => { | |
| 'sentry.source': 'url', | ||
| 'url.path': '/api/users', | ||
| 'url.full': 'https://example.com/api/users', | ||
| url: 'https://example.com/api/users', | ||
| 'server.address': 'example.com', | ||
| 'url.scheme': 'https:', | ||
| 'http.request.method': 'POST', | ||
|
|
@@ -464,6 +469,7 @@ describe('getHttpSpanDetailsFromUrlObject', () => { | |
| 'sentry.source': 'route', | ||
| 'url.path': '/api/users', | ||
| 'url.full': 'https://example.com/api/users', | ||
| url: 'https://example.com/api/users', | ||
| 'server.address': 'example.com', | ||
| 'url.scheme': 'https:', | ||
| 'http.route': '/api/users/:id', | ||
|
|
@@ -479,6 +485,7 @@ describe('getHttpSpanDetailsFromUrlObject', () => { | |
| 'sentry.source': 'route', | ||
| 'url.path': '/', | ||
| 'url.full': 'https://example.com/', | ||
| url: 'https://example.com/', | ||
| 'server.address': 'example.com', | ||
| 'url.scheme': 'https:', | ||
| }); | ||
|
|
@@ -493,6 +500,7 @@ describe('getHttpSpanDetailsFromUrlObject', () => { | |
| 'sentry.source': 'url', | ||
| 'url.path': '/api/users', | ||
| 'url.full': 'https://example.com:8080/api/users', | ||
| url: 'https://example.com:8080/api/users', | ||
| 'server.address': 'example.com', | ||
| 'url.scheme': 'https:', | ||
| 'url.port': '8080', | ||
|
|
@@ -508,6 +516,7 @@ describe('getHttpSpanDetailsFromUrlObject', () => { | |
| 'sentry.source': 'url', | ||
| 'url.path': '/api/users', | ||
| 'url.full': 'https://example.com:3000/api/users', | ||
| url: 'https://example.com:3000/api/users', | ||
| 'server.address': 'example.com', | ||
| 'url.scheme': 'https:', | ||
| 'url.port': '3000', | ||
|
|
@@ -530,6 +539,7 @@ describe('getHttpSpanDetailsFromUrlObject', () => { | |
| 'sentry.source': 'route', | ||
| 'url.path': '/api/users/123', | ||
| 'url.full': 'https://example.com/api/users/123', | ||
| url: 'https://example.com/api/users/123', | ||
| 'server.address': 'example.com', | ||
| 'url.scheme': 'https:', | ||
| 'http.route': '/api/users/:id', | ||
|
|
@@ -551,8 +561,10 @@ describe('getHttpSpanDetailsFromUrlObject', () => { | |
| 'sentry.origin': 'test-origin', | ||
| 'sentry.source': 'route', | ||
| 'url.path': '/api/search', | ||
| 'url.query': 'q=test&page=1', | ||
| 'http.query': 'q=test&page=1', | ||
| 'url.full': 'https://example.com/api/search?q=test&page=1', | ||
| url: 'https://example.com/api/search', | ||
| 'server.address': 'example.com', | ||
| 'url.scheme': 'https:', | ||
| 'http.route': '/api/search', | ||
|
|
@@ -573,8 +585,10 @@ describe('getHttpSpanDetailsFromUrlObject', () => { | |
| 'sentry.origin': 'test-origin', | ||
| 'sentry.source': 'route', | ||
| 'url.path': '/api/docs', | ||
| 'url.fragment': 'section-1', | ||
| 'http.fragment': 'section-1', | ||
| 'url.full': 'https://example.com/api/docs#section-1', | ||
| url: 'https://example.com/api/docs', | ||
| 'server.address': 'example.com', | ||
| 'url.scheme': 'https:', | ||
| 'http.route': '/api/docs', | ||
|
|
@@ -590,6 +604,7 @@ describe('getHttpSpanDetailsFromUrlObject', () => { | |
| 'sentry.source': 'url', | ||
| 'url.path': '/api/users', | ||
| 'url.full': 'https://user:pass@example.com/api/users', | ||
| url: 'https://%filtered%:%filtered%@example.com/api/users', | ||
| 'server.address': 'example.com', | ||
| 'url.scheme': 'https:', | ||
| }); | ||
|
|
@@ -604,6 +619,7 @@ describe('getHttpSpanDetailsFromUrlObject', () => { | |
| 'sentry.source': 'url', | ||
| 'url.path': '/api/users', | ||
| 'url.full': 'https://192.168.1.1:8080/api/users', | ||
| url: 'https://192.168.1.1:8080/api/users', | ||
| 'server.address': '192.168.1.1', | ||
| 'url.scheme': 'https:', | ||
| 'url.port': '8080', | ||
|
|
@@ -619,6 +635,7 @@ describe('getHttpSpanDetailsFromUrlObject', () => { | |
| 'sentry.source': 'url', | ||
| 'url.path': '/api/users', | ||
| 'url.full': 'https://[2001:db8::1]:8080/api/users', | ||
| url: 'https://[2001:db8::1]:8080/api/users', | ||
| 'server.address': '[2001:db8::1]', | ||
| 'url.scheme': 'https:', | ||
| 'url.port': '8080', | ||
|
|
@@ -634,6 +651,7 @@ describe('getHttpSpanDetailsFromUrlObject', () => { | |
| 'sentry.source': 'url', | ||
| 'url.path': '/users', | ||
| 'url.full': 'https://api.example.com/users', | ||
| url: 'https://api.example.com/users', | ||
| 'server.address': 'api.example.com', | ||
| 'url.scheme': 'https:', | ||
| }); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -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; | ||||||||||
|
Comment on lines
+173
to
+174
Member
There was a problem hiding this comment. Same here
Suggested change
|
||||||||||
|
|
||||||||||
| 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, | ||||||||||
|
|
||||||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Split HTTP query fragment formats
Medium Severity
This commit normalizes
http.queryandhttp.fragmentby stripping leading?and#in core fetch, HTTP breadcrumbs, URL span helpers, and Node server spans, but browser XHR and Node undici fetch breadcrumbs still emit the rawURL.search/URL.hashvalues with those prefixes. The same app can therefore report different query and fragment shapes onhttp.clientspans and HTTP breadcrumbs depending on the API used.Reviewed by Cursor Bugbot for commit d6bc9b0. Configure here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Confirmed. Need to update the following as well to match:
Also found these:
Also, there are
TODO(v11)comments about this in packages/opentelemetry/src/utils/parseSpanDescription.ts line 202 and packages/opentelemetry/src/spanExporter.ts line 456 that seem related, and I think can be dropped, since the todo will be to-done after this PR.Might want to verify that the stripping happening in the otel lib isn't going to double-strip these fields, since the field set in
packages/core/src/integrations/requestdata.tsis stripped already. I think it's actually behaving properly, stripping it only where it needs to and not anywhere else (apart from the handful of locations noted above), and it'd likely fail a bunch of tests if it was double-stripping. In which case theTODO(v11)comments are definitely a bit of a hazard.