ref(browser): Add protocol attributes to resource spans#15161

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
Lms24 merged 4 commits into from
Jan 29, 2025
Merged

ref(browser): Add protocol attributes to resource spans #15161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fcbbe45
ref(browser): Add protocol metadata to resource spans
Zen-cronic Jan 26, 2025
87932e7
refactor unit tests, strengthen integration test
Lms24 Jan 27, 2025
49ac3b2
formatting
Lms24 Jan 27, 2025
b75eb03
fix for webkit integration test run
Lms24 Jan 27, 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
130 changes: 116 additions & 14 deletions ...packages/browser-integration-tests/suites/tracing/metrics/pageload-resource-spans/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,44 @@
import type { Route } from '@playwright/test';
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';
import { type Event, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';

sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page }) => {
sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page, browserName }) => {
if (shouldSkipTracingTest()) {
sentryTest.skip();
}

const isWebkitRun = browserName === 'webkit';

// Intercepting asset requests to avoid network-related flakiness and random retries (on Firefox).
await page.route('https://example.com/path/to/image.svg', (route: Route) =>
route.fulfill({ path: `${__dirname}/assets/image.svg` }),
route.fulfill({
path: `${__dirname}/assets/image.svg`,
headers: {
'Timing-Allow-Origin': '*',
'Content-Type': 'image/svg+xml',
},
}),
);
await page.route('https://example.com/path/to/script.js', (route: Route) =>
route.fulfill({ path: `${__dirname}/assets/script.js` }),
route.fulfill({
path: `${__dirname}/assets/script.js`,
headers: {
'Timing-Allow-Origin': '*',
'Content-Type': 'application/javascript',
},
}),
);
await page.route('https://example.com/path/to/style.css', (route: Route) =>
route.fulfill({ path: `${__dirname}/assets/style.css` }),
route.fulfill({
path: `${__dirname}/assets/style.css`,
headers: {
'Timing-Allow-Origin': '*',
'Content-Type': 'text/css',
},
}),
);

const url = await getLocalTestUrl({ testDir: __dirname });
Expand All@@ -27,11 +47,14 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
const resourceSpans = eventData.spans?.filter(({ op }) => op?.startsWith('resource'));

const scriptSpans = resourceSpans?.filter(({ op }) => op === 'resource.script');
const linkSpans = resourceSpans?.filter(({ op }) => op === 'resource.link');
const imgSpans = resourceSpans?.filter(({ op }) => op === 'resource.img');
const linkSpan = resourceSpans?.filter(({ op }) => op === 'resource.link')[0];
const imgSpan = resourceSpans?.filter(({ op }) => op === 'resource.img')[0];

const spanId = eventData.contexts?.trace?.span_id;
const traceId = eventData.contexts?.trace?.trace_id;

expect(imgSpans).toHaveLength(1);
expect(linkSpans).toHaveLength(1);
expect(spanId).toBeDefined();
expect(traceId).toBeDefined();

const hasCdnBundle = (process.env.PW_BUNDLE || '').startsWith('bundle');

Expand All@@ -41,11 +64,90 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
}

expect(scriptSpans?.map(({ description }) => description).sort()).toEqual(expectedScripts);
expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));

const spanId = eventData.contexts?.trace?.span_id;
const customScriptSpan = scriptSpans?.find(
({ description }) => description === 'https://example.com/path/to/script.js',
);

expect(spanId).toBeDefined();
expect(imgSpans?.[0].parent_span_id).toBe(spanId);
expect(linkSpans?.[0].parent_span_id).toBe(spanId);
expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));
expect(imgSpan).toEqual({
data: {
'http.decoded_response_content_length': expect.any(Number),
'http.response_content_length': expect.any(Number),
'http.response_transfer_size': expect.any(Number),
'network.protocol.name': '',
'network.protocol.version': 'unknown',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.img',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
'server.address': 'example.com',
'url.same_origin': false,
'url.scheme': 'https',
...(!isWebkitRun && {
'resource.render_blocking_status': 'non-blocking',
'http.response_delivery_type': '',
}),
},
description: 'https://example.com/path/to/image.svg',
op: 'resource.img',
origin: 'auto.resource.browser.metrics',
parent_span_id: spanId,
span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: traceId,
});

expect(linkSpan).toEqual({
data: {
'http.decoded_response_content_length': expect.any(Number),
'http.response_content_length': expect.any(Number),
'http.response_transfer_size': expect.any(Number),
'network.protocol.name': '',
'network.protocol.version': 'unknown',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.link',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
'server.address': 'example.com',
'url.same_origin': false,
'url.scheme': 'https',
...(!isWebkitRun && {
'resource.render_blocking_status': 'non-blocking',
'http.response_delivery_type': '',
}),
},
description: 'https://example.com/path/to/style.css',
op: 'resource.link',
origin: 'auto.resource.browser.metrics',
parent_span_id: spanId,
span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: traceId,
});

expect(customScriptSpan).toEqual({
data: {
'http.decoded_response_content_length': expect.any(Number),
'http.response_content_length': expect.any(Number),
'http.response_transfer_size': expect.any(Number),
'network.protocol.name': '',
'network.protocol.version': 'unknown',
'sentry.op': 'resource.script',
'sentry.origin': 'auto.resource.browser.metrics',
'server.address': 'example.com',
'url.same_origin': false,
'url.scheme': 'https',
...(!isWebkitRun && {
'resource.render_blocking_status': 'non-blocking',
'http.response_delivery_type': '',
}),
},
description: 'https://example.com/path/to/script.js',
op: 'resource.script',
origin: 'auto.resource.browser.metrics',
parent_span_id: spanId,
span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: traceId,
});
});
2 changes: 2 additions & 0 deletions packages/browser-utils/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ export {
registerInpInteractionListener,
} from './metrics/browserMetrics';

export { extractNetworkProtocol } from './metrics/utils';

export { addClickKeypressInstrumentationHandler } from './instrument/dom';

export { addHistoryInstrumentationHandler } from './instrument/history';
Expand Down
12 changes: 11 additions & 1 deletion packages/browser-utils/src/metrics/browserMetrics.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,13 @@ import {
addPerformanceInstrumentationHandler,
addTtfbInstrumentationHandler,
} from './instrument';
import { getBrowserPerformanceAPI, isMeasurementValue, msToSec, startAndEndSpan } from './utils';
import {
extractNetworkProtocol,
getBrowserPerformanceAPI,
isMeasurementValue,
msToSec,
startAndEndSpan,
} from './utils';
import { getActivationStart } from './web-vitals/lib/getActivationStart';
import { getNavigationEntry } from './web-vitals/lib/getNavigationEntry';
import { getVisibilityWatcher } from './web-vitals/lib/getVisibilityWatcher';
Expand DownExpand Up@@ -596,6 +602,10 @@ export function _addResourceSpans(

attributes['url.same_origin'] = resourceUrl.includes(WINDOW.location.origin);

const { name, version } = extractNetworkProtocol(entry.nextHopProtocol);
attributes['network.protocol.name'] = name;
attributes['network.protocol.version'] = version;

const startTimestamp = timeOrigin + startTime;
const endTimestamp = startTimestamp + duration;

Expand Down
31 changes: 31 additions & 0 deletions packages/browser-utils/src/metrics/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,3 +137,34 @@ export function getBrowserPerformanceAPI(): Performance | undefined {
export function msToSec(time: number): number {
return time / 1000;
}

/**
* Converts ALPN protocol ids to name and version.
*
* (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids)
* @param nextHopProtocol PerformanceResourceTiming.nextHopProtocol
*/
export function extractNetworkProtocol(nextHopProtocol: string): { name: string; version: string } {
let name = 'unknown';
let version = 'unknown';
let _name = '';
for (const char of nextHopProtocol) {
// http/1.1 etc.
if (char === '/') {
[name, version] = nextHopProtocol.split('/') as [string, string];
break;
}
// h2, h3 etc.
if (!isNaN(Number(char))) {
name = _name === 'h' ? 'http' : _name;
version = nextHopProtocol.split(_name)[1] as string;
break;
}
_name += char;
}
if (_name === nextHopProtocol) {
// webrtc, ftp, etc.
name = _name;
}
return { name, version };
}
16 changes: 16 additions & 0 deletions packages/browser-utils/test/browser/browserMetrics.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,7 @@ describe('_addResourceSpans', () => {
encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

@Zen-cronicZen-cronicJan 26, 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 prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:

sentry-javascript/packages/browser/src/tracing/request.ts

Line 241 in a67d3ca

for(constcharofnextHopProtocol){

@Lms24Lms24Jan 27, 2025•
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

});
_addResourceSpans(span, entry, resourceEntryName, 123, 456, 100);

Expand All@@ -150,6 +151,7 @@ describe('_addResourceSpans', () => {
encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',
});
_addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 456, 100);

Expand All@@ -169,6 +171,7 @@ describe('_addResourceSpans', () => {
encodedBodySize: 456,
decodedBodySize: 593,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',
});

const timeOrigin = 100;
Expand All@@ -195,6 +198,8 @@ describe('_addResourceSpans', () => {
['url.scheme']: 'https',
['server.address']: 'example.com',
['url.same_origin']: true,
['network.protocol.name']: 'http',
['network.protocol.version']: '1.1',
},
}),
);
Expand DownExpand Up@@ -233,6 +238,7 @@ describe('_addResourceSpans', () => {
const { initiatorType, op } = table[i]!;
const entry = mockPerformanceResourceTiming({
initiatorType,
nextHopProtocol: 'http/1.1',
});
_addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 234, 465);

Expand All@@ -254,6 +260,7 @@ describe('_addResourceSpans', () => {
encodedBodySize: 0,
decodedBodySize: 0,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'h2',
});

_addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -271,6 +278,8 @@ describe('_addResourceSpans', () => {
['url.scheme']: 'https',
['server.address']: 'example.com',
['url.same_origin']: true,
['network.protocol.name']: 'http',
['network.protocol.version']: '2',
},
}),
);
Expand All@@ -288,6 +297,7 @@ describe('_addResourceSpans', () => {
transferSize: 2147483647,
encodedBodySize: 2147483647,
decodedBodySize: 2147483647,
nextHopProtocol: 'h3',
});

_addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -301,6 +311,8 @@ describe('_addResourceSpans', () => {
'server.address': 'example.com',
'url.same_origin': true,
'url.scheme': 'https',
['network.protocol.name']: 'http',
['network.protocol.version']: '3',
},
description: '/assets/to/css',
timestamp: 468,
Expand All@@ -325,6 +337,7 @@ describe('_addResourceSpans', () => {
transferSize: null,
encodedBodySize: null,
decodedBodySize: null,
nextHopProtocol: 'h3',
} as unknown as PerformanceResourceTiming;

_addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -338,6 +351,8 @@ describe('_addResourceSpans', () => {
'server.address': 'example.com',
'url.same_origin': true,
'url.scheme': 'https',
['network.protocol.name']: 'http',
['network.protocol.version']: '3',
},
description: '/assets/to/css',
timestamp: 468,
Expand DownExpand Up@@ -365,6 +380,7 @@ describe('_addResourceSpans', () => {
encodedBodySize: 0,
decodedBodySize: 0,
deliveryType,
nextHopProtocol: 'h3',
});

_addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand Down
43 changes: 42 additions & 1 deletion packages/browser-utils/test/browser/utils.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { SentrySpan, getCurrentScope, getIsolationScope, setCurrentClient, spanToJSON } from '@sentry/core';
import { startAndEndSpan } from '../../src/metrics/utils';
import { extractNetworkProtocol, startAndEndSpan } from '../../src/metrics/utils';
import { TestClient, getDefaultClientOptions } from '../utils/TestClient';

describe('startAndEndSpan()', () => {
Expand DownExpand Up@@ -54,3 +54,44 @@ describe('startAndEndSpan()', () => {
expect(spanToJSON(parentSpan).start_timestamp).toEqual(123);
});
});

describe('HTTPTimings', () => {
test.each([
['http/0.9', { name: 'http', version: '0.9' }],
['http/1.0', { name: 'http', version: '1.0' }],
['http/1.1', { name: 'http', version: '1.1' }],
['spdy/1', { name: 'spdy', version: '1' }],
['spdy/2', { name: 'spdy', version: '2' }],
['spdy/3', { name: 'spdy', version: '3' }],
['stun.turn', { name: 'stun.turn', version: 'unknown' }],
['stun.nat-discovery', { name: 'stun.nat-discovery', version: 'unknown' }],
['h2', { name: 'http', version: '2' }],
['h2c', { name: 'http', version: '2c' }],
['webrtc', { name: 'webrtc', version: 'unknown' }],
['c-webrtc', { name: 'c-webrtc', version: 'unknown' }],
['ftp', { name: 'ftp', version: 'unknown' }],
['imap', { name: 'imap', version: 'unknown' }],
['pop3', { name: 'pop', version: '3' }],
['managesieve', { name: 'managesieve', version: 'unknown' }],
['coap', { name: 'coap', version: 'unknown' }],
['xmpp-client', { name: 'xmpp-client', version: 'unknown' }],
['xmpp-server', { name: 'xmpp-server', version: 'unknown' }],
['acme-tls/1', { name: 'acme-tls', version: '1' }],
['mqtt', { name: 'mqtt', version: 'unknown' }],
['dot', { name: 'dot', version: 'unknown' }],
['ntske/1', { name: 'ntske', version: '1' }],
['sunrpc', { name: 'sunrpc', version: 'unknown' }],
['h3', { name: 'http', version: '3' }],
['smb', { name: 'smb', version: 'unknown' }],
['irc', { name: 'irc', version: 'unknown' }],
['nntp', { name: 'nntp', version: 'unknown' }],
['nnsp', { name: 'nnsp', version: 'unknown' }],
['doq', { name: 'doq', version: 'unknown' }],
['sip/2', { name: 'sip', version: '2' }],
['tds/8.0', { name: 'tds', version: '8.0' }],
['dicom', { name: 'dicom', version: 'unknown' }],
['', { name: '', version: 'unknown' }],

@Lms24Lms24Jan 27, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.

I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.

])('Extracting version from ALPN protocol %s', (protocol, expected) => {
expect(extractNetworkProtocol(protocol)).toMatchObject(expected);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
ref(browser): Add protocol attributes to resource spans#15161

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

Lms24
merged 4 commits into

from

Jan 29, 2025
 Merged


ref(browser): Add protocol attributes to resource spans
#15161
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fcbbe45

ref(browser): Add protocol metadata to resource spans


Zen-cronic Jan 26, 2025
87932e7

refactor unit tests, strengthen integration test


Lms24 Jan 27, 2025
49ac3b2

formatting


Lms24 Jan 27, 2025
b75eb03

fix for webkit integration test run


Lms24 Jan 27, 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


130 changes: 116 additions & 14 deletions
...packages/browser-integration-tests/suites/tracing/metrics/pageload-resource-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,44 @@
import type { Route } from '@playwright/test';
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';
import { type Event, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';

sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page }) => {
sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page, browserName }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

 const isWebkitRun = browserName === 'webkit';

 // Intercepting asset requests to avoid network-related flakiness and random retries (on Firefox).
 await page.route('https://example.com/path/to/image.svg', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/image.svg` }),
 route.fulfill({
 path: `${__dirname}/assets/image.svg`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'image/svg+xml',
 },
 }),
 );
 await page.route('https://example.com/path/to/script.js', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/script.js` }),
 route.fulfill({
 path: `${__dirname}/assets/script.js`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'application/javascript',
 },
 }),
 );
 await page.route('https://example.com/path/to/style.css', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/style.css` }),
 route.fulfill({
 path: `${__dirname}/assets/style.css`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'text/css',
 },
 }),
 );

 const url = await getLocalTestUrl({ testDir: __dirname });
Expand All@@ -27,11 +47,14 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
 const resourceSpans = eventData.spans?.filter(({ op }) => op?.startsWith('resource'));

 const scriptSpans = resourceSpans?.filter(({ op }) => op === 'resource.script');
 const linkSpans = resourceSpans?.filter(({ op }) => op === 'resource.link');
 const imgSpans = resourceSpans?.filter(({ op }) => op === 'resource.img');
 const linkSpan = resourceSpans?.filter(({ op }) => op === 'resource.link')[0];
 const imgSpan = resourceSpans?.filter(({ op }) => op === 'resource.img')[0];

 const spanId = eventData.contexts?.trace?.span_id;
 const traceId = eventData.contexts?.trace?.trace_id;

 expect(imgSpans).toHaveLength(1);
 expect(linkSpans).toHaveLength(1);
 expect(spanId).toBeDefined();
 expect(traceId).toBeDefined();

 const hasCdnBundle = (process.env.PW_BUNDLE || '').startsWith('bundle');

Expand All@@ -41,11 +64,90 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
 }

 expect(scriptSpans?.map(({ description }) => description).sort()).toEqual(expectedScripts);
 expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));

 const spanId = eventData.contexts?.trace?.span_id;
 const customScriptSpan = scriptSpans?.find(
 ({ description }) => description === 'https://example.com/path/to/script.js',
 );

 expect(spanId).toBeDefined();
 expect(imgSpans?.[0].parent_span_id).toBe(spanId);
 expect(linkSpans?.[0].parent_span_id).toBe(spanId);
 expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));
 expect(imgSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.img',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/image.svg',
 op: 'resource.img',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });

 expect(linkSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.link',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/style.css',
 op: 'resource.link',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });

 expect(customScriptSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 'sentry.op': 'resource.script',
 'sentry.origin': 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/script.js',
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });
});

2 changes: 2 additions & 0 deletions
packages/browser-utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ export {
 registerInpInteractionListener,
} from './metrics/browserMetrics';

export { extractNetworkProtocol } from './metrics/utils';

export { addClickKeypressInstrumentationHandler } from './instrument/dom';

export { addHistoryInstrumentationHandler } from './instrument/history';
Expand Down

12 changes: 11 additions & 1 deletion
packages/browser-utils/src/metrics/browserMetrics.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,13 @@ import {
 addPerformanceInstrumentationHandler,
 addTtfbInstrumentationHandler,
} from './instrument';
import { getBrowserPerformanceAPI, isMeasurementValue, msToSec, startAndEndSpan } from './utils';
import {
 extractNetworkProtocol,
 getBrowserPerformanceAPI,
 isMeasurementValue,
 msToSec,
 startAndEndSpan,
} from './utils';
import { getActivationStart } from './web-vitals/lib/getActivationStart';
import { getNavigationEntry } from './web-vitals/lib/getNavigationEntry';
import { getVisibilityWatcher } from './web-vitals/lib/getVisibilityWatcher';
Expand DownExpand Up@@ -596,6 +602,10 @@ export function _addResourceSpans(

 attributes['url.same_origin'] = resourceUrl.includes(WINDOW.location.origin);

 const { name, version } = extractNetworkProtocol(entry.nextHopProtocol);
 attributes['network.protocol.name'] = name;
 attributes['network.protocol.version'] = version;

 const startTimestamp = timeOrigin + startTime;
 const endTimestamp = startTimestamp + duration;

Expand Down

31 changes: 31 additions & 0 deletions
packages/browser-utils/src/metrics/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -137,3 +137,34 @@ export function getBrowserPerformanceAPI(): Performance | undefined {
export function msToSec(time: number): number {
 return time / 1000;
}

/**
 * Converts ALPN protocol ids to name and version.
 *
 * (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids)
 * @param nextHopProtocol PerformanceResourceTiming.nextHopProtocol
 */
export function extractNetworkProtocol(nextHopProtocol: string): { name: string; version: string } {
 let name = 'unknown';
 let version = 'unknown';
 let _name = '';
 for (const char of nextHopProtocol) {
 // http/1.1 etc.
 if (char === '/') {
 [name, version] = nextHopProtocol.split('/') as [string, string];
 break;
 }
 // h2, h3 etc.
 if (!isNaN(Number(char))) {
 name = _name === 'h' ? 'http' : _name;
 version = nextHopProtocol.split(_name)[1] as string;
 break;
 }
 _name += char;
 }
 if (_name === nextHopProtocol) {
 // webrtc, ftp, etc.
 name = _name;
 }
 return { name, version };
}

16 changes: 16 additions & 0 deletions
packages/browser-utils/test/browser/browserMetrics.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 256,
 decodedBodySize: 256,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
@Zen-cronicZen-cronicJan 26, 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 prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:
sentry-javascript/packages/browser/src/tracing/request.ts

Line 241
in
a67d3ca
for(constcharofnextHopProtocol){
@Lms24Lms24Jan 27, 2025•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.
 });
 _addResourceSpans(span, entry, resourceEntryName, 123, 456, 100);

Expand All@@ -150,6 +151,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 256,
 decodedBodySize: 256,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
 });
 _addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 456, 100);

Expand All@@ -169,6 +171,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 456,
 decodedBodySize: 593,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
 });

 const timeOrigin = 100;
Expand All@@ -195,6 +198,8 @@ describe('_addResourceSpans', () => {
 ['url.scheme']: 'https',
 ['server.address']: 'example.com',
 ['url.same_origin']: true,
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '1.1',
 },
 }),
 );
Expand DownExpand Up@@ -233,6 +238,7 @@ describe('_addResourceSpans', () => {
 const { initiatorType, op } = table[i]!;
 const entry = mockPerformanceResourceTiming({
 initiatorType,
 nextHopProtocol: 'http/1.1',
 });
 _addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 234, 465);

Expand All@@ -254,6 +260,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 0,
 decodedBodySize: 0,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'h2',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -271,6 +278,8 @@ describe('_addResourceSpans', () => {
 ['url.scheme']: 'https',
 ['server.address']: 'example.com',
 ['url.same_origin']: true,
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '2',
 },
 }),
 );
Expand All@@ -288,6 +297,7 @@ describe('_addResourceSpans', () => {
 transferSize: 2147483647,
 encodedBodySize: 2147483647,
 decodedBodySize: 2147483647,
 nextHopProtocol: 'h3',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -301,6 +311,8 @@ describe('_addResourceSpans', () => {
 'server.address': 'example.com',
 'url.same_origin': true,
 'url.scheme': 'https',
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '3',
 },
 description: '/assets/to/css',
 timestamp: 468,
Expand All@@ -325,6 +337,7 @@ describe('_addResourceSpans', () => {
 transferSize: null,
 encodedBodySize: null,
 decodedBodySize: null,
 nextHopProtocol: 'h3',
 } as unknown as PerformanceResourceTiming;

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -338,6 +351,8 @@ describe('_addResourceSpans', () => {
 'server.address': 'example.com',
 'url.same_origin': true,
 'url.scheme': 'https',
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '3',
 },
 description: '/assets/to/css',
 timestamp: 468,
Expand DownExpand Up@@ -365,6 +380,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 0,
 decodedBodySize: 0,
 deliveryType,
 nextHopProtocol: 'h3',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand Down

43 changes: 42 additions & 1 deletion
packages/browser-utils/test/browser/utils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { SentrySpan, getCurrentScope, getIsolationScope, setCurrentClient, spanToJSON } from '@sentry/core';
import { startAndEndSpan } from '../../src/metrics/utils';
import { extractNetworkProtocol, startAndEndSpan } from '../../src/metrics/utils';
import { TestClient, getDefaultClientOptions } from '../utils/TestClient';

describe('startAndEndSpan()', () => {
Expand DownExpand Up@@ -54,3 +54,44 @@ describe('startAndEndSpan()', () => {
 expect(spanToJSON(parentSpan).start_timestamp).toEqual(123);
 });
});

describe('HTTPTimings', () => {
 test.each([
 ['http/0.9', { name: 'http', version: '0.9' }],
 ['http/1.0', { name: 'http', version: '1.0' }],
 ['http/1.1', { name: 'http', version: '1.1' }],
 ['spdy/1', { name: 'spdy', version: '1' }],
 ['spdy/2', { name: 'spdy', version: '2' }],
 ['spdy/3', { name: 'spdy', version: '3' }],
 ['stun.turn', { name: 'stun.turn', version: 'unknown' }],
 ['stun.nat-discovery', { name: 'stun.nat-discovery', version: 'unknown' }],
 ['h2', { name: 'http', version: '2' }],
 ['h2c', { name: 'http', version: '2c' }],
 ['webrtc', { name: 'webrtc', version: 'unknown' }],
 ['c-webrtc', { name: 'c-webrtc', version: 'unknown' }],
 ['ftp', { name: 'ftp', version: 'unknown' }],
 ['imap', { name: 'imap', version: 'unknown' }],
 ['pop3', { name: 'pop', version: '3' }],
 ['managesieve', { name: 'managesieve', version: 'unknown' }],
 ['coap', { name: 'coap', version: 'unknown' }],
 ['xmpp-client', { name: 'xmpp-client', version: 'unknown' }],
 ['xmpp-server', { name: 'xmpp-server', version: 'unknown' }],
 ['acme-tls/1', { name: 'acme-tls', version: '1' }],
 ['mqtt', { name: 'mqtt', version: 'unknown' }],
 ['dot', { name: 'dot', version: 'unknown' }],
 ['ntske/1', { name: 'ntske', version: '1' }],
 ['sunrpc', { name: 'sunrpc', version: 'unknown' }],
 ['h3', { name: 'http', version: '3' }],
 ['smb', { name: 'smb', version: 'unknown' }],
 ['irc', { name: 'irc', version: 'unknown' }],
 ['nntp', { name: 'nntp', version: 'unknown' }],
 ['nnsp', { name: 'nnsp', version: 'unknown' }],
 ['doq', { name: 'doq', version: 'unknown' }],
 ['sip/2', { name: 'sip', version: '2' }],
 ['tds/8.0', { name: 'tds', version: '8.0' }],
 ['dicom', { name: 'dicom', version: 'unknown' }],
 ['', { name: '', version: 'unknown' }],
@Lms24Lms24Jan 27, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.
I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.
 ])('Extracting version from ALPN protocol %s', (protocol, expected) => {
 expect(extractNetworkProtocol(protocol)).toMatchObject(expected);
 });
});
Loading

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

Skip to content
ref(browser): Add protocol attributes to resource spans#15161

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

Lms24
merged 4 commits into

from

Jan 29, 2025
 Merged


ref(browser): Add protocol attributes to resource spans
#15161
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fcbbe45

ref(browser): Add protocol metadata to resource spans


Zen-cronic Jan 26, 2025
87932e7

refactor unit tests, strengthen integration test


Lms24 Jan 27, 2025
49ac3b2

formatting


Lms24 Jan 27, 2025
b75eb03

fix for webkit integration test run


Lms24 Jan 27, 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


130 changes: 116 additions & 14 deletions
...packages/browser-integration-tests/suites/tracing/metrics/pageload-resource-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,44 @@
import type { Route } from '@playwright/test';
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';
import { type Event, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';

sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page }) => {
sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page, browserName }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

 const isWebkitRun = browserName === 'webkit';

 // Intercepting asset requests to avoid network-related flakiness and random retries (on Firefox).
 await page.route('https://example.com/path/to/image.svg', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/image.svg` }),
 route.fulfill({
 path: `${__dirname}/assets/image.svg`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'image/svg+xml',
 },
 }),
 );
 await page.route('https://example.com/path/to/script.js', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/script.js` }),
 route.fulfill({
 path: `${__dirname}/assets/script.js`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'application/javascript',
 },
 }),
 );
 await page.route('https://example.com/path/to/style.css', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/style.css` }),
 route.fulfill({
 path: `${__dirname}/assets/style.css`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'text/css',
 },
 }),
 );

 const url = await getLocalTestUrl({ testDir: __dirname });
Expand All@@ -27,11 +47,14 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
 const resourceSpans = eventData.spans?.filter(({ op }) => op?.startsWith('resource'));

 const scriptSpans = resourceSpans?.filter(({ op }) => op === 'resource.script');
 const linkSpans = resourceSpans?.filter(({ op }) => op === 'resource.link');
 const imgSpans = resourceSpans?.filter(({ op }) => op === 'resource.img');
 const linkSpan = resourceSpans?.filter(({ op }) => op === 'resource.link')[0];
 const imgSpan = resourceSpans?.filter(({ op }) => op === 'resource.img')[0];

 const spanId = eventData.contexts?.trace?.span_id;
 const traceId = eventData.contexts?.trace?.trace_id;

 expect(imgSpans).toHaveLength(1);
 expect(linkSpans).toHaveLength(1);
 expect(spanId).toBeDefined();
 expect(traceId).toBeDefined();

 const hasCdnBundle = (process.env.PW_BUNDLE || '').startsWith('bundle');

Expand All@@ -41,11 +64,90 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
 }

 expect(scriptSpans?.map(({ description }) => description).sort()).toEqual(expectedScripts);
 expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));

 const spanId = eventData.contexts?.trace?.span_id;
 const customScriptSpan = scriptSpans?.find(
 ({ description }) => description === 'https://example.com/path/to/script.js',
 );

 expect(spanId).toBeDefined();
 expect(imgSpans?.[0].parent_span_id).toBe(spanId);
 expect(linkSpans?.[0].parent_span_id).toBe(spanId);
 expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));
 expect(imgSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.img',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/image.svg',
 op: 'resource.img',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });

 expect(linkSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.link',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/style.css',
 op: 'resource.link',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });

 expect(customScriptSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 'sentry.op': 'resource.script',
 'sentry.origin': 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/script.js',
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });
});

2 changes: 2 additions & 0 deletions
packages/browser-utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ export {
 registerInpInteractionListener,
} from './metrics/browserMetrics';

export { extractNetworkProtocol } from './metrics/utils';

export { addClickKeypressInstrumentationHandler } from './instrument/dom';

export { addHistoryInstrumentationHandler } from './instrument/history';
Expand Down

12 changes: 11 additions & 1 deletion
packages/browser-utils/src/metrics/browserMetrics.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,13 @@ import {
 addPerformanceInstrumentationHandler,
 addTtfbInstrumentationHandler,
} from './instrument';
import { getBrowserPerformanceAPI, isMeasurementValue, msToSec, startAndEndSpan } from './utils';
import {
 extractNetworkProtocol,
 getBrowserPerformanceAPI,
 isMeasurementValue,
 msToSec,
 startAndEndSpan,
} from './utils';
import { getActivationStart } from './web-vitals/lib/getActivationStart';
import { getNavigationEntry } from './web-vitals/lib/getNavigationEntry';
import { getVisibilityWatcher } from './web-vitals/lib/getVisibilityWatcher';
Expand DownExpand Up@@ -596,6 +602,10 @@ export function _addResourceSpans(

 attributes['url.same_origin'] = resourceUrl.includes(WINDOW.location.origin);

 const { name, version } = extractNetworkProtocol(entry.nextHopProtocol);
 attributes['network.protocol.name'] = name;
 attributes['network.protocol.version'] = version;

 const startTimestamp = timeOrigin + startTime;
 const endTimestamp = startTimestamp + duration;

Expand Down

31 changes: 31 additions & 0 deletions
packages/browser-utils/src/metrics/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -137,3 +137,34 @@ export function getBrowserPerformanceAPI(): Performance | undefined {
export function msToSec(time: number): number {
 return time / 1000;
}

/**
 * Converts ALPN protocol ids to name and version.
 *
 * (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids)
 * @param nextHopProtocol PerformanceResourceTiming.nextHopProtocol
 */
export function extractNetworkProtocol(nextHopProtocol: string): { name: string; version: string } {
 let name = 'unknown';
 let version = 'unknown';
 let _name = '';
 for (const char of nextHopProtocol) {
 // http/1.1 etc.
 if (char === '/') {
 [name, version] = nextHopProtocol.split('/') as [string, string];
 break;
 }
 // h2, h3 etc.
 if (!isNaN(Number(char))) {
 name = _name === 'h' ? 'http' : _name;
 version = nextHopProtocol.split(_name)[1] as string;
 break;
 }
 _name += char;
 }
 if (_name === nextHopProtocol) {
 // webrtc, ftp, etc.
 name = _name;
 }
 return { name, version };
}

16 changes: 16 additions & 0 deletions
packages/browser-utils/test/browser/browserMetrics.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 256,
 decodedBodySize: 256,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
@Zen-cronicZen-cronicJan 26, 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 prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:
sentry-javascript/packages/browser/src/tracing/request.ts

Line 241
in
a67d3ca
for(constcharofnextHopProtocol){
@Lms24Lms24Jan 27, 2025•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.
 });
 _addResourceSpans(span, entry, resourceEntryName, 123, 456, 100);

Expand All@@ -150,6 +151,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 256,
 decodedBodySize: 256,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
 });
 _addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 456, 100);

Expand All@@ -169,6 +171,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 456,
 decodedBodySize: 593,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
 });

 const timeOrigin = 100;
Expand All@@ -195,6 +198,8 @@ describe('_addResourceSpans', () => {
 ['url.scheme']: 'https',
 ['server.address']: 'example.com',
 ['url.same_origin']: true,
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '1.1',
 },
 }),
 );
Expand DownExpand Up@@ -233,6 +238,7 @@ describe('_addResourceSpans', () => {
 const { initiatorType, op } = table[i]!;
 const entry = mockPerformanceResourceTiming({
 initiatorType,
 nextHopProtocol: 'http/1.1',
 });
 _addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 234, 465);

Expand All@@ -254,6 +260,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 0,
 decodedBodySize: 0,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'h2',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -271,6 +278,8 @@ describe('_addResourceSpans', () => {
 ['url.scheme']: 'https',
 ['server.address']: 'example.com',
 ['url.same_origin']: true,
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '2',
 },
 }),
 );
Expand All@@ -288,6 +297,7 @@ describe('_addResourceSpans', () => {
 transferSize: 2147483647,
 encodedBodySize: 2147483647,
 decodedBodySize: 2147483647,
 nextHopProtocol: 'h3',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -301,6 +311,8 @@ describe('_addResourceSpans', () => {
 'server.address': 'example.com',
 'url.same_origin': true,
 'url.scheme': 'https',
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '3',
 },
 description: '/assets/to/css',
 timestamp: 468,
Expand All@@ -325,6 +337,7 @@ describe('_addResourceSpans', () => {
 transferSize: null,
 encodedBodySize: null,
 decodedBodySize: null,
 nextHopProtocol: 'h3',
 } as unknown as PerformanceResourceTiming;

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -338,6 +351,8 @@ describe('_addResourceSpans', () => {
 'server.address': 'example.com',
 'url.same_origin': true,
 'url.scheme': 'https',
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '3',
 },
 description: '/assets/to/css',
 timestamp: 468,
Expand DownExpand Up@@ -365,6 +380,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 0,
 decodedBodySize: 0,
 deliveryType,
 nextHopProtocol: 'h3',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand Down

43 changes: 42 additions & 1 deletion
packages/browser-utils/test/browser/utils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { SentrySpan, getCurrentScope, getIsolationScope, setCurrentClient, spanToJSON } from '@sentry/core';
import { startAndEndSpan } from '../../src/metrics/utils';
import { extractNetworkProtocol, startAndEndSpan } from '../../src/metrics/utils';
import { TestClient, getDefaultClientOptions } from '../utils/TestClient';

describe('startAndEndSpan()', () => {
Expand DownExpand Up@@ -54,3 +54,44 @@ describe('startAndEndSpan()', () => {
 expect(spanToJSON(parentSpan).start_timestamp).toEqual(123);
 });
});

describe('HTTPTimings', () => {
 test.each([
 ['http/0.9', { name: 'http', version: '0.9' }],
 ['http/1.0', { name: 'http', version: '1.0' }],
 ['http/1.1', { name: 'http', version: '1.1' }],
 ['spdy/1', { name: 'spdy', version: '1' }],
 ['spdy/2', { name: 'spdy', version: '2' }],
 ['spdy/3', { name: 'spdy', version: '3' }],
 ['stun.turn', { name: 'stun.turn', version: 'unknown' }],
 ['stun.nat-discovery', { name: 'stun.nat-discovery', version: 'unknown' }],
 ['h2', { name: 'http', version: '2' }],
 ['h2c', { name: 'http', version: '2c' }],
 ['webrtc', { name: 'webrtc', version: 'unknown' }],
 ['c-webrtc', { name: 'c-webrtc', version: 'unknown' }],
 ['ftp', { name: 'ftp', version: 'unknown' }],
 ['imap', { name: 'imap', version: 'unknown' }],
 ['pop3', { name: 'pop', version: '3' }],
 ['managesieve', { name: 'managesieve', version: 'unknown' }],
 ['coap', { name: 'coap', version: 'unknown' }],
 ['xmpp-client', { name: 'xmpp-client', version: 'unknown' }],
 ['xmpp-server', { name: 'xmpp-server', version: 'unknown' }],
 ['acme-tls/1', { name: 'acme-tls', version: '1' }],
 ['mqtt', { name: 'mqtt', version: 'unknown' }],
 ['dot', { name: 'dot', version: 'unknown' }],
 ['ntske/1', { name: 'ntske', version: '1' }],
 ['sunrpc', { name: 'sunrpc', version: 'unknown' }],
 ['h3', { name: 'http', version: '3' }],
 ['smb', { name: 'smb', version: 'unknown' }],
 ['irc', { name: 'irc', version: 'unknown' }],
 ['nntp', { name: 'nntp', version: 'unknown' }],
 ['nnsp', { name: 'nnsp', version: 'unknown' }],
 ['doq', { name: 'doq', version: 'unknown' }],
 ['sip/2', { name: 'sip', version: '2' }],
 ['tds/8.0', { name: 'tds', version: '8.0' }],
 ['dicom', { name: 'dicom', version: 'unknown' }],
 ['', { name: '', version: 'unknown' }],
@Lms24Lms24Jan 27, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.
I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.
 ])('Extracting version from ALPN protocol %s', (protocol, expected) => {
 expect(extractNetworkProtocol(protocol)).toMatchObject(expected);
 });
});
Loading

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

Skip to content
ref(browser): Add protocol attributes to resource spans#15161

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

Lms24
merged 4 commits into

from

Jan 29, 2025
 Merged


ref(browser): Add protocol attributes to resource spans
#15161
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fcbbe45

ref(browser): Add protocol metadata to resource spans


Zen-cronic Jan 26, 2025
87932e7

refactor unit tests, strengthen integration test


Lms24 Jan 27, 2025
49ac3b2

formatting


Lms24 Jan 27, 2025
b75eb03

fix for webkit integration test run


Lms24 Jan 27, 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


130 changes: 116 additions & 14 deletions
...packages/browser-integration-tests/suites/tracing/metrics/pageload-resource-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,44 @@
import type { Route } from '@playwright/test';
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';
import { type Event, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';

sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page }) => {
sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page, browserName }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

 const isWebkitRun = browserName === 'webkit';

 // Intercepting asset requests to avoid network-related flakiness and random retries (on Firefox).
 await page.route('https://example.com/path/to/image.svg', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/image.svg` }),
 route.fulfill({
 path: `${__dirname}/assets/image.svg`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'image/svg+xml',
 },
 }),
 );
 await page.route('https://example.com/path/to/script.js', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/script.js` }),
 route.fulfill({
 path: `${__dirname}/assets/script.js`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'application/javascript',
 },
 }),
 );
 await page.route('https://example.com/path/to/style.css', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/style.css` }),
 route.fulfill({
 path: `${__dirname}/assets/style.css`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'text/css',
 },
 }),
 );

 const url = await getLocalTestUrl({ testDir: __dirname });
Expand All@@ -27,11 +47,14 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
 const resourceSpans = eventData.spans?.filter(({ op }) => op?.startsWith('resource'));

 const scriptSpans = resourceSpans?.filter(({ op }) => op === 'resource.script');
 const linkSpans = resourceSpans?.filter(({ op }) => op === 'resource.link');
 const imgSpans = resourceSpans?.filter(({ op }) => op === 'resource.img');
 const linkSpan = resourceSpans?.filter(({ op }) => op === 'resource.link')[0];
 const imgSpan = resourceSpans?.filter(({ op }) => op === 'resource.img')[0];

 const spanId = eventData.contexts?.trace?.span_id;
 const traceId = eventData.contexts?.trace?.trace_id;

 expect(imgSpans).toHaveLength(1);
 expect(linkSpans).toHaveLength(1);
 expect(spanId).toBeDefined();
 expect(traceId).toBeDefined();

 const hasCdnBundle = (process.env.PW_BUNDLE || '').startsWith('bundle');

Expand All@@ -41,11 +64,90 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
 }

 expect(scriptSpans?.map(({ description }) => description).sort()).toEqual(expectedScripts);
 expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));

 const spanId = eventData.contexts?.trace?.span_id;
 const customScriptSpan = scriptSpans?.find(
 ({ description }) => description === 'https://example.com/path/to/script.js',
 );

 expect(spanId).toBeDefined();
 expect(imgSpans?.[0].parent_span_id).toBe(spanId);
 expect(linkSpans?.[0].parent_span_id).toBe(spanId);
 expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));
 expect(imgSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.img',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/image.svg',
 op: 'resource.img',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });

 expect(linkSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.link',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/style.css',
 op: 'resource.link',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });

 expect(customScriptSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 'sentry.op': 'resource.script',
 'sentry.origin': 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/script.js',
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });
});

2 changes: 2 additions & 0 deletions
packages/browser-utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ export {
 registerInpInteractionListener,
} from './metrics/browserMetrics';

export { extractNetworkProtocol } from './metrics/utils';

export { addClickKeypressInstrumentationHandler } from './instrument/dom';

export { addHistoryInstrumentationHandler } from './instrument/history';
Expand Down

12 changes: 11 additions & 1 deletion
packages/browser-utils/src/metrics/browserMetrics.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,13 @@ import {
 addPerformanceInstrumentationHandler,
 addTtfbInstrumentationHandler,
} from './instrument';
import { getBrowserPerformanceAPI, isMeasurementValue, msToSec, startAndEndSpan } from './utils';
import {
 extractNetworkProtocol,
 getBrowserPerformanceAPI,
 isMeasurementValue,
 msToSec,
 startAndEndSpan,
} from './utils';
import { getActivationStart } from './web-vitals/lib/getActivationStart';
import { getNavigationEntry } from './web-vitals/lib/getNavigationEntry';
import { getVisibilityWatcher } from './web-vitals/lib/getVisibilityWatcher';
Expand DownExpand Up@@ -596,6 +602,10 @@ export function _addResourceSpans(

 attributes['url.same_origin'] = resourceUrl.includes(WINDOW.location.origin);

 const { name, version } = extractNetworkProtocol(entry.nextHopProtocol);
 attributes['network.protocol.name'] = name;
 attributes['network.protocol.version'] = version;

 const startTimestamp = timeOrigin + startTime;
 const endTimestamp = startTimestamp + duration;

Expand Down

31 changes: 31 additions & 0 deletions
packages/browser-utils/src/metrics/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -137,3 +137,34 @@ export function getBrowserPerformanceAPI(): Performance | undefined {
export function msToSec(time: number): number {
 return time / 1000;
}

/**
 * Converts ALPN protocol ids to name and version.
 *
 * (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids)
 * @param nextHopProtocol PerformanceResourceTiming.nextHopProtocol
 */
export function extractNetworkProtocol(nextHopProtocol: string): { name: string; version: string } {
 let name = 'unknown';
 let version = 'unknown';
 let _name = '';
 for (const char of nextHopProtocol) {
 // http/1.1 etc.
 if (char === '/') {
 [name, version] = nextHopProtocol.split('/') as [string, string];
 break;
 }
 // h2, h3 etc.
 if (!isNaN(Number(char))) {
 name = _name === 'h' ? 'http' : _name;
 version = nextHopProtocol.split(_name)[1] as string;
 break;
 }
 _name += char;
 }
 if (_name === nextHopProtocol) {
 // webrtc, ftp, etc.
 name = _name;
 }
 return { name, version };
}

16 changes: 16 additions & 0 deletions
packages/browser-utils/test/browser/browserMetrics.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 256,
 decodedBodySize: 256,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
@Zen-cronicZen-cronicJan 26, 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 prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:
sentry-javascript/packages/browser/src/tracing/request.ts

Line 241
in
a67d3ca
for(constcharofnextHopProtocol){
@Lms24Lms24Jan 27, 2025•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.
 });
 _addResourceSpans(span, entry, resourceEntryName, 123, 456, 100);

Expand All@@ -150,6 +151,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 256,
 decodedBodySize: 256,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
 });
 _addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 456, 100);

Expand All@@ -169,6 +171,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 456,
 decodedBodySize: 593,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
 });

 const timeOrigin = 100;
Expand All@@ -195,6 +198,8 @@ describe('_addResourceSpans', () => {
 ['url.scheme']: 'https',
 ['server.address']: 'example.com',
 ['url.same_origin']: true,
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '1.1',
 },
 }),
 );
Expand DownExpand Up@@ -233,6 +238,7 @@ describe('_addResourceSpans', () => {
 const { initiatorType, op } = table[i]!;
 const entry = mockPerformanceResourceTiming({
 initiatorType,
 nextHopProtocol: 'http/1.1',
 });
 _addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 234, 465);

Expand All@@ -254,6 +260,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 0,
 decodedBodySize: 0,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'h2',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -271,6 +278,8 @@ describe('_addResourceSpans', () => {
 ['url.scheme']: 'https',
 ['server.address']: 'example.com',
 ['url.same_origin']: true,
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '2',
 },
 }),
 );
Expand All@@ -288,6 +297,7 @@ describe('_addResourceSpans', () => {
 transferSize: 2147483647,
 encodedBodySize: 2147483647,
 decodedBodySize: 2147483647,
 nextHopProtocol: 'h3',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -301,6 +311,8 @@ describe('_addResourceSpans', () => {
 'server.address': 'example.com',
 'url.same_origin': true,
 'url.scheme': 'https',
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '3',
 },
 description: '/assets/to/css',
 timestamp: 468,
Expand All@@ -325,6 +337,7 @@ describe('_addResourceSpans', () => {
 transferSize: null,
 encodedBodySize: null,
 decodedBodySize: null,
 nextHopProtocol: 'h3',
 } as unknown as PerformanceResourceTiming;

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -338,6 +351,8 @@ describe('_addResourceSpans', () => {
 'server.address': 'example.com',
 'url.same_origin': true,
 'url.scheme': 'https',
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '3',
 },
 description: '/assets/to/css',
 timestamp: 468,
Expand DownExpand Up@@ -365,6 +380,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 0,
 decodedBodySize: 0,
 deliveryType,
 nextHopProtocol: 'h3',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand Down

43 changes: 42 additions & 1 deletion
packages/browser-utils/test/browser/utils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { SentrySpan, getCurrentScope, getIsolationScope, setCurrentClient, spanToJSON } from '@sentry/core';
import { startAndEndSpan } from '../../src/metrics/utils';
import { extractNetworkProtocol, startAndEndSpan } from '../../src/metrics/utils';
import { TestClient, getDefaultClientOptions } from '../utils/TestClient';

describe('startAndEndSpan()', () => {
Expand DownExpand Up@@ -54,3 +54,44 @@ describe('startAndEndSpan()', () => {
 expect(spanToJSON(parentSpan).start_timestamp).toEqual(123);
 });
});

describe('HTTPTimings', () => {
 test.each([
 ['http/0.9', { name: 'http', version: '0.9' }],
 ['http/1.0', { name: 'http', version: '1.0' }],
 ['http/1.1', { name: 'http', version: '1.1' }],
 ['spdy/1', { name: 'spdy', version: '1' }],
 ['spdy/2', { name: 'spdy', version: '2' }],
 ['spdy/3', { name: 'spdy', version: '3' }],
 ['stun.turn', { name: 'stun.turn', version: 'unknown' }],
 ['stun.nat-discovery', { name: 'stun.nat-discovery', version: 'unknown' }],
 ['h2', { name: 'http', version: '2' }],
 ['h2c', { name: 'http', version: '2c' }],
 ['webrtc', { name: 'webrtc', version: 'unknown' }],
 ['c-webrtc', { name: 'c-webrtc', version: 'unknown' }],
 ['ftp', { name: 'ftp', version: 'unknown' }],
 ['imap', { name: 'imap', version: 'unknown' }],
 ['pop3', { name: 'pop', version: '3' }],
 ['managesieve', { name: 'managesieve', version: 'unknown' }],
 ['coap', { name: 'coap', version: 'unknown' }],
 ['xmpp-client', { name: 'xmpp-client', version: 'unknown' }],
 ['xmpp-server', { name: 'xmpp-server', version: 'unknown' }],
 ['acme-tls/1', { name: 'acme-tls', version: '1' }],
 ['mqtt', { name: 'mqtt', version: 'unknown' }],
 ['dot', { name: 'dot', version: 'unknown' }],
 ['ntske/1', { name: 'ntske', version: '1' }],
 ['sunrpc', { name: 'sunrpc', version: 'unknown' }],
 ['h3', { name: 'http', version: '3' }],
 ['smb', { name: 'smb', version: 'unknown' }],
 ['irc', { name: 'irc', version: 'unknown' }],
 ['nntp', { name: 'nntp', version: 'unknown' }],
 ['nnsp', { name: 'nnsp', version: 'unknown' }],
 ['doq', { name: 'doq', version: 'unknown' }],
 ['sip/2', { name: 'sip', version: '2' }],
 ['tds/8.0', { name: 'tds', version: '8.0' }],
 ['dicom', { name: 'dicom', version: 'unknown' }],
 ['', { name: '', version: 'unknown' }],
@Lms24Lms24Jan 27, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.
I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.
 ])('Extracting version from ALPN protocol %s', (protocol, expected) => {
 expect(extractNetworkProtocol(protocol)).toMatchObject(expected);
 });
});
Loading

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

Skip to content
ref(browser): Add protocol attributes to resource spans#15161

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

Lms24
merged 4 commits into

from

Jan 29, 2025
 Merged


ref(browser): Add protocol attributes to resource spans
#15161
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fcbbe45

ref(browser): Add protocol metadata to resource spans


Zen-cronic Jan 26, 2025
87932e7

refactor unit tests, strengthen integration test


Lms24 Jan 27, 2025
49ac3b2

formatting


Lms24 Jan 27, 2025
b75eb03

fix for webkit integration test run


Lms24 Jan 27, 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


130 changes: 116 additions & 14 deletions
...packages/browser-integration-tests/suites/tracing/metrics/pageload-resource-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,44 @@
import type { Route } from '@playwright/test';
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';
import { type Event, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';

sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page }) => {
sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page, browserName }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

 const isWebkitRun = browserName === 'webkit';

 // Intercepting asset requests to avoid network-related flakiness and random retries (on Firefox).
 await page.route('https://example.com/path/to/image.svg', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/image.svg` }),
 route.fulfill({
 path: `${__dirname}/assets/image.svg`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'image/svg+xml',
 },
 }),
 );
 await page.route('https://example.com/path/to/script.js', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/script.js` }),
 route.fulfill({
 path: `${__dirname}/assets/script.js`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'application/javascript',
 },
 }),
 );
 await page.route('https://example.com/path/to/style.css', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/style.css` }),
 route.fulfill({
 path: `${__dirname}/assets/style.css`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'text/css',
 },
 }),
 );

 const url = await getLocalTestUrl({ testDir: __dirname });
Expand All@@ -27,11 +47,14 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
 const resourceSpans = eventData.spans?.filter(({ op }) => op?.startsWith('resource'));

 const scriptSpans = resourceSpans?.filter(({ op }) => op === 'resource.script');
 const linkSpans = resourceSpans?.filter(({ op }) => op === 'resource.link');
 const imgSpans = resourceSpans?.filter(({ op }) => op === 'resource.img');
 const linkSpan = resourceSpans?.filter(({ op }) => op === 'resource.link')[0];
 const imgSpan = resourceSpans?.filter(({ op }) => op === 'resource.img')[0];

 const spanId = eventData.contexts?.trace?.span_id;
 const traceId = eventData.contexts?.trace?.trace_id;

 expect(imgSpans).toHaveLength(1);
 expect(linkSpans).toHaveLength(1);
 expect(spanId).toBeDefined();
 expect(traceId).toBeDefined();

 const hasCdnBundle = (process.env.PW_BUNDLE || '').startsWith('bundle');

Expand All@@ -41,11 +64,90 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
 }

 expect(scriptSpans?.map(({ description }) => description).sort()).toEqual(expectedScripts);
 expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));

 const spanId = eventData.contexts?.trace?.span_id;
 const customScriptSpan = scriptSpans?.find(
 ({ description }) => description === 'https://example.com/path/to/script.js',
 );

 expect(spanId).toBeDefined();
 expect(imgSpans?.[0].parent_span_id).toBe(spanId);
 expect(linkSpans?.[0].parent_span_id).toBe(spanId);
 expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));
 expect(imgSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.img',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/image.svg',
 op: 'resource.img',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });

 expect(linkSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.link',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/style.css',
 op: 'resource.link',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });

 expect(customScriptSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 'sentry.op': 'resource.script',
 'sentry.origin': 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/script.js',
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });
});

2 changes: 2 additions & 0 deletions
packages/browser-utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ export {
 registerInpInteractionListener,
} from './metrics/browserMetrics';

export { extractNetworkProtocol } from './metrics/utils';

export { addClickKeypressInstrumentationHandler } from './instrument/dom';

export { addHistoryInstrumentationHandler } from './instrument/history';
Expand Down

12 changes: 11 additions & 1 deletion
packages/browser-utils/src/metrics/browserMetrics.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,13 @@ import {
 addPerformanceInstrumentationHandler,
 addTtfbInstrumentationHandler,
} from './instrument';
import { getBrowserPerformanceAPI, isMeasurementValue, msToSec, startAndEndSpan } from './utils';
import {
 extractNetworkProtocol,
 getBrowserPerformanceAPI,
 isMeasurementValue,
 msToSec,
 startAndEndSpan,
} from './utils';
import { getActivationStart } from './web-vitals/lib/getActivationStart';
import { getNavigationEntry } from './web-vitals/lib/getNavigationEntry';
import { getVisibilityWatcher } from './web-vitals/lib/getVisibilityWatcher';
Expand DownExpand Up@@ -596,6 +602,10 @@ export function _addResourceSpans(

 attributes['url.same_origin'] = resourceUrl.includes(WINDOW.location.origin);

 const { name, version } = extractNetworkProtocol(entry.nextHopProtocol);
 attributes['network.protocol.name'] = name;
 attributes['network.protocol.version'] = version;

 const startTimestamp = timeOrigin + startTime;
 const endTimestamp = startTimestamp + duration;

Expand Down

31 changes: 31 additions & 0 deletions
packages/browser-utils/src/metrics/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -137,3 +137,34 @@ export function getBrowserPerformanceAPI(): Performance | undefined {
export function msToSec(time: number): number {
 return time / 1000;
}

/**
 * Converts ALPN protocol ids to name and version.
 *
 * (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids)
 * @param nextHopProtocol PerformanceResourceTiming.nextHopProtocol
 */
export function extractNetworkProtocol(nextHopProtocol: string): { name: string; version: string } {
 let name = 'unknown';
 let version = 'unknown';
 let _name = '';
 for (const char of nextHopProtocol) {
 // http/1.1 etc.
 if (char === '/') {
 [name, version] = nextHopProtocol.split('/') as [string, string];
 break;
 }
 // h2, h3 etc.
 if (!isNaN(Number(char))) {
 name = _name === 'h' ? 'http' : _name;
 version = nextHopProtocol.split(_name)[1] as string;
 break;
 }
 _name += char;
 }
 if (_name === nextHopProtocol) {
 // webrtc, ftp, etc.
 name = _name;
 }
 return { name, version };
}

16 changes: 16 additions & 0 deletions
packages/browser-utils/test/browser/browserMetrics.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 256,
 decodedBodySize: 256,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
@Zen-cronicZen-cronicJan 26, 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 prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:
sentry-javascript/packages/browser/src/tracing/request.ts

Line 241
in
a67d3ca
for(constcharofnextHopProtocol){
@Lms24Lms24Jan 27, 2025•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.
 });
 _addResourceSpans(span, entry, resourceEntryName, 123, 456, 100);

Expand All@@ -150,6 +151,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 256,
 decodedBodySize: 256,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
 });
 _addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 456, 100);

Expand All@@ -169,6 +171,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 456,
 decodedBodySize: 593,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
 });

 const timeOrigin = 100;
Expand All@@ -195,6 +198,8 @@ describe('_addResourceSpans', () => {
 ['url.scheme']: 'https',
 ['server.address']: 'example.com',
 ['url.same_origin']: true,
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '1.1',
 },
 }),
 );
Expand DownExpand Up@@ -233,6 +238,7 @@ describe('_addResourceSpans', () => {
 const { initiatorType, op } = table[i]!;
 const entry = mockPerformanceResourceTiming({
 initiatorType,
 nextHopProtocol: 'http/1.1',
 });
 _addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 234, 465);

Expand All@@ -254,6 +260,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 0,
 decodedBodySize: 0,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'h2',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -271,6 +278,8 @@ describe('_addResourceSpans', () => {
 ['url.scheme']: 'https',
 ['server.address']: 'example.com',
 ['url.same_origin']: true,
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '2',
 },
 }),
 );
Expand All@@ -288,6 +297,7 @@ describe('_addResourceSpans', () => {
 transferSize: 2147483647,
 encodedBodySize: 2147483647,
 decodedBodySize: 2147483647,
 nextHopProtocol: 'h3',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -301,6 +311,8 @@ describe('_addResourceSpans', () => {
 'server.address': 'example.com',
 'url.same_origin': true,
 'url.scheme': 'https',
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '3',
 },
 description: '/assets/to/css',
 timestamp: 468,
Expand All@@ -325,6 +337,7 @@ describe('_addResourceSpans', () => {
 transferSize: null,
 encodedBodySize: null,
 decodedBodySize: null,
 nextHopProtocol: 'h3',
 } as unknown as PerformanceResourceTiming;

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -338,6 +351,8 @@ describe('_addResourceSpans', () => {
 'server.address': 'example.com',
 'url.same_origin': true,
 'url.scheme': 'https',
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '3',
 },
 description: '/assets/to/css',
 timestamp: 468,
Expand DownExpand Up@@ -365,6 +380,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 0,
 decodedBodySize: 0,
 deliveryType,
 nextHopProtocol: 'h3',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand Down

43 changes: 42 additions & 1 deletion
packages/browser-utils/test/browser/utils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { SentrySpan, getCurrentScope, getIsolationScope, setCurrentClient, spanToJSON } from '@sentry/core';
import { startAndEndSpan } from '../../src/metrics/utils';
import { extractNetworkProtocol, startAndEndSpan } from '../../src/metrics/utils';
import { TestClient, getDefaultClientOptions } from '../utils/TestClient';

describe('startAndEndSpan()', () => {
Expand DownExpand Up@@ -54,3 +54,44 @@ describe('startAndEndSpan()', () => {
 expect(spanToJSON(parentSpan).start_timestamp).toEqual(123);
 });
});

describe('HTTPTimings', () => {
 test.each([
 ['http/0.9', { name: 'http', version: '0.9' }],
 ['http/1.0', { name: 'http', version: '1.0' }],
 ['http/1.1', { name: 'http', version: '1.1' }],
 ['spdy/1', { name: 'spdy', version: '1' }],
 ['spdy/2', { name: 'spdy', version: '2' }],
 ['spdy/3', { name: 'spdy', version: '3' }],
 ['stun.turn', { name: 'stun.turn', version: 'unknown' }],
 ['stun.nat-discovery', { name: 'stun.nat-discovery', version: 'unknown' }],
 ['h2', { name: 'http', version: '2' }],
 ['h2c', { name: 'http', version: '2c' }],
 ['webrtc', { name: 'webrtc', version: 'unknown' }],
 ['c-webrtc', { name: 'c-webrtc', version: 'unknown' }],
 ['ftp', { name: 'ftp', version: 'unknown' }],
 ['imap', { name: 'imap', version: 'unknown' }],
 ['pop3', { name: 'pop', version: '3' }],
 ['managesieve', { name: 'managesieve', version: 'unknown' }],
 ['coap', { name: 'coap', version: 'unknown' }],
 ['xmpp-client', { name: 'xmpp-client', version: 'unknown' }],
 ['xmpp-server', { name: 'xmpp-server', version: 'unknown' }],
 ['acme-tls/1', { name: 'acme-tls', version: '1' }],
 ['mqtt', { name: 'mqtt', version: 'unknown' }],
 ['dot', { name: 'dot', version: 'unknown' }],
 ['ntske/1', { name: 'ntske', version: '1' }],
 ['sunrpc', { name: 'sunrpc', version: 'unknown' }],
 ['h3', { name: 'http', version: '3' }],
 ['smb', { name: 'smb', version: 'unknown' }],
 ['irc', { name: 'irc', version: 'unknown' }],
 ['nntp', { name: 'nntp', version: 'unknown' }],
 ['nnsp', { name: 'nnsp', version: 'unknown' }],
 ['doq', { name: 'doq', version: 'unknown' }],
 ['sip/2', { name: 'sip', version: '2' }],
 ['tds/8.0', { name: 'tds', version: '8.0' }],
 ['dicom', { name: 'dicom', version: 'unknown' }],
 ['', { name: '', version: 'unknown' }],
@Lms24Lms24Jan 27, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.
I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.
 ])('Extracting version from ALPN protocol %s', (protocol, expected) => {
 expect(extractNetworkProtocol(protocol)).toMatchObject(expected);
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ref(browser): Add protocol attributes to resource spans#15161

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

Lms24
merged 4 commits into

from

Jan 29, 2025
 Merged


ref(browser): Add protocol attributes to resource spans
#15161
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fcbbe45

ref(browser): Add protocol metadata to resource spans


Zen-cronic Jan 26, 2025
87932e7

refactor unit tests, strengthen integration test


Lms24 Jan 27, 2025
49ac3b2

formatting


Lms24 Jan 27, 2025
b75eb03

fix for webkit integration test run


Lms24 Jan 27, 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


130 changes: 116 additions & 14 deletions
...packages/browser-integration-tests/suites/tracing/metrics/pageload-resource-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,44 @@
import type { Route } from '@playwright/test';
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';
import { type Event, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';

sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page }) => {
sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page, browserName }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

 const isWebkitRun = browserName === 'webkit';

 // Intercepting asset requests to avoid network-related flakiness and random retries (on Firefox).
 await page.route('https://example.com/path/to/image.svg', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/image.svg` }),
 route.fulfill({
 path: `${__dirname}/assets/image.svg`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'image/svg+xml',
 },
 }),
 );
 await page.route('https://example.com/path/to/script.js', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/script.js` }),
 route.fulfill({
 path: `${__dirname}/assets/script.js`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'application/javascript',
 },
 }),
 );
 await page.route('https://example.com/path/to/style.css', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/style.css` }),
 route.fulfill({
 path: `${__dirname}/assets/style.css`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'text/css',
 },
 }),
 );

 const url = await getLocalTestUrl({ testDir: __dirname });
Expand All@@ -27,11 +47,14 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
 const resourceSpans = eventData.spans?.filter(({ op }) => op?.startsWith('resource'));

 const scriptSpans = resourceSpans?.filter(({ op }) => op === 'resource.script');
 const linkSpans = resourceSpans?.filter(({ op }) => op === 'resource.link');
 const imgSpans = resourceSpans?.filter(({ op }) => op === 'resource.img');
 const linkSpan = resourceSpans?.filter(({ op }) => op === 'resource.link')[0];
 const imgSpan = resourceSpans?.filter(({ op }) => op === 'resource.img')[0];

 const spanId = eventData.contexts?.trace?.span_id;
 const traceId = eventData.contexts?.trace?.trace_id;

 expect(imgSpans).toHaveLength(1);
 expect(linkSpans).toHaveLength(1);
 expect(spanId).toBeDefined();
 expect(traceId).toBeDefined();

 const hasCdnBundle = (process.env.PW_BUNDLE || '').startsWith('bundle');

Expand All@@ -41,11 +64,90 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
 }

 expect(scriptSpans?.map(({ description }) => description).sort()).toEqual(expectedScripts);
 expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));

 const spanId = eventData.contexts?.trace?.span_id;
 const customScriptSpan = scriptSpans?.find(
 ({ description }) => description === 'https://example.com/path/to/script.js',
 );

 expect(spanId).toBeDefined();
 expect(imgSpans?.[0].parent_span_id).toBe(spanId);
 expect(linkSpans?.[0].parent_span_id).toBe(spanId);
 expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));
 expect(imgSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.img',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/image.svg',
 op: 'resource.img',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });

 expect(linkSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.link',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/style.css',
 op: 'resource.link',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });

 expect(customScriptSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 'sentry.op': 'resource.script',
 'sentry.origin': 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/script.js',
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });
});

2 changes: 2 additions & 0 deletions
packages/browser-utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ export {
 registerInpInteractionListener,
} from './metrics/browserMetrics';

export { extractNetworkProtocol } from './metrics/utils';

export { addClickKeypressInstrumentationHandler } from './instrument/dom';

export { addHistoryInstrumentationHandler } from './instrument/history';
Expand Down

12 changes: 11 additions & 1 deletion
packages/browser-utils/src/metrics/browserMetrics.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,13 @@ import {
 addPerformanceInstrumentationHandler,
 addTtfbInstrumentationHandler,
} from './instrument';
import { getBrowserPerformanceAPI, isMeasurementValue, msToSec, startAndEndSpan } from './utils';
import {
 extractNetworkProtocol,
 getBrowserPerformanceAPI,
 isMeasurementValue,
 msToSec,
 startAndEndSpan,
} from './utils';
import { getActivationStart } from './web-vitals/lib/getActivationStart';
import { getNavigationEntry } from './web-vitals/lib/getNavigationEntry';
import { getVisibilityWatcher } from './web-vitals/lib/getVisibilityWatcher';
Expand DownExpand Up@@ -596,6 +602,10 @@ export function _addResourceSpans(

 attributes['url.same_origin'] = resourceUrl.includes(WINDOW.location.origin);

 const { name, version } = extractNetworkProtocol(entry.nextHopProtocol);
 attributes['network.protocol.name'] = name;
 attributes['network.protocol.version'] = version;

 const startTimestamp = timeOrigin + startTime;
 const endTimestamp = startTimestamp + duration;

Expand Down

31 changes: 31 additions & 0 deletions
packages/browser-utils/src/metrics/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -137,3 +137,34 @@ export function getBrowserPerformanceAPI(): Performance | undefined {
export function msToSec(time: number): number {
 return time / 1000;
}

/**
 * Converts ALPN protocol ids to name and version.
 *
 * (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids)
 * @param nextHopProtocol PerformanceResourceTiming.nextHopProtocol
 */
export function extractNetworkProtocol(nextHopProtocol: string): { name: string; version: string } {
 let name = 'unknown';
 let version = 'unknown';
 let _name = '';
 for (const char of nextHopProtocol) {
 // http/1.1 etc.
 if (char === '/') {
 [name, version] = nextHopProtocol.split('/') as [string, string];
 break;
 }
 // h2, h3 etc.
 if (!isNaN(Number(char))) {
 name = _name === 'h' ? 'http' : _name;
 version = nextHopProtocol.split(_name)[1] as string;
 break;
 }
 _name += char;
 }
 if (_name === nextHopProtocol) {
 // webrtc, ftp, etc.
 name = _name;
 }
 return { name, version };
}

16 changes: 16 additions & 0 deletions
packages/browser-utils/test/browser/browserMetrics.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 256,
 decodedBodySize: 256,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
@Zen-cronicZen-cronicJan 26, 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 prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:
sentry-javascript/packages/browser/src/tracing/request.ts

Line 241
in
a67d3ca
for(constcharofnextHopProtocol){
@Lms24Lms24Jan 27, 2025•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.
 });
 _addResourceSpans(span, entry, resourceEntryName, 123, 456, 100);

Expand All@@ -150,6 +151,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 256,
 decodedBodySize: 256,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
 });
 _addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 456, 100);

Expand All@@ -169,6 +171,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 456,
 decodedBodySize: 593,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
 });

 const timeOrigin = 100;
Expand All@@ -195,6 +198,8 @@ describe('_addResourceSpans', () => {
 ['url.scheme']: 'https',
 ['server.address']: 'example.com',
 ['url.same_origin']: true,
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '1.1',
 },
 }),
 );
Expand DownExpand Up@@ -233,6 +238,7 @@ describe('_addResourceSpans', () => {
 const { initiatorType, op } = table[i]!;
 const entry = mockPerformanceResourceTiming({
 initiatorType,
 nextHopProtocol: 'http/1.1',
 });
 _addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 234, 465);

Expand All@@ -254,6 +260,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 0,
 decodedBodySize: 0,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'h2',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -271,6 +278,8 @@ describe('_addResourceSpans', () => {
 ['url.scheme']: 'https',
 ['server.address']: 'example.com',
 ['url.same_origin']: true,
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '2',
 },
 }),
 );
Expand All@@ -288,6 +297,7 @@ describe('_addResourceSpans', () => {
 transferSize: 2147483647,
 encodedBodySize: 2147483647,
 decodedBodySize: 2147483647,
 nextHopProtocol: 'h3',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -301,6 +311,8 @@ describe('_addResourceSpans', () => {
 'server.address': 'example.com',
 'url.same_origin': true,
 'url.scheme': 'https',
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '3',
 },
 description: '/assets/to/css',
 timestamp: 468,
Expand All@@ -325,6 +337,7 @@ describe('_addResourceSpans', () => {
 transferSize: null,
 encodedBodySize: null,
 decodedBodySize: null,
 nextHopProtocol: 'h3',
 } as unknown as PerformanceResourceTiming;

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -338,6 +351,8 @@ describe('_addResourceSpans', () => {
 'server.address': 'example.com',
 'url.same_origin': true,
 'url.scheme': 'https',
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '3',
 },
 description: '/assets/to/css',
 timestamp: 468,
Expand DownExpand Up@@ -365,6 +380,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 0,
 decodedBodySize: 0,
 deliveryType,
 nextHopProtocol: 'h3',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand Down

43 changes: 42 additions & 1 deletion
packages/browser-utils/test/browser/utils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { SentrySpan, getCurrentScope, getIsolationScope, setCurrentClient, spanToJSON } from '@sentry/core';
import { startAndEndSpan } from '../../src/metrics/utils';
import { extractNetworkProtocol, startAndEndSpan } from '../../src/metrics/utils';
import { TestClient, getDefaultClientOptions } from '../utils/TestClient';

describe('startAndEndSpan()', () => {
Expand DownExpand Up@@ -54,3 +54,44 @@ describe('startAndEndSpan()', () => {
 expect(spanToJSON(parentSpan).start_timestamp).toEqual(123);
 });
});

describe('HTTPTimings', () => {
 test.each([
 ['http/0.9', { name: 'http', version: '0.9' }],
 ['http/1.0', { name: 'http', version: '1.0' }],
 ['http/1.1', { name: 'http', version: '1.1' }],
 ['spdy/1', { name: 'spdy', version: '1' }],
 ['spdy/2', { name: 'spdy', version: '2' }],
 ['spdy/3', { name: 'spdy', version: '3' }],
 ['stun.turn', { name: 'stun.turn', version: 'unknown' }],
 ['stun.nat-discovery', { name: 'stun.nat-discovery', version: 'unknown' }],
 ['h2', { name: 'http', version: '2' }],
 ['h2c', { name: 'http', version: '2c' }],
 ['webrtc', { name: 'webrtc', version: 'unknown' }],
 ['c-webrtc', { name: 'c-webrtc', version: 'unknown' }],
 ['ftp', { name: 'ftp', version: 'unknown' }],
 ['imap', { name: 'imap', version: 'unknown' }],
 ['pop3', { name: 'pop', version: '3' }],
 ['managesieve', { name: 'managesieve', version: 'unknown' }],
 ['coap', { name: 'coap', version: 'unknown' }],
 ['xmpp-client', { name: 'xmpp-client', version: 'unknown' }],
 ['xmpp-server', { name: 'xmpp-server', version: 'unknown' }],
 ['acme-tls/1', { name: 'acme-tls', version: '1' }],
 ['mqtt', { name: 'mqtt', version: 'unknown' }],
 ['dot', { name: 'dot', version: 'unknown' }],
 ['ntske/1', { name: 'ntske', version: '1' }],
 ['sunrpc', { name: 'sunrpc', version: 'unknown' }],
 ['h3', { name: 'http', version: '3' }],
 ['smb', { name: 'smb', version: 'unknown' }],
 ['irc', { name: 'irc', version: 'unknown' }],
 ['nntp', { name: 'nntp', version: 'unknown' }],
 ['nnsp', { name: 'nnsp', version: 'unknown' }],
 ['doq', { name: 'doq', version: 'unknown' }],
 ['sip/2', { name: 'sip', version: '2' }],
 ['tds/8.0', { name: 'tds', version: '8.0' }],
 ['dicom', { name: 'dicom', version: 'unknown' }],
 ['', { name: '', version: 'unknown' }],
@Lms24Lms24Jan 27, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.
I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.
 ])('Extracting version from ALPN protocol %s', (protocol, expected) => {
 expect(extractNetworkProtocol(protocol)).toMatchObject(expected);
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ref(browser): Add protocol attributes to resource spans#15161

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

Lms24
merged 4 commits into

from

Jan 29, 2025
 Merged


ref(browser): Add protocol attributes to resource spans
#15161
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fcbbe45

ref(browser): Add protocol metadata to resource spans


Zen-cronic Jan 26, 2025
87932e7

refactor unit tests, strengthen integration test


Lms24 Jan 27, 2025
49ac3b2

formatting


Lms24 Jan 27, 2025
b75eb03

fix for webkit integration test run


Lms24 Jan 27, 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


130 changes: 116 additions & 14 deletions
...packages/browser-integration-tests/suites/tracing/metrics/pageload-resource-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,44 @@
import type { Route } from '@playwright/test';
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';
import { type Event, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';

sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page }) => {
sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page, browserName }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

 const isWebkitRun = browserName === 'webkit';

 // Intercepting asset requests to avoid network-related flakiness and random retries (on Firefox).
 await page.route('https://example.com/path/to/image.svg', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/image.svg` }),
 route.fulfill({
 path: `${__dirname}/assets/image.svg`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'image/svg+xml',
 },
 }),
 );
 await page.route('https://example.com/path/to/script.js', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/script.js` }),
 route.fulfill({
 path: `${__dirname}/assets/script.js`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'application/javascript',
 },
 }),
 );
 await page.route('https://example.com/path/to/style.css', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/style.css` }),
 route.fulfill({
 path: `${__dirname}/assets/style.css`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'text/css',
 },
 }),
 );

 const url = await getLocalTestUrl({ testDir: __dirname });
Expand All@@ -27,11 +47,14 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
 const resourceSpans = eventData.spans?.filter(({ op }) => op?.startsWith('resource'));

 const scriptSpans = resourceSpans?.filter(({ op }) => op === 'resource.script');
 const linkSpans = resourceSpans?.filter(({ op }) => op === 'resource.link');
 const imgSpans = resourceSpans?.filter(({ op }) => op === 'resource.img');
 const linkSpan = resourceSpans?.filter(({ op }) => op === 'resource.link')[0];
 const imgSpan = resourceSpans?.filter(({ op }) => op === 'resource.img')[0];

 const spanId = eventData.contexts?.trace?.span_id;
 const traceId = eventData.contexts?.trace?.trace_id;

 expect(imgSpans).toHaveLength(1);
 expect(linkSpans).toHaveLength(1);
 expect(spanId).toBeDefined();
 expect(traceId).toBeDefined();

 const hasCdnBundle = (process.env.PW_BUNDLE || '').startsWith('bundle');

Expand All@@ -41,11 +64,90 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
 }

 expect(scriptSpans?.map(({ description }) => description).sort()).toEqual(expectedScripts);
 expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));

 const spanId = eventData.contexts?.trace?.span_id;
 const customScriptSpan = scriptSpans?.find(
 ({ description }) => description === 'https://example.com/path/to/script.js',
 );

 expect(spanId).toBeDefined();
 expect(imgSpans?.[0].parent_span_id).toBe(spanId);
 expect(linkSpans?.[0].parent_span_id).toBe(spanId);
 expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));
 expect(imgSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.img',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/image.svg',
 op: 'resource.img',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });

 expect(linkSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.link',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/style.css',
 op: 'resource.link',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });

 expect(customScriptSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 'sentry.op': 'resource.script',
 'sentry.origin': 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/script.js',
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });
});

2 changes: 2 additions & 0 deletions
packages/browser-utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ export {
 registerInpInteractionListener,
} from './metrics/browserMetrics';

export { extractNetworkProtocol } from './metrics/utils';

export { addClickKeypressInstrumentationHandler } from './instrument/dom';

export { addHistoryInstrumentationHandler } from './instrument/history';
Expand Down

12 changes: 11 additions & 1 deletion
packages/browser-utils/src/metrics/browserMetrics.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,13 @@ import {
 addPerformanceInstrumentationHandler,
 addTtfbInstrumentationHandler,
} from './instrument';
import { getBrowserPerformanceAPI, isMeasurementValue, msToSec, startAndEndSpan } from './utils';
import {
 extractNetworkProtocol,
 getBrowserPerformanceAPI,
 isMeasurementValue,
 msToSec,
 startAndEndSpan,
} from './utils';
import { getActivationStart } from './web-vitals/lib/getActivationStart';
import { getNavigationEntry } from './web-vitals/lib/getNavigationEntry';
import { getVisibilityWatcher } from './web-vitals/lib/getVisibilityWatcher';
Expand DownExpand Up@@ -596,6 +602,10 @@ export function _addResourceSpans(

 attributes['url.same_origin'] = resourceUrl.includes(WINDOW.location.origin);

 const { name, version } = extractNetworkProtocol(entry.nextHopProtocol);
 attributes['network.protocol.name'] = name;
 attributes['network.protocol.version'] = version;

 const startTimestamp = timeOrigin + startTime;
 const endTimestamp = startTimestamp + duration;

Expand Down

31 changes: 31 additions & 0 deletions
packages/browser-utils/src/metrics/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -137,3 +137,34 @@ export function getBrowserPerformanceAPI(): Performance | undefined {
export function msToSec(time: number): number {
 return time / 1000;
}

/**
 * Converts ALPN protocol ids to name and version.
 *
 * (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids)
 * @param nextHopProtocol PerformanceResourceTiming.nextHopProtocol
 */
export function extractNetworkProtocol(nextHopProtocol: string): { name: string; version: string } {
 let name = 'unknown';
 let version = 'unknown';
 let _name = '';
 for (const char of nextHopProtocol) {
 // http/1.1 etc.
 if (char === '/') {
 [name, version] = nextHopProtocol.split('/') as [string, string];
 break;
 }
 // h2, h3 etc.
 if (!isNaN(Number(char))) {
 name = _name === 'h' ? 'http' : _name;
 version = nextHopProtocol.split(_name)[1] as string;
 break;
 }
 _name += char;
 }
 if (_name === nextHopProtocol) {
 // webrtc, ftp, etc.
 name = _name;
 }
 return { name, version };
}

16 changes: 16 additions & 0 deletions
packages/browser-utils/test/browser/browserMetrics.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 256,
 decodedBodySize: 256,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
@Zen-cronicZen-cronicJan 26, 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 prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:
sentry-javascript/packages/browser/src/tracing/request.ts

Line 241
in
a67d3ca
for(constcharofnextHopProtocol){
@Lms24Lms24Jan 27, 2025•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.
 });
 _addResourceSpans(span, entry, resourceEntryName, 123, 456, 100);

Expand All@@ -150,6 +151,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 256,
 decodedBodySize: 256,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
 });
 _addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 456, 100);

Expand All@@ -169,6 +171,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 456,
 decodedBodySize: 593,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
 });

 const timeOrigin = 100;
Expand All@@ -195,6 +198,8 @@ describe('_addResourceSpans', () => {
 ['url.scheme']: 'https',
 ['server.address']: 'example.com',
 ['url.same_origin']: true,
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '1.1',
 },
 }),
 );
Expand DownExpand Up@@ -233,6 +238,7 @@ describe('_addResourceSpans', () => {
 const { initiatorType, op } = table[i]!;
 const entry = mockPerformanceResourceTiming({
 initiatorType,
 nextHopProtocol: 'http/1.1',
 });
 _addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 234, 465);

Expand All@@ -254,6 +260,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 0,
 decodedBodySize: 0,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'h2',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -271,6 +278,8 @@ describe('_addResourceSpans', () => {
 ['url.scheme']: 'https',
 ['server.address']: 'example.com',
 ['url.same_origin']: true,
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '2',
 },
 }),
 );
Expand All@@ -288,6 +297,7 @@ describe('_addResourceSpans', () => {
 transferSize: 2147483647,
 encodedBodySize: 2147483647,
 decodedBodySize: 2147483647,
 nextHopProtocol: 'h3',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -301,6 +311,8 @@ describe('_addResourceSpans', () => {
 'server.address': 'example.com',
 'url.same_origin': true,
 'url.scheme': 'https',
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '3',
 },
 description: '/assets/to/css',
 timestamp: 468,
Expand All@@ -325,6 +337,7 @@ describe('_addResourceSpans', () => {
 transferSize: null,
 encodedBodySize: null,
 decodedBodySize: null,
 nextHopProtocol: 'h3',
 } as unknown as PerformanceResourceTiming;

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -338,6 +351,8 @@ describe('_addResourceSpans', () => {
 'server.address': 'example.com',
 'url.same_origin': true,
 'url.scheme': 'https',
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '3',
 },
 description: '/assets/to/css',
 timestamp: 468,
Expand DownExpand Up@@ -365,6 +380,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 0,
 decodedBodySize: 0,
 deliveryType,
 nextHopProtocol: 'h3',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand Down

43 changes: 42 additions & 1 deletion
packages/browser-utils/test/browser/utils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { SentrySpan, getCurrentScope, getIsolationScope, setCurrentClient, spanToJSON } from '@sentry/core';
import { startAndEndSpan } from '../../src/metrics/utils';
import { extractNetworkProtocol, startAndEndSpan } from '../../src/metrics/utils';
import { TestClient, getDefaultClientOptions } from '../utils/TestClient';

describe('startAndEndSpan()', () => {
Expand DownExpand Up@@ -54,3 +54,44 @@ describe('startAndEndSpan()', () => {
 expect(spanToJSON(parentSpan).start_timestamp).toEqual(123);
 });
});

describe('HTTPTimings', () => {
 test.each([
 ['http/0.9', { name: 'http', version: '0.9' }],
 ['http/1.0', { name: 'http', version: '1.0' }],
 ['http/1.1', { name: 'http', version: '1.1' }],
 ['spdy/1', { name: 'spdy', version: '1' }],
 ['spdy/2', { name: 'spdy', version: '2' }],
 ['spdy/3', { name: 'spdy', version: '3' }],
 ['stun.turn', { name: 'stun.turn', version: 'unknown' }],
 ['stun.nat-discovery', { name: 'stun.nat-discovery', version: 'unknown' }],
 ['h2', { name: 'http', version: '2' }],
 ['h2c', { name: 'http', version: '2c' }],
 ['webrtc', { name: 'webrtc', version: 'unknown' }],
 ['c-webrtc', { name: 'c-webrtc', version: 'unknown' }],
 ['ftp', { name: 'ftp', version: 'unknown' }],
 ['imap', { name: 'imap', version: 'unknown' }],
 ['pop3', { name: 'pop', version: '3' }],
 ['managesieve', { name: 'managesieve', version: 'unknown' }],
 ['coap', { name: 'coap', version: 'unknown' }],
 ['xmpp-client', { name: 'xmpp-client', version: 'unknown' }],
 ['xmpp-server', { name: 'xmpp-server', version: 'unknown' }],
 ['acme-tls/1', { name: 'acme-tls', version: '1' }],
 ['mqtt', { name: 'mqtt', version: 'unknown' }],
 ['dot', { name: 'dot', version: 'unknown' }],
 ['ntske/1', { name: 'ntske', version: '1' }],
 ['sunrpc', { name: 'sunrpc', version: 'unknown' }],
 ['h3', { name: 'http', version: '3' }],
 ['smb', { name: 'smb', version: 'unknown' }],
 ['irc', { name: 'irc', version: 'unknown' }],
 ['nntp', { name: 'nntp', version: 'unknown' }],
 ['nnsp', { name: 'nnsp', version: 'unknown' }],
 ['doq', { name: 'doq', version: 'unknown' }],
 ['sip/2', { name: 'sip', version: '2' }],
 ['tds/8.0', { name: 'tds', version: '8.0' }],
 ['dicom', { name: 'dicom', version: 'unknown' }],
 ['', { name: '', version: 'unknown' }],
@Lms24Lms24Jan 27, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.
I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.
 ])('Extracting version from ALPN protocol %s', (protocol, expected) => {
 expect(extractNetworkProtocol(protocol)).toMatchObject(expected);
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
ref(browser): Add protocol attributes to resource spans#15161

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

Lms24
merged 4 commits into

from

Jan 29, 2025
 Merged


ref(browser): Add protocol attributes to resource spans
#15161
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fcbbe45

ref(browser): Add protocol metadata to resource spans


Zen-cronic Jan 26, 2025
87932e7

refactor unit tests, strengthen integration test


Lms24 Jan 27, 2025
49ac3b2

formatting


Lms24 Jan 27, 2025
b75eb03

fix for webkit integration test run


Lms24 Jan 27, 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


130 changes: 116 additions & 14 deletions
...packages/browser-integration-tests/suites/tracing/metrics/pageload-resource-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,44 @@
import type { Route } from '@playwright/test';
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';
import { type Event, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';

sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page }) => {
sentryTest('should add resource spans to pageload transaction', async ({ getLocalTestUrl, page, browserName }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

 const isWebkitRun = browserName === 'webkit';

 // Intercepting asset requests to avoid network-related flakiness and random retries (on Firefox).
 await page.route('https://example.com/path/to/image.svg', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/image.svg` }),
 route.fulfill({
 path: `${__dirname}/assets/image.svg`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'image/svg+xml',
 },
 }),
 );
 await page.route('https://example.com/path/to/script.js', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/script.js` }),
 route.fulfill({
 path: `${__dirname}/assets/script.js`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'application/javascript',
 },
 }),
 );
 await page.route('https://example.com/path/to/style.css', (route: Route) =>
 route.fulfill({ path: `${__dirname}/assets/style.css` }),
 route.fulfill({
 path: `${__dirname}/assets/style.css`,
 headers: {
 'Timing-Allow-Origin': '*',
 'Content-Type': 'text/css',
 },
 }),
 );

 const url = await getLocalTestUrl({ testDir: __dirname });
Expand All@@ -27,11 +47,14 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
 const resourceSpans = eventData.spans?.filter(({ op }) => op?.startsWith('resource'));

 const scriptSpans = resourceSpans?.filter(({ op }) => op === 'resource.script');
 const linkSpans = resourceSpans?.filter(({ op }) => op === 'resource.link');
 const imgSpans = resourceSpans?.filter(({ op }) => op === 'resource.img');
 const linkSpan = resourceSpans?.filter(({ op }) => op === 'resource.link')[0];
 const imgSpan = resourceSpans?.filter(({ op }) => op === 'resource.img')[0];

 const spanId = eventData.contexts?.trace?.span_id;
 const traceId = eventData.contexts?.trace?.trace_id;

 expect(imgSpans).toHaveLength(1);
 expect(linkSpans).toHaveLength(1);
 expect(spanId).toBeDefined();
 expect(traceId).toBeDefined();

 const hasCdnBundle = (process.env.PW_BUNDLE || '').startsWith('bundle');

Expand All@@ -41,11 +64,90 @@ sentryTest('should add resource spans to pageload transaction', async ({ getLoca
 }

 expect(scriptSpans?.map(({ description }) => description).sort()).toEqual(expectedScripts);
 expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));

 const spanId = eventData.contexts?.trace?.span_id;
 const customScriptSpan = scriptSpans?.find(
 ({ description }) => description === 'https://example.com/path/to/script.js',
 );

 expect(spanId).toBeDefined();
 expect(imgSpans?.[0].parent_span_id).toBe(spanId);
 expect(linkSpans?.[0].parent_span_id).toBe(spanId);
 expect(scriptSpans?.map(({ parent_span_id }) => parent_span_id)).toEqual(expectedScripts.map(() => spanId));
 expect(imgSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.img',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/image.svg',
 op: 'resource.img',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });

 expect(linkSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.link',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/style.css',
 op: 'resource.link',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });

 expect(customScriptSpan).toEqual({
 data: {
 'http.decoded_response_content_length': expect.any(Number),
 'http.response_content_length': expect.any(Number),
 'http.response_transfer_size': expect.any(Number),
 'network.protocol.name': '',
 'network.protocol.version': 'unknown',
 'sentry.op': 'resource.script',
 'sentry.origin': 'auto.resource.browser.metrics',
 'server.address': 'example.com',
 'url.same_origin': false,
 'url.scheme': 'https',
 ...(!isWebkitRun && {
 'resource.render_blocking_status': 'non-blocking',
 'http.response_delivery_type': '',
 }),
 },
 description: 'https://example.com/path/to/script.js',
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 parent_span_id: spanId,
 span_id: expect.stringMatching(/^[a-f0-9]{16}$/),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: traceId,
 });
});

2 changes: 2 additions & 0 deletions
packages/browser-utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,8 @@ export {
 registerInpInteractionListener,
} from './metrics/browserMetrics';

export { extractNetworkProtocol } from './metrics/utils';

export { addClickKeypressInstrumentationHandler } from './instrument/dom';

export { addHistoryInstrumentationHandler } from './instrument/history';
Expand Down

12 changes: 11 additions & 1 deletion
packages/browser-utils/src/metrics/browserMetrics.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,13 @@ import {
 addPerformanceInstrumentationHandler,
 addTtfbInstrumentationHandler,
} from './instrument';
import { getBrowserPerformanceAPI, isMeasurementValue, msToSec, startAndEndSpan } from './utils';
import {
 extractNetworkProtocol,
 getBrowserPerformanceAPI,
 isMeasurementValue,
 msToSec,
 startAndEndSpan,
} from './utils';
import { getActivationStart } from './web-vitals/lib/getActivationStart';
import { getNavigationEntry } from './web-vitals/lib/getNavigationEntry';
import { getVisibilityWatcher } from './web-vitals/lib/getVisibilityWatcher';
Expand DownExpand Up@@ -596,6 +602,10 @@ export function _addResourceSpans(

 attributes['url.same_origin'] = resourceUrl.includes(WINDOW.location.origin);

 const { name, version } = extractNetworkProtocol(entry.nextHopProtocol);
 attributes['network.protocol.name'] = name;
 attributes['network.protocol.version'] = version;

 const startTimestamp = timeOrigin + startTime;
 const endTimestamp = startTimestamp + duration;

Expand Down

31 changes: 31 additions & 0 deletions
packages/browser-utils/src/metrics/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -137,3 +137,34 @@ export function getBrowserPerformanceAPI(): Performance | undefined {
export function msToSec(time: number): number {
 return time / 1000;
}

/**
 * Converts ALPN protocol ids to name and version.
 *
 * (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids)
 * @param nextHopProtocol PerformanceResourceTiming.nextHopProtocol
 */
export function extractNetworkProtocol(nextHopProtocol: string): { name: string; version: string } {
 let name = 'unknown';
 let version = 'unknown';
 let _name = '';
 for (const char of nextHopProtocol) {
 // http/1.1 etc.
 if (char === '/') {
 [name, version] = nextHopProtocol.split('/') as [string, string];
 break;
 }
 // h2, h3 etc.
 if (!isNaN(Number(char))) {
 name = _name === 'h' ? 'http' : _name;
 version = nextHopProtocol.split(_name)[1] as string;
 break;
 }
 _name += char;
 }
 if (_name === nextHopProtocol) {
 // webrtc, ftp, etc.
 name = _name;
 }
 return { name, version };
}

16 changes: 16 additions & 0 deletions
packages/browser-utils/test/browser/browserMetrics.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 256,
 decodedBodySize: 256,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
@Zen-cronicZen-cronicJan 26, 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 prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:
sentry-javascript/packages/browser/src/tracing/request.ts

Line 241
in
a67d3ca
for(constcharofnextHopProtocol){
@Lms24Lms24Jan 27, 2025•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.
 });
 _addResourceSpans(span, entry, resourceEntryName, 123, 456, 100);

Expand All@@ -150,6 +151,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 256,
 decodedBodySize: 256,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
 });
 _addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 456, 100);

Expand All@@ -169,6 +171,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 456,
 decodedBodySize: 593,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'http/1.1',
 });

 const timeOrigin = 100;
Expand All@@ -195,6 +198,8 @@ describe('_addResourceSpans', () => {
 ['url.scheme']: 'https',
 ['server.address']: 'example.com',
 ['url.same_origin']: true,
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '1.1',
 },
 }),
 );
Expand DownExpand Up@@ -233,6 +238,7 @@ describe('_addResourceSpans', () => {
 const { initiatorType, op } = table[i]!;
 const entry = mockPerformanceResourceTiming({
 initiatorType,
 nextHopProtocol: 'http/1.1',
 });
 _addResourceSpans(span, entry, 'https://example.com/assets/to/me', 123, 234, 465);

Expand All@@ -254,6 +260,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 0,
 decodedBodySize: 0,
 renderBlockingStatus: 'non-blocking',
 nextHopProtocol: 'h2',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -271,6 +278,8 @@ describe('_addResourceSpans', () => {
 ['url.scheme']: 'https',
 ['server.address']: 'example.com',
 ['url.same_origin']: true,
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '2',
 },
 }),
 );
Expand All@@ -288,6 +297,7 @@ describe('_addResourceSpans', () => {
 transferSize: 2147483647,
 encodedBodySize: 2147483647,
 decodedBodySize: 2147483647,
 nextHopProtocol: 'h3',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -301,6 +311,8 @@ describe('_addResourceSpans', () => {
 'server.address': 'example.com',
 'url.same_origin': true,
 'url.scheme': 'https',
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '3',
 },
 description: '/assets/to/css',
 timestamp: 468,
Expand All@@ -325,6 +337,7 @@ describe('_addResourceSpans', () => {
 transferSize: null,
 encodedBodySize: null,
 decodedBodySize: null,
 nextHopProtocol: 'h3',
 } as unknown as PerformanceResourceTiming;

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand All@@ -338,6 +351,8 @@ describe('_addResourceSpans', () => {
 'server.address': 'example.com',
 'url.same_origin': true,
 'url.scheme': 'https',
 ['network.protocol.name']: 'http',
 ['network.protocol.version']: '3',
 },
 description: '/assets/to/css',
 timestamp: 468,
Expand DownExpand Up@@ -365,6 +380,7 @@ describe('_addResourceSpans', () => {
 encodedBodySize: 0,
 decodedBodySize: 0,
 deliveryType,
 nextHopProtocol: 'h3',
 });

 _addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);
Expand Down

43 changes: 42 additions & 1 deletion
packages/browser-utils/test/browser/utils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { SentrySpan, getCurrentScope, getIsolationScope, setCurrentClient, spanToJSON } from '@sentry/core';
import { startAndEndSpan } from '../../src/metrics/utils';
import { extractNetworkProtocol, startAndEndSpan } from '../../src/metrics/utils';
import { TestClient, getDefaultClientOptions } from '../utils/TestClient';

describe('startAndEndSpan()', () => {
Expand DownExpand Up@@ -54,3 +54,44 @@ describe('startAndEndSpan()', () => {
 expect(spanToJSON(parentSpan).start_timestamp).toEqual(123);
 });
});

describe('HTTPTimings', () => {
 test.each([
 ['http/0.9', { name: 'http', version: '0.9' }],
 ['http/1.0', { name: 'http', version: '1.0' }],
 ['http/1.1', { name: 'http', version: '1.1' }],
 ['spdy/1', { name: 'spdy', version: '1' }],
 ['spdy/2', { name: 'spdy', version: '2' }],
 ['spdy/3', { name: 'spdy', version: '3' }],
 ['stun.turn', { name: 'stun.turn', version: 'unknown' }],
 ['stun.nat-discovery', { name: 'stun.nat-discovery', version: 'unknown' }],
 ['h2', { name: 'http', version: '2' }],
 ['h2c', { name: 'http', version: '2c' }],
 ['webrtc', { name: 'webrtc', version: 'unknown' }],
 ['c-webrtc', { name: 'c-webrtc', version: 'unknown' }],
 ['ftp', { name: 'ftp', version: 'unknown' }],
 ['imap', { name: 'imap', version: 'unknown' }],
 ['pop3', { name: 'pop', version: '3' }],
 ['managesieve', { name: 'managesieve', version: 'unknown' }],
 ['coap', { name: 'coap', version: 'unknown' }],
 ['xmpp-client', { name: 'xmpp-client', version: 'unknown' }],
 ['xmpp-server', { name: 'xmpp-server', version: 'unknown' }],
 ['acme-tls/1', { name: 'acme-tls', version: '1' }],
 ['mqtt', { name: 'mqtt', version: 'unknown' }],
 ['dot', { name: 'dot', version: 'unknown' }],
 ['ntske/1', { name: 'ntske', version: '1' }],
 ['sunrpc', { name: 'sunrpc', version: 'unknown' }],
 ['h3', { name: 'http', version: '3' }],
 ['smb', { name: 'smb', version: 'unknown' }],
 ['irc', { name: 'irc', version: 'unknown' }],
 ['nntp', { name: 'nntp', version: 'unknown' }],
 ['nnsp', { name: 'nnsp', version: 'unknown' }],
 ['doq', { name: 'doq', version: 'unknown' }],
 ['sip/2', { name: 'sip', version: '2' }],
 ['tds/8.0', { name: 'tds', version: '8.0' }],
 ['dicom', { name: 'dicom', version: 'unknown' }],
 ['', { name: '', version: 'unknown' }],
@Lms24Lms24Jan 27, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.
I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.
 ])('Extracting version from ALPN protocol %s', (protocol, expected) => {
 expect(extractNetworkProtocol(protocol)).toMatchObject(expected);
 });
});
Loading