Skip to content

feat(cloudflare): Improve http span data#16232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 5 commits into from
May 12, 2025
Merged

feat(cloudflare): Improve http span data #16232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3bcfd0a
feat(cloudflare): Improve http span data
AbhiPrasad May 7, 2025
9ee2913
Remove op from `getHttpSpanDetailsFromUrlObject` func
AbhiPrasad May 8, 2025
cfc1f8b
add more tests
AbhiPrasad May 8, 2025
52b7884
re-introduce http kind
AbhiPrasad May 8, 2025
72f5006
fix tests
AbhiPrasad May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 6 additions & 25 deletions packages/cloudflare/src/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/workers-types';
import type { SpanAttributes } from '@sentry/core';
import {
captureException,
continueTrace,
flush,
SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
getHttpSpanDetailsFromUrlObject,
parseStringToURLObject,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
SEMANTIC_ATTRIBUTE_URL_FULL,
setHttpStatus,
startSpan,
stripUrlQueryAndFragment,
withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
Expand DownExpand Up@@ -42,28 +38,15 @@ export function wrapRequestHandler(
const client = init(options);
isolationScope.setClient(client);

const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
[SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method,
[SEMANTIC_ATTRIBUTE_URL_FULL]: request.url,
};
const urlObject = parseStringToURLObject(request.url);
const [name, attributes] = getHttpSpanDetailsFromUrlObject(urlObject, 'server', 'auto.http.cloudflare', request);

const contentLength = request.headers.get('content-length');
if (contentLength) {
attributes['http.request.body.size'] = parseInt(contentLength, 10);
}

let pathname = '';
try {
const url = new URL(request.url);
pathname = url.pathname;
attributes['server.address'] = url.hostname;
attributes['url.scheme'] = url.protocol.replace(':', '');
} catch {
// skip
}
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = 'http.server';

addCloudResourceContext(isolationScope);
if (request) {
Expand All@@ -74,8 +57,6 @@ export function wrapRequestHandler(
}
}

const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

// Do not capture spans for OPTIONS and HEAD requests
if (request.method === 'OPTIONS' || request.method === 'HEAD') {
try {
Expand All@@ -96,7 +77,7 @@ export function wrapRequestHandler(
// See: https://developers.cloudflare.com/workers/runtime-apis/performance/
return startSpan(
{
name: routeName,
name,
attributes,
},
async span => {
Expand Down
7 changes: 5 additions & 2 deletions packages/cloudflare/test/request.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -254,12 +254,13 @@ describe('withSentry', () => {
data: {
'sentry.origin': 'auto.http.cloudflare',
'sentry.op': 'http.server',
'sentry.source': 'url',
'sentry.source': 'route',
'http.request.method': 'GET',
'url.full': 'https://example.com/',
'server.address': 'example.com',
'network.protocol.name': 'HTTP/1.1',
'url.scheme': 'https',
'url.scheme': 'https:',
'url.path': '/',
'sentry.sample_rate': 1,
'http.response.status_code': 200,
'http.request.body.size': 10,
Expand All@@ -269,6 +270,8 @@ describe('withSentry', () => {
span_id: expect.stringMatching(/[a-f0-9]{16}/),
status: 'ok',
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
parent_span_id: undefined,
links: undefined,
});
});
});
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,7 @@ export {
parseUrl,
stripUrlQueryAndFragment,
parseStringToURLObject,
getHttpSpanDetailsFromUrlObject,
isURLObjectRelative,
getSanitizedUrlStringFromUrlObject,
} from './utils-hoist/url';
Expand Down
99 changes: 98 additions & 1 deletion packages/core/src/utils-hoist/url.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
import {
SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
SEMANTIC_ATTRIBUTE_URL_FULL,
} from '../semanticAttributes';
import type { SpanAttributes } from '../types-hoist/span';

type PartialURL = {
host?: string;
path?: string;
Expand DownExpand Up@@ -53,7 +61,7 @@ export function isURLObjectRelative(url: URLObject): url is RelativeURL {
* @returns The parsed URL object or undefined if the URL is invalid
*/
export function parseStringToURLObject(url: string, urlBase?: string | URL | undefined): URLObject | undefined {
const isRelative = url.startsWith('/');
const isRelative = url.indexOf('://') <= 0 && url.indexOf('//') !== 0;

@AbhiPrasadAbhiPrasadMay 8, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This check is now much more robust. I've added way more tests for this as well.

const base = urlBase ?? (isRelative ? DEFAULT_BASE_URL : undefined);
try {
// Use `canParse` to short-circuit the URL constructor if it's not a valid URL
Expand DownExpand Up@@ -107,6 +115,95 @@ export function getSanitizedUrlStringFromUrlObject(url: URLObject): string {
return newUrl.toString();
}

type PartialRequest = {
method?: string;
};

function getHttpSpanNameFromUrlObject(
urlObject: URLObject | undefined,
kind: 'server' | 'client',
request?: PartialRequest,
routeName?: string,
): string {
const method = request?.method?.toUpperCase() ?? 'GET';
const route = routeName
? routeName
: urlObject
? kind === 'client'
? getSanitizedUrlStringFromUrlObject(urlObject)
: urlObject.pathname
: '/';

return `${method} ${route}`;
}

/**
* Takes a parsed URL object and returns a set of attributes for the span
* that represents the HTTP request for that url. This is used for both server
* and client http spans.
*
* Follows https://opentelemetry.io/docs/specs/semconv/http/.
*
* @param urlObject - see {@link parseStringToURLObject}
* @param kind - The type of HTTP operation (server or client)
* @param spanOrigin - The origin of the span
* @param request - The request object, see {@link PartialRequest}
* @param routeName - The name of the route, must be low cardinality
* @returns The span name and attributes for the HTTP operation
*/
export function getHttpSpanDetailsFromUrlObject(
urlObject: URLObject | undefined,
kind: 'server' | 'client',

@AbhiPrasadAbhiPrasadMay 8, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know during our bikeshedding session we said we wanted to get rid of this, but I had to add it back so that we could generate the name correctly.

See the getHttpSpanNameFromUrlObject implementation.

spanOrigin: string,
request?: PartialRequest,
routeName?: string,
): [name: string, attributes: SpanAttributes] {
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
};

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';
}

if (request?.method) {
attributes[SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD] = request.method.toUpperCase();
}

if (urlObject) {
if (urlObject.search) {
attributes['url.query'] = urlObject.search;
}
if (urlObject.hash) {
attributes['url.fragment'] = urlObject.hash;
}
if (urlObject.pathname) {
attributes['url.path'] = urlObject.pathname;
if (urlObject.pathname === '/') {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
}
}

if (!isURLObjectRelative(urlObject)) {
attributes[SEMANTIC_ATTRIBUTE_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;
}
}
}

return [getHttpSpanNameFromUrlObject(urlObject, kind, request, routeName), attributes];
}

/**
* Parses string form of URL into an object
* // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(cloudflare): Improve http span data by AbhiPrasad · Pull Request #16232 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Improve http span data#16232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 5 commits into

from

May 12, 2025
 Merged


feat(cloudflare): Improve http span data
#16232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
3bcfd0a

feat(cloudflare): Improve http span data


AbhiPrasad May 7, 2025
9ee2913

Remove op from `getHttpSpanDetailsFromUrlObject` func


AbhiPrasad May 8, 2025
cfc1f8b

add more tests


AbhiPrasad May 8, 2025
52b7884

re-introduce http kind


AbhiPrasad May 8, 2025
72f5006

fix tests


AbhiPrasad May 9, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


31 changes: 6 additions & 25 deletions
packages/cloudflare/src/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/workers-types';
import type { SpanAttributes } from '@sentry/core';
import {
 captureException,
 continueTrace,
 flush,
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 getHttpSpanDetailsFromUrlObject,
 parseStringToURLObject,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SEMANTIC_ATTRIBUTE_URL_FULL,
 setHttpStatus,
 startSpan,
 stripUrlQueryAndFragment,
 withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
Expand DownExpand Up@@ -42,28 +38,15 @@ export function wrapRequestHandler(
 const client = init(options);
 isolationScope.setClient(client);

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method,
 [SEMANTIC_ATTRIBUTE_URL_FULL]: request.url,
 };
 const urlObject = parseStringToURLObject(request.url);
 const [name, attributes] = getHttpSpanDetailsFromUrlObject(urlObject, 'server', 'auto.http.cloudflare', request);

 const contentLength = request.headers.get('content-length');
 if (contentLength) {
 attributes['http.request.body.size'] = parseInt(contentLength, 10);
 }

 let pathname = '';
 try {
 const url = new URL(request.url);
 pathname = url.pathname;
 attributes['server.address'] = url.hostname;
 attributes['url.scheme'] = url.protocol.replace(':', '');
 } catch {
 // skip
 }
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = 'http.server';

 addCloudResourceContext(isolationScope);
 if (request) {
Expand All@@ -74,8 +57,6 @@ export function wrapRequestHandler(
 }
 }

 const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

 // Do not capture spans for OPTIONS and HEAD requests
 if (request.method === 'OPTIONS' || request.method === 'HEAD') {
 try {
Expand All@@ -96,7 +77,7 @@ export function wrapRequestHandler(
 // See: https://developers.cloudflare.com/workers/runtime-apis/performance/
 return startSpan(
 {
 name: routeName,
 name,
 attributes,
 },
 async span => {
Expand Down

7 changes: 5 additions & 2 deletions
packages/cloudflare/test/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -254,12 +254,13 @@ describe('withSentry', () => {
 data: {
 'sentry.origin': 'auto.http.cloudflare',
 'sentry.op': 'http.server',
 'sentry.source': 'url',
 'sentry.source': 'route',
 'http.request.method': 'GET',
 'url.full': 'https://example.com/',
 'server.address': 'example.com',
 'network.protocol.name': 'HTTP/1.1',
 'url.scheme': 'https',
 'url.scheme': 'https:',
 'url.path': '/',
 'sentry.sample_rate': 1,
 'http.response.status_code': 200,
 'http.request.body.size': 10,
Expand All@@ -269,6 +270,8 @@ describe('withSentry', () => {
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 status: 'ok',
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 parent_span_id: undefined,
 links: undefined,
 });
 });
 });
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,7 @@ export {
 parseUrl,
 stripUrlQueryAndFragment,
 parseStringToURLObject,
 getHttpSpanDetailsFromUrlObject,
 isURLObjectRelative,
 getSanitizedUrlStringFromUrlObject,
} from './utils-hoist/url';
Expand Down

99 changes: 98 additions & 1 deletion
packages/core/src/utils-hoist/url.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SEMANTIC_ATTRIBUTE_URL_FULL,
} from '../semanticAttributes';
import type { SpanAttributes } from '../types-hoist/span';

type PartialURL = {
 host?: string;
 path?: string;
Expand DownExpand Up@@ -53,7 +61,7 @@ export function isURLObjectRelative(url: URLObject): url is RelativeURL {
 * @returns The parsed URL object or undefined if the URL is invalid
 */
export function parseStringToURLObject(url: string, urlBase?: string | URL | undefined): URLObject | undefined {
 const isRelative = url.startsWith('/');
 const isRelative = url.indexOf('://') <= 0 && url.indexOf('//') !== 0;
@AbhiPrasadAbhiPrasadMay 8, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This check is now much more robust. I've added way more tests for this as well.
 const base = urlBase ?? (isRelative ? DEFAULT_BASE_URL : undefined);
 try {
 // Use `canParse` to short-circuit the URL constructor if it's not a valid URL
Expand DownExpand Up@@ -107,6 +115,95 @@ export function getSanitizedUrlStringFromUrlObject(url: URLObject): string {
 return newUrl.toString();
}

type PartialRequest = {
 method?: string;
};

function getHttpSpanNameFromUrlObject(
 urlObject: URLObject | undefined,
 kind: 'server' | 'client',
 request?: PartialRequest,
 routeName?: string,
): string {
 const method = request?.method?.toUpperCase() ?? 'GET';
 const route = routeName
 ? routeName
 : urlObject
 ? kind === 'client'
 ? getSanitizedUrlStringFromUrlObject(urlObject)
 : urlObject.pathname
 : '/';

 return `${method} ${route}`;
}

/**
 * Takes a parsed URL object and returns a set of attributes for the span
 * that represents the HTTP request for that url. This is used for both server
 * and client http spans.
 *
 * Follows https://opentelemetry.io/docs/specs/semconv/http/.
 *
 * @param urlObject - see {@link parseStringToURLObject}
 * @param kind - The type of HTTP operation (server or client)
 * @param spanOrigin - The origin of the span
 * @param request - The request object, see {@link PartialRequest}
 * @param routeName - The name of the route, must be low cardinality
 * @returns The span name and attributes for the HTTP operation
 */
export function getHttpSpanDetailsFromUrlObject(
 urlObject: URLObject | undefined,
 kind: 'server' | 'client',
@AbhiPrasadAbhiPrasadMay 8, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know during our bikeshedding session we said we wanted to get rid of this, but I had to add it back so that we could generate the name correctly.
See the getHttpSpanNameFromUrlObject implementation.
 spanOrigin: string,
 request?: PartialRequest,
 routeName?: string,
): [name: string, attributes: SpanAttributes] {
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };

 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';
 }

 if (request?.method) {
 attributes[SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD] = request.method.toUpperCase();
 }

 if (urlObject) {
 if (urlObject.search) {
 attributes['url.query'] = urlObject.search;
 }
 if (urlObject.hash) {
 attributes['url.fragment'] = urlObject.hash;
 }
 if (urlObject.pathname) {
 attributes['url.path'] = urlObject.pathname;
 if (urlObject.pathname === '/') {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 }
 }

 if (!isURLObjectRelative(urlObject)) {
 attributes[SEMANTIC_ATTRIBUTE_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;
 }
 }
 }

 return [getHttpSpanNameFromUrlObject(urlObject, kind, request, routeName), attributes];
}

/**
 * Parses string form of URL into an object
 * // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(cloudflare): Improve http span data by AbhiPrasad · Pull Request #16232 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Improve http span data#16232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 5 commits into

from

May 12, 2025
 Merged


feat(cloudflare): Improve http span data
#16232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
3bcfd0a

feat(cloudflare): Improve http span data


AbhiPrasad May 7, 2025
9ee2913

Remove op from `getHttpSpanDetailsFromUrlObject` func


AbhiPrasad May 8, 2025
cfc1f8b

add more tests


AbhiPrasad May 8, 2025
52b7884

re-introduce http kind


AbhiPrasad May 8, 2025
72f5006

fix tests


AbhiPrasad May 9, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


31 changes: 6 additions & 25 deletions
packages/cloudflare/src/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/workers-types';
import type { SpanAttributes } from '@sentry/core';
import {
 captureException,
 continueTrace,
 flush,
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 getHttpSpanDetailsFromUrlObject,
 parseStringToURLObject,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SEMANTIC_ATTRIBUTE_URL_FULL,
 setHttpStatus,
 startSpan,
 stripUrlQueryAndFragment,
 withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
Expand DownExpand Up@@ -42,28 +38,15 @@ export function wrapRequestHandler(
 const client = init(options);
 isolationScope.setClient(client);

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method,
 [SEMANTIC_ATTRIBUTE_URL_FULL]: request.url,
 };
 const urlObject = parseStringToURLObject(request.url);
 const [name, attributes] = getHttpSpanDetailsFromUrlObject(urlObject, 'server', 'auto.http.cloudflare', request);

 const contentLength = request.headers.get('content-length');
 if (contentLength) {
 attributes['http.request.body.size'] = parseInt(contentLength, 10);
 }

 let pathname = '';
 try {
 const url = new URL(request.url);
 pathname = url.pathname;
 attributes['server.address'] = url.hostname;
 attributes['url.scheme'] = url.protocol.replace(':', '');
 } catch {
 // skip
 }
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = 'http.server';

 addCloudResourceContext(isolationScope);
 if (request) {
Expand All@@ -74,8 +57,6 @@ export function wrapRequestHandler(
 }
 }

 const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

 // Do not capture spans for OPTIONS and HEAD requests
 if (request.method === 'OPTIONS' || request.method === 'HEAD') {
 try {
Expand All@@ -96,7 +77,7 @@ export function wrapRequestHandler(
 // See: https://developers.cloudflare.com/workers/runtime-apis/performance/
 return startSpan(
 {
 name: routeName,
 name,
 attributes,
 },
 async span => {
Expand Down

7 changes: 5 additions & 2 deletions
packages/cloudflare/test/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -254,12 +254,13 @@ describe('withSentry', () => {
 data: {
 'sentry.origin': 'auto.http.cloudflare',
 'sentry.op': 'http.server',
 'sentry.source': 'url',
 'sentry.source': 'route',
 'http.request.method': 'GET',
 'url.full': 'https://example.com/',
 'server.address': 'example.com',
 'network.protocol.name': 'HTTP/1.1',
 'url.scheme': 'https',
 'url.scheme': 'https:',
 'url.path': '/',
 'sentry.sample_rate': 1,
 'http.response.status_code': 200,
 'http.request.body.size': 10,
Expand All@@ -269,6 +270,8 @@ describe('withSentry', () => {
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 status: 'ok',
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 parent_span_id: undefined,
 links: undefined,
 });
 });
 });
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,7 @@ export {
 parseUrl,
 stripUrlQueryAndFragment,
 parseStringToURLObject,
 getHttpSpanDetailsFromUrlObject,
 isURLObjectRelative,
 getSanitizedUrlStringFromUrlObject,
} from './utils-hoist/url';
Expand Down

99 changes: 98 additions & 1 deletion
packages/core/src/utils-hoist/url.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SEMANTIC_ATTRIBUTE_URL_FULL,
} from '../semanticAttributes';
import type { SpanAttributes } from '../types-hoist/span';

type PartialURL = {
 host?: string;
 path?: string;
Expand DownExpand Up@@ -53,7 +61,7 @@ export function isURLObjectRelative(url: URLObject): url is RelativeURL {
 * @returns The parsed URL object or undefined if the URL is invalid
 */
export function parseStringToURLObject(url: string, urlBase?: string | URL | undefined): URLObject | undefined {
 const isRelative = url.startsWith('/');
 const isRelative = url.indexOf('://') <= 0 && url.indexOf('//') !== 0;
@AbhiPrasadAbhiPrasadMay 8, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This check is now much more robust. I've added way more tests for this as well.
 const base = urlBase ?? (isRelative ? DEFAULT_BASE_URL : undefined);
 try {
 // Use `canParse` to short-circuit the URL constructor if it's not a valid URL
Expand DownExpand Up@@ -107,6 +115,95 @@ export function getSanitizedUrlStringFromUrlObject(url: URLObject): string {
 return newUrl.toString();
}

type PartialRequest = {
 method?: string;
};

function getHttpSpanNameFromUrlObject(
 urlObject: URLObject | undefined,
 kind: 'server' | 'client',
 request?: PartialRequest,
 routeName?: string,
): string {
 const method = request?.method?.toUpperCase() ?? 'GET';
 const route = routeName
 ? routeName
 : urlObject
 ? kind === 'client'
 ? getSanitizedUrlStringFromUrlObject(urlObject)
 : urlObject.pathname
 : '/';

 return `${method} ${route}`;
}

/**
 * Takes a parsed URL object and returns a set of attributes for the span
 * that represents the HTTP request for that url. This is used for both server
 * and client http spans.
 *
 * Follows https://opentelemetry.io/docs/specs/semconv/http/.
 *
 * @param urlObject - see {@link parseStringToURLObject}
 * @param kind - The type of HTTP operation (server or client)
 * @param spanOrigin - The origin of the span
 * @param request - The request object, see {@link PartialRequest}
 * @param routeName - The name of the route, must be low cardinality
 * @returns The span name and attributes for the HTTP operation
 */
export function getHttpSpanDetailsFromUrlObject(
 urlObject: URLObject | undefined,
 kind: 'server' | 'client',
@AbhiPrasadAbhiPrasadMay 8, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know during our bikeshedding session we said we wanted to get rid of this, but I had to add it back so that we could generate the name correctly.
See the getHttpSpanNameFromUrlObject implementation.
 spanOrigin: string,
 request?: PartialRequest,
 routeName?: string,
): [name: string, attributes: SpanAttributes] {
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };

 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';
 }

 if (request?.method) {
 attributes[SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD] = request.method.toUpperCase();
 }

 if (urlObject) {
 if (urlObject.search) {
 attributes['url.query'] = urlObject.search;
 }
 if (urlObject.hash) {
 attributes['url.fragment'] = urlObject.hash;
 }
 if (urlObject.pathname) {
 attributes['url.path'] = urlObject.pathname;
 if (urlObject.pathname === '/') {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 }
 }

 if (!isURLObjectRelative(urlObject)) {
 attributes[SEMANTIC_ATTRIBUTE_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;
 }
 }
 }

 return [getHttpSpanNameFromUrlObject(urlObject, kind, request, routeName), attributes];
}

/**
 * Parses string form of URL into an object
 * // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(cloudflare): Improve http span data by AbhiPrasad · Pull Request #16232 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Improve http span data#16232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 5 commits into

from

May 12, 2025
 Merged


feat(cloudflare): Improve http span data
#16232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
3bcfd0a

feat(cloudflare): Improve http span data


AbhiPrasad May 7, 2025
9ee2913

Remove op from `getHttpSpanDetailsFromUrlObject` func


AbhiPrasad May 8, 2025
cfc1f8b

add more tests


AbhiPrasad May 8, 2025
52b7884

re-introduce http kind


AbhiPrasad May 8, 2025
72f5006

fix tests


AbhiPrasad May 9, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


31 changes: 6 additions & 25 deletions
packages/cloudflare/src/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/workers-types';
import type { SpanAttributes } from '@sentry/core';
import {
 captureException,
 continueTrace,
 flush,
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 getHttpSpanDetailsFromUrlObject,
 parseStringToURLObject,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SEMANTIC_ATTRIBUTE_URL_FULL,
 setHttpStatus,
 startSpan,
 stripUrlQueryAndFragment,
 withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
Expand DownExpand Up@@ -42,28 +38,15 @@ export function wrapRequestHandler(
 const client = init(options);
 isolationScope.setClient(client);

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method,
 [SEMANTIC_ATTRIBUTE_URL_FULL]: request.url,
 };
 const urlObject = parseStringToURLObject(request.url);
 const [name, attributes] = getHttpSpanDetailsFromUrlObject(urlObject, 'server', 'auto.http.cloudflare', request);

 const contentLength = request.headers.get('content-length');
 if (contentLength) {
 attributes['http.request.body.size'] = parseInt(contentLength, 10);
 }

 let pathname = '';
 try {
 const url = new URL(request.url);
 pathname = url.pathname;
 attributes['server.address'] = url.hostname;
 attributes['url.scheme'] = url.protocol.replace(':', '');
 } catch {
 // skip
 }
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = 'http.server';

 addCloudResourceContext(isolationScope);
 if (request) {
Expand All@@ -74,8 +57,6 @@ export function wrapRequestHandler(
 }
 }

 const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

 // Do not capture spans for OPTIONS and HEAD requests
 if (request.method === 'OPTIONS' || request.method === 'HEAD') {
 try {
Expand All@@ -96,7 +77,7 @@ export function wrapRequestHandler(
 // See: https://developers.cloudflare.com/workers/runtime-apis/performance/
 return startSpan(
 {
 name: routeName,
 name,
 attributes,
 },
 async span => {
Expand Down

7 changes: 5 additions & 2 deletions
packages/cloudflare/test/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -254,12 +254,13 @@ describe('withSentry', () => {
 data: {
 'sentry.origin': 'auto.http.cloudflare',
 'sentry.op': 'http.server',
 'sentry.source': 'url',
 'sentry.source': 'route',
 'http.request.method': 'GET',
 'url.full': 'https://example.com/',
 'server.address': 'example.com',
 'network.protocol.name': 'HTTP/1.1',
 'url.scheme': 'https',
 'url.scheme': 'https:',
 'url.path': '/',
 'sentry.sample_rate': 1,
 'http.response.status_code': 200,
 'http.request.body.size': 10,
Expand All@@ -269,6 +270,8 @@ describe('withSentry', () => {
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 status: 'ok',
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 parent_span_id: undefined,
 links: undefined,
 });
 });
 });
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,7 @@ export {
 parseUrl,
 stripUrlQueryAndFragment,
 parseStringToURLObject,
 getHttpSpanDetailsFromUrlObject,
 isURLObjectRelative,
 getSanitizedUrlStringFromUrlObject,
} from './utils-hoist/url';
Expand Down

99 changes: 98 additions & 1 deletion
packages/core/src/utils-hoist/url.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SEMANTIC_ATTRIBUTE_URL_FULL,
} from '../semanticAttributes';
import type { SpanAttributes } from '../types-hoist/span';

type PartialURL = {
 host?: string;
 path?: string;
Expand DownExpand Up@@ -53,7 +61,7 @@ export function isURLObjectRelative(url: URLObject): url is RelativeURL {
 * @returns The parsed URL object or undefined if the URL is invalid
 */
export function parseStringToURLObject(url: string, urlBase?: string | URL | undefined): URLObject | undefined {
 const isRelative = url.startsWith('/');
 const isRelative = url.indexOf('://') <= 0 && url.indexOf('//') !== 0;
@AbhiPrasadAbhiPrasadMay 8, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This check is now much more robust. I've added way more tests for this as well.
 const base = urlBase ?? (isRelative ? DEFAULT_BASE_URL : undefined);
 try {
 // Use `canParse` to short-circuit the URL constructor if it's not a valid URL
Expand DownExpand Up@@ -107,6 +115,95 @@ export function getSanitizedUrlStringFromUrlObject(url: URLObject): string {
 return newUrl.toString();
}

type PartialRequest = {
 method?: string;
};

function getHttpSpanNameFromUrlObject(
 urlObject: URLObject | undefined,
 kind: 'server' | 'client',
 request?: PartialRequest,
 routeName?: string,
): string {
 const method = request?.method?.toUpperCase() ?? 'GET';
 const route = routeName
 ? routeName
 : urlObject
 ? kind === 'client'
 ? getSanitizedUrlStringFromUrlObject(urlObject)
 : urlObject.pathname
 : '/';

 return `${method} ${route}`;
}

/**
 * Takes a parsed URL object and returns a set of attributes for the span
 * that represents the HTTP request for that url. This is used for both server
 * and client http spans.
 *
 * Follows https://opentelemetry.io/docs/specs/semconv/http/.
 *
 * @param urlObject - see {@link parseStringToURLObject}
 * @param kind - The type of HTTP operation (server or client)
 * @param spanOrigin - The origin of the span
 * @param request - The request object, see {@link PartialRequest}
 * @param routeName - The name of the route, must be low cardinality
 * @returns The span name and attributes for the HTTP operation
 */
export function getHttpSpanDetailsFromUrlObject(
 urlObject: URLObject | undefined,
 kind: 'server' | 'client',
@AbhiPrasadAbhiPrasadMay 8, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know during our bikeshedding session we said we wanted to get rid of this, but I had to add it back so that we could generate the name correctly.
See the getHttpSpanNameFromUrlObject implementation.
 spanOrigin: string,
 request?: PartialRequest,
 routeName?: string,
): [name: string, attributes: SpanAttributes] {
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };

 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';
 }

 if (request?.method) {
 attributes[SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD] = request.method.toUpperCase();
 }

 if (urlObject) {
 if (urlObject.search) {
 attributes['url.query'] = urlObject.search;
 }
 if (urlObject.hash) {
 attributes['url.fragment'] = urlObject.hash;
 }
 if (urlObject.pathname) {
 attributes['url.path'] = urlObject.pathname;
 if (urlObject.pathname === '/') {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 }
 }

 if (!isURLObjectRelative(urlObject)) {
 attributes[SEMANTIC_ATTRIBUTE_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;
 }
 }
 }

 return [getHttpSpanNameFromUrlObject(urlObject, kind, request, routeName), attributes];
}

/**
 * Parses string form of URL into an object
 * // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(cloudflare): Improve http span data by AbhiPrasad · Pull Request #16232 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Improve http span data#16232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 5 commits into

from

May 12, 2025
 Merged


feat(cloudflare): Improve http span data
#16232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
3bcfd0a

feat(cloudflare): Improve http span data


AbhiPrasad May 7, 2025
9ee2913

Remove op from `getHttpSpanDetailsFromUrlObject` func


AbhiPrasad May 8, 2025
cfc1f8b

add more tests


AbhiPrasad May 8, 2025
52b7884

re-introduce http kind


AbhiPrasad May 8, 2025
72f5006

fix tests


AbhiPrasad May 9, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


31 changes: 6 additions & 25 deletions
packages/cloudflare/src/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/workers-types';
import type { SpanAttributes } from '@sentry/core';
import {
 captureException,
 continueTrace,
 flush,
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 getHttpSpanDetailsFromUrlObject,
 parseStringToURLObject,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SEMANTIC_ATTRIBUTE_URL_FULL,
 setHttpStatus,
 startSpan,
 stripUrlQueryAndFragment,
 withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
Expand DownExpand Up@@ -42,28 +38,15 @@ export function wrapRequestHandler(
 const client = init(options);
 isolationScope.setClient(client);

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method,
 [SEMANTIC_ATTRIBUTE_URL_FULL]: request.url,
 };
 const urlObject = parseStringToURLObject(request.url);
 const [name, attributes] = getHttpSpanDetailsFromUrlObject(urlObject, 'server', 'auto.http.cloudflare', request);

 const contentLength = request.headers.get('content-length');
 if (contentLength) {
 attributes['http.request.body.size'] = parseInt(contentLength, 10);
 }

 let pathname = '';
 try {
 const url = new URL(request.url);
 pathname = url.pathname;
 attributes['server.address'] = url.hostname;
 attributes['url.scheme'] = url.protocol.replace(':', '');
 } catch {
 // skip
 }
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = 'http.server';

 addCloudResourceContext(isolationScope);
 if (request) {
Expand All@@ -74,8 +57,6 @@ export function wrapRequestHandler(
 }
 }

 const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

 // Do not capture spans for OPTIONS and HEAD requests
 if (request.method === 'OPTIONS' || request.method === 'HEAD') {
 try {
Expand All@@ -96,7 +77,7 @@ export function wrapRequestHandler(
 // See: https://developers.cloudflare.com/workers/runtime-apis/performance/
 return startSpan(
 {
 name: routeName,
 name,
 attributes,
 },
 async span => {
Expand Down

7 changes: 5 additions & 2 deletions
packages/cloudflare/test/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -254,12 +254,13 @@ describe('withSentry', () => {
 data: {
 'sentry.origin': 'auto.http.cloudflare',
 'sentry.op': 'http.server',
 'sentry.source': 'url',
 'sentry.source': 'route',
 'http.request.method': 'GET',
 'url.full': 'https://example.com/',
 'server.address': 'example.com',
 'network.protocol.name': 'HTTP/1.1',
 'url.scheme': 'https',
 'url.scheme': 'https:',
 'url.path': '/',
 'sentry.sample_rate': 1,
 'http.response.status_code': 200,
 'http.request.body.size': 10,
Expand All@@ -269,6 +270,8 @@ describe('withSentry', () => {
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 status: 'ok',
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 parent_span_id: undefined,
 links: undefined,
 });
 });
 });
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,7 @@ export {
 parseUrl,
 stripUrlQueryAndFragment,
 parseStringToURLObject,
 getHttpSpanDetailsFromUrlObject,
 isURLObjectRelative,
 getSanitizedUrlStringFromUrlObject,
} from './utils-hoist/url';
Expand Down

99 changes: 98 additions & 1 deletion
packages/core/src/utils-hoist/url.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SEMANTIC_ATTRIBUTE_URL_FULL,
} from '../semanticAttributes';
import type { SpanAttributes } from '../types-hoist/span';

type PartialURL = {
 host?: string;
 path?: string;
Expand DownExpand Up@@ -53,7 +61,7 @@ export function isURLObjectRelative(url: URLObject): url is RelativeURL {
 * @returns The parsed URL object or undefined if the URL is invalid
 */
export function parseStringToURLObject(url: string, urlBase?: string | URL | undefined): URLObject | undefined {
 const isRelative = url.startsWith('/');
 const isRelative = url.indexOf('://') <= 0 && url.indexOf('//') !== 0;
@AbhiPrasadAbhiPrasadMay 8, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This check is now much more robust. I've added way more tests for this as well.
 const base = urlBase ?? (isRelative ? DEFAULT_BASE_URL : undefined);
 try {
 // Use `canParse` to short-circuit the URL constructor if it's not a valid URL
Expand DownExpand Up@@ -107,6 +115,95 @@ export function getSanitizedUrlStringFromUrlObject(url: URLObject): string {
 return newUrl.toString();
}

type PartialRequest = {
 method?: string;
};

function getHttpSpanNameFromUrlObject(
 urlObject: URLObject | undefined,
 kind: 'server' | 'client',
 request?: PartialRequest,
 routeName?: string,
): string {
 const method = request?.method?.toUpperCase() ?? 'GET';
 const route = routeName
 ? routeName
 : urlObject
 ? kind === 'client'
 ? getSanitizedUrlStringFromUrlObject(urlObject)
 : urlObject.pathname
 : '/';

 return `${method} ${route}`;
}

/**
 * Takes a parsed URL object and returns a set of attributes for the span
 * that represents the HTTP request for that url. This is used for both server
 * and client http spans.
 *
 * Follows https://opentelemetry.io/docs/specs/semconv/http/.
 *
 * @param urlObject - see {@link parseStringToURLObject}
 * @param kind - The type of HTTP operation (server or client)
 * @param spanOrigin - The origin of the span
 * @param request - The request object, see {@link PartialRequest}
 * @param routeName - The name of the route, must be low cardinality
 * @returns The span name and attributes for the HTTP operation
 */
export function getHttpSpanDetailsFromUrlObject(
 urlObject: URLObject | undefined,
 kind: 'server' | 'client',
@AbhiPrasadAbhiPrasadMay 8, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know during our bikeshedding session we said we wanted to get rid of this, but I had to add it back so that we could generate the name correctly.
See the getHttpSpanNameFromUrlObject implementation.
 spanOrigin: string,
 request?: PartialRequest,
 routeName?: string,
): [name: string, attributes: SpanAttributes] {
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };

 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';
 }

 if (request?.method) {
 attributes[SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD] = request.method.toUpperCase();
 }

 if (urlObject) {
 if (urlObject.search) {
 attributes['url.query'] = urlObject.search;
 }
 if (urlObject.hash) {
 attributes['url.fragment'] = urlObject.hash;
 }
 if (urlObject.pathname) {
 attributes['url.path'] = urlObject.pathname;
 if (urlObject.pathname === '/') {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 }
 }

 if (!isURLObjectRelative(urlObject)) {
 attributes[SEMANTIC_ATTRIBUTE_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;
 }
 }
 }

 return [getHttpSpanNameFromUrlObject(urlObject, kind, request, routeName), attributes];
}

/**
 * Parses string form of URL into an object
 * // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(cloudflare): Improve http span data by AbhiPrasad · Pull Request #16232 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Improve http span data#16232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 5 commits into

from

May 12, 2025
 Merged


feat(cloudflare): Improve http span data
#16232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
3bcfd0a

feat(cloudflare): Improve http span data


AbhiPrasad May 7, 2025
9ee2913

Remove op from `getHttpSpanDetailsFromUrlObject` func


AbhiPrasad May 8, 2025
cfc1f8b

add more tests


AbhiPrasad May 8, 2025
52b7884

re-introduce http kind


AbhiPrasad May 8, 2025
72f5006

fix tests


AbhiPrasad May 9, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


31 changes: 6 additions & 25 deletions
packages/cloudflare/src/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/workers-types';
import type { SpanAttributes } from '@sentry/core';
import {
 captureException,
 continueTrace,
 flush,
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 getHttpSpanDetailsFromUrlObject,
 parseStringToURLObject,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SEMANTIC_ATTRIBUTE_URL_FULL,
 setHttpStatus,
 startSpan,
 stripUrlQueryAndFragment,
 withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
Expand DownExpand Up@@ -42,28 +38,15 @@ export function wrapRequestHandler(
 const client = init(options);
 isolationScope.setClient(client);

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method,
 [SEMANTIC_ATTRIBUTE_URL_FULL]: request.url,
 };
 const urlObject = parseStringToURLObject(request.url);
 const [name, attributes] = getHttpSpanDetailsFromUrlObject(urlObject, 'server', 'auto.http.cloudflare', request);

 const contentLength = request.headers.get('content-length');
 if (contentLength) {
 attributes['http.request.body.size'] = parseInt(contentLength, 10);
 }

 let pathname = '';
 try {
 const url = new URL(request.url);
 pathname = url.pathname;
 attributes['server.address'] = url.hostname;
 attributes['url.scheme'] = url.protocol.replace(':', '');
 } catch {
 // skip
 }
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = 'http.server';

 addCloudResourceContext(isolationScope);
 if (request) {
Expand All@@ -74,8 +57,6 @@ export function wrapRequestHandler(
 }
 }

 const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

 // Do not capture spans for OPTIONS and HEAD requests
 if (request.method === 'OPTIONS' || request.method === 'HEAD') {
 try {
Expand All@@ -96,7 +77,7 @@ export function wrapRequestHandler(
 // See: https://developers.cloudflare.com/workers/runtime-apis/performance/
 return startSpan(
 {
 name: routeName,
 name,
 attributes,
 },
 async span => {
Expand Down

7 changes: 5 additions & 2 deletions
packages/cloudflare/test/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -254,12 +254,13 @@ describe('withSentry', () => {
 data: {
 'sentry.origin': 'auto.http.cloudflare',
 'sentry.op': 'http.server',
 'sentry.source': 'url',
 'sentry.source': 'route',
 'http.request.method': 'GET',
 'url.full': 'https://example.com/',
 'server.address': 'example.com',
 'network.protocol.name': 'HTTP/1.1',
 'url.scheme': 'https',
 'url.scheme': 'https:',
 'url.path': '/',
 'sentry.sample_rate': 1,
 'http.response.status_code': 200,
 'http.request.body.size': 10,
Expand All@@ -269,6 +270,8 @@ describe('withSentry', () => {
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 status: 'ok',
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 parent_span_id: undefined,
 links: undefined,
 });
 });
 });
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,7 @@ export {
 parseUrl,
 stripUrlQueryAndFragment,
 parseStringToURLObject,
 getHttpSpanDetailsFromUrlObject,
 isURLObjectRelative,
 getSanitizedUrlStringFromUrlObject,
} from './utils-hoist/url';
Expand Down

99 changes: 98 additions & 1 deletion
packages/core/src/utils-hoist/url.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SEMANTIC_ATTRIBUTE_URL_FULL,
} from '../semanticAttributes';
import type { SpanAttributes } from '../types-hoist/span';

type PartialURL = {
 host?: string;
 path?: string;
Expand DownExpand Up@@ -53,7 +61,7 @@ export function isURLObjectRelative(url: URLObject): url is RelativeURL {
 * @returns The parsed URL object or undefined if the URL is invalid
 */
export function parseStringToURLObject(url: string, urlBase?: string | URL | undefined): URLObject | undefined {
 const isRelative = url.startsWith('/');
 const isRelative = url.indexOf('://') <= 0 && url.indexOf('//') !== 0;
@AbhiPrasadAbhiPrasadMay 8, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This check is now much more robust. I've added way more tests for this as well.
 const base = urlBase ?? (isRelative ? DEFAULT_BASE_URL : undefined);
 try {
 // Use `canParse` to short-circuit the URL constructor if it's not a valid URL
Expand DownExpand Up@@ -107,6 +115,95 @@ export function getSanitizedUrlStringFromUrlObject(url: URLObject): string {
 return newUrl.toString();
}

type PartialRequest = {
 method?: string;
};

function getHttpSpanNameFromUrlObject(
 urlObject: URLObject | undefined,
 kind: 'server' | 'client',
 request?: PartialRequest,
 routeName?: string,
): string {
 const method = request?.method?.toUpperCase() ?? 'GET';
 const route = routeName
 ? routeName
 : urlObject
 ? kind === 'client'
 ? getSanitizedUrlStringFromUrlObject(urlObject)
 : urlObject.pathname
 : '/';

 return `${method} ${route}`;
}

/**
 * Takes a parsed URL object and returns a set of attributes for the span
 * that represents the HTTP request for that url. This is used for both server
 * and client http spans.
 *
 * Follows https://opentelemetry.io/docs/specs/semconv/http/.
 *
 * @param urlObject - see {@link parseStringToURLObject}
 * @param kind - The type of HTTP operation (server or client)
 * @param spanOrigin - The origin of the span
 * @param request - The request object, see {@link PartialRequest}
 * @param routeName - The name of the route, must be low cardinality
 * @returns The span name and attributes for the HTTP operation
 */
export function getHttpSpanDetailsFromUrlObject(
 urlObject: URLObject | undefined,
 kind: 'server' | 'client',
@AbhiPrasadAbhiPrasadMay 8, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know during our bikeshedding session we said we wanted to get rid of this, but I had to add it back so that we could generate the name correctly.
See the getHttpSpanNameFromUrlObject implementation.
 spanOrigin: string,
 request?: PartialRequest,
 routeName?: string,
): [name: string, attributes: SpanAttributes] {
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };

 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';
 }

 if (request?.method) {
 attributes[SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD] = request.method.toUpperCase();
 }

 if (urlObject) {
 if (urlObject.search) {
 attributes['url.query'] = urlObject.search;
 }
 if (urlObject.hash) {
 attributes['url.fragment'] = urlObject.hash;
 }
 if (urlObject.pathname) {
 attributes['url.path'] = urlObject.pathname;
 if (urlObject.pathname === '/') {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 }
 }

 if (!isURLObjectRelative(urlObject)) {
 attributes[SEMANTIC_ATTRIBUTE_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;
 }
 }
 }

 return [getHttpSpanNameFromUrlObject(urlObject, kind, request, routeName), attributes];
}

/**
 * Parses string form of URL into an object
 * // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
feat(cloudflare): Improve http span data by AbhiPrasad · Pull Request #16232 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Improve http span data#16232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 5 commits into

from

May 12, 2025
 Merged


feat(cloudflare): Improve http span data
#16232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
3bcfd0a

feat(cloudflare): Improve http span data


AbhiPrasad May 7, 2025
9ee2913

Remove op from `getHttpSpanDetailsFromUrlObject` func


AbhiPrasad May 8, 2025
cfc1f8b

add more tests


AbhiPrasad May 8, 2025
52b7884

re-introduce http kind


AbhiPrasad May 8, 2025
72f5006

fix tests


AbhiPrasad May 9, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


31 changes: 6 additions & 25 deletions
packages/cloudflare/src/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/workers-types';
import type { SpanAttributes } from '@sentry/core';
import {
 captureException,
 continueTrace,
 flush,
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 getHttpSpanDetailsFromUrlObject,
 parseStringToURLObject,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SEMANTIC_ATTRIBUTE_URL_FULL,
 setHttpStatus,
 startSpan,
 stripUrlQueryAndFragment,
 withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
Expand DownExpand Up@@ -42,28 +38,15 @@ export function wrapRequestHandler(
 const client = init(options);
 isolationScope.setClient(client);

 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method,
 [SEMANTIC_ATTRIBUTE_URL_FULL]: request.url,
 };
 const urlObject = parseStringToURLObject(request.url);
 const [name, attributes] = getHttpSpanDetailsFromUrlObject(urlObject, 'server', 'auto.http.cloudflare', request);

 const contentLength = request.headers.get('content-length');
 if (contentLength) {
 attributes['http.request.body.size'] = parseInt(contentLength, 10);
 }

 let pathname = '';
 try {
 const url = new URL(request.url);
 pathname = url.pathname;
 attributes['server.address'] = url.hostname;
 attributes['url.scheme'] = url.protocol.replace(':', '');
 } catch {
 // skip
 }
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = 'http.server';

 addCloudResourceContext(isolationScope);
 if (request) {
Expand All@@ -74,8 +57,6 @@ export function wrapRequestHandler(
 }
 }

 const routeName = `${request.method} ${pathname ? stripUrlQueryAndFragment(pathname) : '/'}`;

 // Do not capture spans for OPTIONS and HEAD requests
 if (request.method === 'OPTIONS' || request.method === 'HEAD') {
 try {
Expand All@@ -96,7 +77,7 @@ export function wrapRequestHandler(
 // See: https://developers.cloudflare.com/workers/runtime-apis/performance/
 return startSpan(
 {
 name: routeName,
 name,
 attributes,
 },
 async span => {
Expand Down

7 changes: 5 additions & 2 deletions
packages/cloudflare/test/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -254,12 +254,13 @@ describe('withSentry', () => {
 data: {
 'sentry.origin': 'auto.http.cloudflare',
 'sentry.op': 'http.server',
 'sentry.source': 'url',
 'sentry.source': 'route',
 'http.request.method': 'GET',
 'url.full': 'https://example.com/',
 'server.address': 'example.com',
 'network.protocol.name': 'HTTP/1.1',
 'url.scheme': 'https',
 'url.scheme': 'https:',
 'url.path': '/',
 'sentry.sample_rate': 1,
 'http.response.status_code': 200,
 'http.request.body.size': 10,
Expand All@@ -269,6 +270,8 @@ describe('withSentry', () => {
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 status: 'ok',
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 parent_span_id: undefined,
 links: undefined,
 });
 });
 });
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,7 @@ export {
 parseUrl,
 stripUrlQueryAndFragment,
 parseStringToURLObject,
 getHttpSpanDetailsFromUrlObject,
 isURLObjectRelative,
 getSanitizedUrlStringFromUrlObject,
} from './utils-hoist/url';
Expand Down

99 changes: 98 additions & 1 deletion
packages/core/src/utils-hoist/url.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SEMANTIC_ATTRIBUTE_URL_FULL,
} from '../semanticAttributes';
import type { SpanAttributes } from '../types-hoist/span';

type PartialURL = {
 host?: string;
 path?: string;
Expand DownExpand Up@@ -53,7 +61,7 @@ export function isURLObjectRelative(url: URLObject): url is RelativeURL {
 * @returns The parsed URL object or undefined if the URL is invalid
 */
export function parseStringToURLObject(url: string, urlBase?: string | URL | undefined): URLObject | undefined {
 const isRelative = url.startsWith('/');
 const isRelative = url.indexOf('://') <= 0 && url.indexOf('//') !== 0;
@AbhiPrasadAbhiPrasadMay 8, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This check is now much more robust. I've added way more tests for this as well.
 const base = urlBase ?? (isRelative ? DEFAULT_BASE_URL : undefined);
 try {
 // Use `canParse` to short-circuit the URL constructor if it's not a valid URL
Expand DownExpand Up@@ -107,6 +115,95 @@ export function getSanitizedUrlStringFromUrlObject(url: URLObject): string {
 return newUrl.toString();
}

type PartialRequest = {
 method?: string;
};

function getHttpSpanNameFromUrlObject(
 urlObject: URLObject | undefined,
 kind: 'server' | 'client',
 request?: PartialRequest,
 routeName?: string,
): string {
 const method = request?.method?.toUpperCase() ?? 'GET';
 const route = routeName
 ? routeName
 : urlObject
 ? kind === 'client'
 ? getSanitizedUrlStringFromUrlObject(urlObject)
 : urlObject.pathname
 : '/';

 return `${method} ${route}`;
}

/**
 * Takes a parsed URL object and returns a set of attributes for the span
 * that represents the HTTP request for that url. This is used for both server
 * and client http spans.
 *
 * Follows https://opentelemetry.io/docs/specs/semconv/http/.
 *
 * @param urlObject - see {@link parseStringToURLObject}
 * @param kind - The type of HTTP operation (server or client)
 * @param spanOrigin - The origin of the span
 * @param request - The request object, see {@link PartialRequest}
 * @param routeName - The name of the route, must be low cardinality
 * @returns The span name and attributes for the HTTP operation
 */
export function getHttpSpanDetailsFromUrlObject(
 urlObject: URLObject | undefined,
 kind: 'server' | 'client',
@AbhiPrasadAbhiPrasadMay 8, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know during our bikeshedding session we said we wanted to get rid of this, but I had to add it back so that we could generate the name correctly.
See the getHttpSpanNameFromUrlObject implementation.
 spanOrigin: string,
 request?: PartialRequest,
 routeName?: string,
): [name: string, attributes: SpanAttributes] {
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: spanOrigin,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };

 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';
 }

 if (request?.method) {
 attributes[SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD] = request.method.toUpperCase();
 }

 if (urlObject) {
 if (urlObject.search) {
 attributes['url.query'] = urlObject.search;
 }
 if (urlObject.hash) {
 attributes['url.fragment'] = urlObject.hash;
 }
 if (urlObject.pathname) {
 attributes['url.path'] = urlObject.pathname;
 if (urlObject.pathname === '/') {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 }
 }

 if (!isURLObjectRelative(urlObject)) {
 attributes[SEMANTIC_ATTRIBUTE_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;
 }
 }
 }

 return [getHttpSpanNameFromUrlObject(urlObject, kind, request, routeName), attributes];
}

/**
 * Parses string form of URL into an object
 * // borrowed from https://tools.ietf.org/html/rfc3986#appendix-B
Expand Down
Loading