Skip to content

Commit 796daf9

Browse files
Lms24Lms24
authored
Merge pull request #16461 from getsentry/prepare-release/9.25.0
meta: Add Changelog entry for 9.25.0
2 parents e923633 + 880ee29 commit 796daf9

File tree

17 files changed

+262
-105
lines changed

17 files changed

+262
-105
lines changed

‎.github/workflows/build.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,7 @@ jobs:
454454
with:
455455
node-version-file: 'package.json'
456456
- name: Set up Deno
457-
uses: denoland/[email protected].2
457+
uses: denoland/[email protected].3
458458
with:
459459
deno-version: v2.1.5
460460
- name: Restore caches
@@ -886,6 +886,7 @@ jobs:
886886
- uses: pnpm/action-setup@v4
887887
with:
888888
version: 9.4.0
889+
# TODO: Remove this once the repo is bumped to 20.19.2 or higher
889890
- name: Set up Node for Angular 20
890891
if: matrix.test-application == 'angular-20'
891892
uses: actions/setup-node@v4

‎.github/workflows/canary.yml‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,9 @@ jobs:
6969
fail-fast: false
7070
matrix:
7171
include:
72+
- test-application: 'angular-20'
73+
build-command: 'test:build-canary'
74+
label: 'angular-20 (next)'
7275
- test-application: 'create-react-app'
7376
build-command: 'test:build-canary'
7477
label: 'create-react-app (canary)'
@@ -123,8 +126,14 @@ jobs:
123126
- uses: pnpm/action-setup@v4
124127
with:
125128
version: 9.4.0
126-
129+
# TODO: Remove this once the repo is bumped to 20.19.2 or higher
130+
- name: Set up Node for Angular 20
131+
if: matrix.test-application == 'angular-20'
132+
uses: actions/setup-node@v4
133+
with:
134+
node-version: '20.19.2'
127135
- name: Set up Node
136+
if: matrix.test-application != 'angular-20'
128137
uses: actions/setup-node@v4
129138
with:
130139
node-version-file: 'dev-packages/e2e-tests/package.json'

‎CHANGELOG.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,31 @@
1010

1111
- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott
1212

13+
## 9.25.0
14+
15+
### Important Changes
16+
17+
- **feat(browser): Add option to ignore `mark` and `measure` spans ([#16443](https://github.com/getsentry/sentry-javascript/pull/16443))**
18+
19+
This release adds an option to `browserTracingIntegration` that lets you ignore
20+
`mark` and `measure` spans created from the `performance.mark(...)` and `performance.measure(...)` browser APIs:
21+
22+
```js
23+
Sentry.init({
24+
integrations: [
25+
Sentry.browserTracingIntegration({
26+
ignorePerformanceApiSpans: ['measure-to-ignore', /mark-to-ignore/],
27+
}),
28+
],
29+
});
30+
```
31+
32+
### Other Changes
33+
34+
- feat(browser): Export getTraceData from the browser sdks ([#16433](https://github.com/getsentry/sentry-javascript/pull/16433))
35+
- feat(node): Add `includeServerName` option ([#16442](https://github.com/getsentry/sentry-javascript/pull/16442))
36+
- fix(nuxt): Remove setting `@sentry/nuxt` external ([#16444](https://github.com/getsentry/sentry-javascript/pull/16444))
37+
1338
## 9.24.0
1439

1540
### Important Changes

‎dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/ignoreMeasureSpans/init.js‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
import * as Sentry from '@sentry/browser';
2+
3+
window.Sentry = Sentry;
4+
5+
Sentry.init({
6+
dsn: 'https://[email protected]/1337',
7+
integrations: [
8+
Sentry.browserTracingIntegration({
9+
ignorePerformanceApiSpans: ['measure-ignore', /mark-i/],
10+
idleTimeout: 9000,
11+
}),
12+
],
13+
tracesSampleRate: 1,
14+
});
15+
16+
performance.mark('mark-pass');
17+
performance.mark('mark-ignore');
18+
performance.measure('measure-pass');
19+
performance.measure('measure-ignore');

‎dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/ignoreMeasureSpans/test.ts‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
import type { Route } from '@playwright/test';
2+
import { expect } from '@playwright/test';
3+
import { sentryTest } from '../../../../utils/fixtures';
4+
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../utils/helpers';
5+
6+
sentryTest(
7+
'should ignore mark and measure spans that match `ignorePerformanceApiSpans`',
8+
async ({ getLocalTestUrl, page }) => {
9+
if (shouldSkipTracingTest()) {
10+
sentryTest.skip();
11+
}
12+
13+
await page.route('**/path/to/script.js', (route: Route) =>
14+
route.fulfill({ path: `${__dirname}/assets/script.js` }),
15+
);
16+
17+
const url = await getLocalTestUrl({ testDir: __dirname });
18+
19+
const transactionRequestPromise = waitForTransactionRequest(
20+
page,
21+
evt => evt.type === 'transaction' && evt.contexts?.trace?.op === 'pageload',
22+
);
23+
24+
await page.goto(url);
25+
26+
const transactionEvent = envelopeRequestParser(await transactionRequestPromise);
27+
const markAndMeasureSpans = transactionEvent.spans?.filter(({ op }) => op && ['mark', 'measure'].includes(op));
28+
29+
expect(markAndMeasureSpans?.length).toBe(3);
30+
expect(markAndMeasureSpans).toEqual(
31+
expect.arrayContaining([
32+
expect.objectContaining({
33+
description: 'mark-pass',
34+
op: 'mark',
35+
}),
36+
expect.objectContaining({
37+
description: 'measure-pass',
38+
op: 'measure',
39+
}),
40+
expect.objectContaining({
41+
description: 'sentry-tracing-init',
42+
op: 'mark',
43+
}),
44+
]),
45+
);
46+
},
47+
);

‎dev-packages/e2e-tests/test-applications/angular-20/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
"watch": "ng build --watch --configuration development",
1111
"test": "playwright test",
1212
"test:build": "pnpm install && pnpm build",
13+
"test:build-canary": "pnpm install && pnpm add @angular/animations@next @angular/common@next @angular/compiler@next @angular/core@next @angular/forms@next @angular/platform-browser@next @angular/platform-browser-dynamic@next @angular/router@next && pnpm add -D @angular-devkit/build-angular@next @angular/cli@next @angular/compiler-cli@next && pnpm build",
1314
"test:assert": "playwright test",
1415
"clean": "npx rimraf .angular node_modules pnpm-lock.yaml dist"
1516
},

‎dev-packages/e2e-tests/test-applications/node-fastify-4/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"@sentry/core": "latest || *",
1616
"@sentry/opentelemetry": "latest || *",
1717
"@types/node": "^18.19.1",
18-
"fastify": "4.29.0",
18+
"fastify": "4.29.1",
1919
"typescript": "5.6.3",
2020
"ts-node": "10.9.2"
2121
},

‎packages/browser-utils/src/metrics/browserMetrics.ts‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import {
99
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
1010
setMeasurement,
1111
spanToJSON,
12+
stringMatchesSomePattern,
1213
} from '@sentry/core';
1314
import { WINDOW } from '../types';
1415
import { trackClsAsStandaloneSpan } from './cls';
@@ -307,6 +308,15 @@ interface AddPerformanceEntriesOptions {
307308
* Default: []
308309
*/
309310
ignoreResourceSpans: Array<'resouce.script' | 'resource.css' | 'resource.img' | 'resource.other' | string>;
311+
312+
/**
313+
* Performance spans created from browser Performance APIs,
314+
* `performance.mark(...)` nand `performance.measure(...)`
315+
* with `name`s matching strings in the array will not be emitted.
316+
*
317+
* Default: []
318+
*/
319+
ignorePerformanceApiSpans: Array<string | RegExp>;
310320
}
311321

312322
/** Add performance related spans to a transaction */
@@ -346,7 +356,7 @@ export function addPerformanceEntries(span: Span, options: AddPerformanceEntries
346356
case 'mark':
347357
case 'paint':
348358
case 'measure': {
349-
_addMeasureSpans(span, entry, startTime, duration, timeOrigin);
359+
_addMeasureSpans(span, entry, startTime, duration, timeOrigin, options.ignorePerformanceApiSpans);
350360

351361
// capture web vitals
352362
const firstHidden = getVisibilityWatcher();
@@ -440,7 +450,15 @@ export function _addMeasureSpans(
440450
startTime: number,
441451
duration: number,
442452
timeOrigin: number,
453+
ignorePerformanceApiSpans: AddPerformanceEntriesOptions['ignorePerformanceApiSpans'],
443454
): void {
455+
if (
456+
['mark', 'measure'].includes(entry.entryType) &&
457+
stringMatchesSomePattern(entry.name, ignorePerformanceApiSpans)
458+
) {
459+
return;
460+
}
461+
444462
const navEntry = getNavigationEntry(false);
445463
const requestTime = msToSec(navEntry ? navEntry.requestStart : 0);
446464
// Because performance.measure accepts arbitrary timestamps it can produce

‎packages/browser-utils/test/browser/browserMetrics.test.ts‎

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ describe('_addMeasureSpans', () => {
7676
const startTime = 23;
7777
const duration = 356;
7878

79-
_addMeasureSpans(span, entry, startTime, duration, timeOrigin);
79+
_addMeasureSpans(span, entry, startTime, duration, timeOrigin, []);
8080

8181
expect(spans).toHaveLength(1);
8282
expect(spanToJSON(spans[0]!)).toEqual(
@@ -112,10 +112,75 @@ describe('_addMeasureSpans', () => {
112112
const startTime = 23;
113113
const duration = -50;
114114

115-
_addMeasureSpans(span, entry, startTime, duration, timeOrigin);
115+
_addMeasureSpans(span, entry, startTime, duration, timeOrigin, []);
116116

117117
expect(spans).toHaveLength(0);
118118
});
119+
120+
it('ignores performance spans that match ignorePerformanceApiSpans', () => {
121+
const pageloadSpan = new SentrySpan({ op: 'pageload', name: '/', sampled: true });
122+
const spans: Span[] = [];
123+
124+
getClient()?.on('spanEnd', span => {
125+
spans.push(span);
126+
});
127+
128+
const entries: PerformanceEntry[] = [
129+
{
130+
entryType: 'measure',
131+
name: 'measure-pass',
132+
duration: 10,
133+
startTime: 12,
134+
toJSON: () => ({}),
135+
},
136+
{
137+
entryType: 'measure',
138+
name: 'measure-ignore',
139+
duration: 10,
140+
startTime: 12,
141+
toJSON: () => ({}),
142+
},
143+
{
144+
entryType: 'mark',
145+
name: 'mark-pass',
146+
duration: 0,
147+
startTime: 12,
148+
toJSON: () => ({}),
149+
},
150+
{
151+
entryType: 'mark',
152+
name: 'mark-ignore',
153+
duration: 0,
154+
startTime: 12,
155+
toJSON: () => ({}),
156+
},
157+
{
158+
entryType: 'paint',
159+
name: 'mark-ignore',
160+
duration: 0,
161+
startTime: 12,
162+
toJSON: () => ({}),
163+
},
164+
];
165+
166+
const timeOrigin = 100;
167+
const startTime = 23;
168+
const duration = 356;
169+
170+
entries.forEach(e => {
171+
_addMeasureSpans(pageloadSpan, e, startTime, duration, timeOrigin, ['measure-i', /mark-ign/]);
172+
});
173+
174+
expect(spans).toHaveLength(3);
175+
expect(spans.map(spanToJSON)).toEqual(
176+
expect.arrayContaining([
177+
expect.objectContaining({ description: 'measure-pass', op: 'measure' }),
178+
expect.objectContaining({ description: 'mark-pass', op: 'mark' }),
179+
// name matches but type is not (mark|measure) => should not be ignored
180+
expect.objectContaining({ description: 'mark-ignore', op: 'paint' }),
181+
]),
182+
);
183+
});
119184
});
120185

121186
describe('_addResourceSpans', () => {

‎packages/browser/src/exports.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ export {
3939
setCurrentClient,
4040
Scope,
4141
continueTrace,
42+
getTraceData,
4243
suppressTracing,
4344
SDK_VERSION,
4445
setContext,

0 commit comments

Comments
 (0)