feat(core): Capture # of dropped spans through beforeSendTransaction#13022

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
mydea merged 4 commits into from
Jul 29, 2024
Merged

feat(core): Capture # of dropped spans through beforeSendTransaction#13022

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
6b7d131
feat(core): Capture # of dropped spans through `beforeSendTransaction`
mydea Jul 23, 2024
495dbd7
small ref
mydea Jul 23, 2024
08c0ff7
add tests
mydea Jul 24, 2024
f6ddc1c
adjust size limits
mydea Jul 24, 2024
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
4 changes: 2 additions & 2 deletions .size-limit.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,14 +48,14 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'replayCanvasIntegration'),
gzip: true,
limit: '76 KB',
limit: '78 KB',
},
{
name: '@sentry/browser (incl. Tracing, Replay, Feedback)',
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'feedbackIntegration'),
gzip: true,
limit: '89 KB',
limit: '90 KB',
},
{
name: '@sentry/browser (incl. Tracing, Replay, Feedback, metrics)',
Expand Down
38 changes: 30 additions & 8 deletions packages/core/src/baseclient.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -371,20 +371,21 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
/**
* @inheritDoc
*/
public recordDroppedEvent(reason: EventDropReason, category: DataCategory, _event?: Event): void {
// Note: we use `event` in replay, where we overwrite this hook.

public recordDroppedEvent(reason: EventDropReason, category: DataCategory, eventOrCount?: Event | number): void {
if (this._options.sendClientReports) {
// TODO v9: We do not need the `event` passed as third argument anymore, and can possibly remove this overload
// If event is passed as third argument, we assume this is a count of 1
const count = typeof eventOrCount === 'number' ? eventOrCount : 1;

// We want to track each category (error, transaction, session, replay_event) separately
// but still keep the distinction between different type of outcomes.
// We could use nested maps, but it's much easier to read and type this way.
// A correct type for map-based implementation if we want to go that route
// would be `Partial<Record<SentryRequestType, Partial<Record<Outcome, number>>>>`
// With typescript 4.1 we could even use template literal types
const key = `${reason}:${category}`;
DEBUG_BUILD && logger.log(`Adding outcome: "${key}"`);

this._outcomes[key] = (this._outcomes[key] || 0) + 1;
DEBUG_BUILD && logger.log(`Recording outcome: "${key}"${count > 1 ? ` (${count} times)` : ''}`);
this._outcomes[key] = (this._outcomes[key] || 0) + count;
}
}

Expand DownExpand Up@@ -794,11 +795,11 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
.then(processedEvent => {
if (processedEvent === null) {
this.recordDroppedEvent('before_send', dataCategory, event);
if (isTransactionEvent(event)) {
if (isTransaction) {
const spans = event.spans || [];
// the transaction itself counts as one span, plus all the child spans that are added
const spanCount = 1 + spans.length;
this._outcomes['span'] = (this._outcomes['span'] || 0) + spanCount;

@mydeamydeaJul 23, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Noticed that this was actually buggy, because the key is built from reason + category 😬 now this is unified and should work consistently.

this.recordDroppedEvent('before_send', 'span', spanCount);
}
throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
}
Expand All@@ -808,6 +809,18 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
this._updateSessionFromEvent(session, processedEvent);
}

if (isTransaction) {
const spanCountBefore =
(processedEvent.sdkProcessingMetadata && processedEvent.sdkProcessingMetadata.spanCountBeforeProcessing) ||
0;
const spanCountAfter = processedEvent.spans ? processedEvent.spans.length : 0;

const droppedSpanCount = spanCountBefore - spanCountAfter;
if (droppedSpanCount > 0) {
this.recordDroppedEvent('before_send', 'span', droppedSpanCount);
}
}

// None of the Sentry built event processor will update transaction name,
// so if the transaction name has been changed by an event processor, we know
// it has to come from custom event processor added by a user
Expand DownExpand Up@@ -973,6 +986,15 @@ function processBeforeSend(
}

if (beforeSendTransaction) {
if (event.spans) {
// We store the # of spans before processing in SDK metadata,
// so we can compare it afterwards to determine how many spans were dropped
const spanCountBefore = event.spans.length;
event.sdkProcessingMetadata = {
...event.sdkProcessingMetadata,
spanCountBeforeProcessing: spanCountBefore,
};
}
return beforeSendTransaction(event, hint);
}
}
Expand Down
28 changes: 26 additions & 2 deletions packages/core/test/lib/base.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1042,6 +1042,30 @@ describe('BaseClient', () => {
expect(TestClient.instance!.event!.transaction).toBe('/adopt/dont/shop');
});

test('calls `beforeSendTransaction` and drops spans', () => {
const beforeSendTransaction = jest.fn(event => {
event.spans = [{ span_id: 'span5', trace_id: 'trace1', start_timestamp: 1234 }];
return event;
});
const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
const client = new TestClient(options);

client.captureEvent({
transaction: '/dogs/are/great',
type: 'transaction',
spans: [
{ span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
{ span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
{ span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
],
});

expect(beforeSendTransaction).toHaveBeenCalled();
expect(TestClient.instance!.event!.spans?.length).toBe(1);

expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
});

test('calls `beforeSendSpan` and uses the modified spans', () => {
expect.assertions(3);

Expand DownExpand Up@@ -1120,8 +1144,6 @@ describe('BaseClient', () => {
});

test('calls `beforeSendSpan` and discards the span', () => {
expect.assertions(2);

const beforeSendSpan = jest.fn(() => null);
const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendSpan });
const client = new TestClient(options);
Expand DownExpand Up@@ -1149,6 +1171,7 @@ describe('BaseClient', () => {
expect(beforeSendSpan).toHaveBeenCalledTimes(2);
const capturedEvent = TestClient.instance!.event!;
expect(capturedEvent.spans).toHaveLength(0);
expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
});

test('calls `beforeSend` and logs info about invalid return value', () => {
Expand DownExpand Up@@ -2017,6 +2040,7 @@ describe('BaseClient', () => {

describe('hook removal with `on`', () => {
it('should return a cleanup function that, when executed, unregisters a hook', async () => {
jest.useFakeTimers();
expect.assertions(8);

const client = new TestClient(
Expand Down
, '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
feat(core): Capture # of dropped spans through beforeSendTransaction#13022

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

mydea
merged 4 commits into

from

Jul 29, 2024
 Merged


feat(core): Capture # of dropped spans through beforeSendTransaction#13022
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
6b7d131

feat(core): Capture # of dropped spans through `beforeSendTransaction`


mydea Jul 23, 2024
495dbd7

small ref


mydea Jul 23, 2024
08c0ff7

add tests


mydea Jul 24, 2024
f6ddc1c

adjust size limits


mydea Jul 24, 2024

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


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,14 +48,14 @@ module.exports = [
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'replayCanvasIntegration'),
 gzip: true,
 limit: '76 KB',
 limit: '78 KB',
 },
 {
 name: '@sentry/browser (incl. Tracing, Replay, Feedback)',
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'feedbackIntegration'),
 gzip: true,
 limit: '89 KB',
 limit: '90 KB',
 },
 {
 name: '@sentry/browser (incl. Tracing, Replay, Feedback, metrics)',
Expand Down

38 changes: 30 additions & 8 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -371,20 +371,21 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 /**
 * @inheritDoc
 */
 public recordDroppedEvent(reason: EventDropReason, category: DataCategory, _event?: Event): void {
 // Note: we use `event` in replay, where we overwrite this hook.

 public recordDroppedEvent(reason: EventDropReason, category: DataCategory, eventOrCount?: Event | number): void {
 if (this._options.sendClientReports) {
 // TODO v9: We do not need the `event` passed as third argument anymore, and can possibly remove this overload
 // If event is passed as third argument, we assume this is a count of 1
 const count = typeof eventOrCount === 'number' ? eventOrCount : 1;

 // We want to track each category (error, transaction, session, replay_event) separately
 // but still keep the distinction between different type of outcomes.
 // We could use nested maps, but it's much easier to read and type this way.
 // A correct type for map-based implementation if we want to go that route
 // would be `Partial<Record<SentryRequestType, Partial<Record<Outcome, number>>>>`
 // With typescript 4.1 we could even use template literal types
 const key = `${reason}:${category}`;
 DEBUG_BUILD && logger.log(`Adding outcome: "${key}"`);

 this._outcomes[key] = (this._outcomes[key] || 0) + 1;
 DEBUG_BUILD && logger.log(`Recording outcome: "${key}"${count > 1 ? ` (${count} times)` : ''}`);
 this._outcomes[key] = (this._outcomes[key] || 0) + count;
 }
 }

Expand DownExpand Up@@ -794,11 +795,11 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 .then(processedEvent => {
 if (processedEvent === null) {
 this.recordDroppedEvent('before_send', dataCategory, event);
 if (isTransactionEvent(event)) {
 if (isTransaction) {
 const spans = event.spans || [];
 // the transaction itself counts as one span, plus all the child spans that are added
 const spanCount = 1 + spans.length;
 this._outcomes['span'] = (this._outcomes['span'] || 0) + spanCount;
@mydeamydeaJul 23, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Noticed that this was actually buggy, because the key is built from reason + category 😬 now this is unified and should work consistently.
 this.recordDroppedEvent('before_send', 'span', spanCount);
 }
 throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
 }
Expand All@@ -808,6 +809,18 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 this._updateSessionFromEvent(session, processedEvent);
 }

 if (isTransaction) {
 const spanCountBefore =
 (processedEvent.sdkProcessingMetadata && processedEvent.sdkProcessingMetadata.spanCountBeforeProcessing) ||
 0;
 const spanCountAfter = processedEvent.spans ? processedEvent.spans.length : 0;

 const droppedSpanCount = spanCountBefore - spanCountAfter;
 if (droppedSpanCount > 0) {
 this.recordDroppedEvent('before_send', 'span', droppedSpanCount);
 }
 }

 // None of the Sentry built event processor will update transaction name,
 // so if the transaction name has been changed by an event processor, we know
 // it has to come from custom event processor added by a user
Expand DownExpand Up@@ -973,6 +986,15 @@ function processBeforeSend(
 }

 if (beforeSendTransaction) {
 if (event.spans) {
 // We store the # of spans before processing in SDK metadata,
 // so we can compare it afterwards to determine how many spans were dropped
 const spanCountBefore = event.spans.length;
 event.sdkProcessingMetadata = {
 ...event.sdkProcessingMetadata,
 spanCountBeforeProcessing: spanCountBefore,
 };
 }
 return beforeSendTransaction(event, hint);
 }
 }
Expand Down

28 changes: 26 additions & 2 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1042,6 +1042,30 @@ describe('BaseClient', () => {
 expect(TestClient.instance!.event!.transaction).toBe('/adopt/dont/shop');
 });

 test('calls `beforeSendTransaction` and drops spans', () => {
 const beforeSendTransaction = jest.fn(event => {
 event.spans = [{ span_id: 'span5', trace_id: 'trace1', start_timestamp: 1234 }];
 return event;
 });
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
 const client = new TestClient(options);

 client.captureEvent({
 transaction: '/dogs/are/great',
 type: 'transaction',
 spans: [
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
 ],
 });

 expect(beforeSendTransaction).toHaveBeenCalled();
 expect(TestClient.instance!.event!.spans?.length).toBe(1);

 expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
 });

 test('calls `beforeSendSpan` and uses the modified spans', () => {
 expect.assertions(3);

Expand DownExpand Up@@ -1120,8 +1144,6 @@ describe('BaseClient', () => {
 });

 test('calls `beforeSendSpan` and discards the span', () => {
 expect.assertions(2);

 const beforeSendSpan = jest.fn(() => null);
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendSpan });
 const client = new TestClient(options);
Expand DownExpand Up@@ -1149,6 +1171,7 @@ describe('BaseClient', () => {
 expect(beforeSendSpan).toHaveBeenCalledTimes(2);
 const capturedEvent = TestClient.instance!.event!;
 expect(capturedEvent.spans).toHaveLength(0);
 expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
 });

 test('calls `beforeSend` and logs info about invalid return value', () => {
Expand DownExpand Up@@ -2017,6 +2040,7 @@ describe('BaseClient', () => {

 describe('hook removal with `on`', () => {
 it('should return a cleanup function that, when executed, unregisters a hook', async () => {
 jest.useFakeTimers();
 expect.assertions(8);

 const client = new TestClient(
Expand Down

, '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
feat(core): Capture # of dropped spans through beforeSendTransaction#13022

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

mydea
merged 4 commits into

from

Jul 29, 2024
 Merged


feat(core): Capture # of dropped spans through beforeSendTransaction#13022
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
6b7d131

feat(core): Capture # of dropped spans through `beforeSendTransaction`


mydea Jul 23, 2024
495dbd7

small ref


mydea Jul 23, 2024
08c0ff7

add tests


mydea Jul 24, 2024
f6ddc1c

adjust size limits


mydea Jul 24, 2024

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


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,14 +48,14 @@ module.exports = [
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'replayCanvasIntegration'),
 gzip: true,
 limit: '76 KB',
 limit: '78 KB',
 },
 {
 name: '@sentry/browser (incl. Tracing, Replay, Feedback)',
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'feedbackIntegration'),
 gzip: true,
 limit: '89 KB',
 limit: '90 KB',
 },
 {
 name: '@sentry/browser (incl. Tracing, Replay, Feedback, metrics)',
Expand Down

38 changes: 30 additions & 8 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -371,20 +371,21 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 /**
 * @inheritDoc
 */
 public recordDroppedEvent(reason: EventDropReason, category: DataCategory, _event?: Event): void {
 // Note: we use `event` in replay, where we overwrite this hook.

 public recordDroppedEvent(reason: EventDropReason, category: DataCategory, eventOrCount?: Event | number): void {
 if (this._options.sendClientReports) {
 // TODO v9: We do not need the `event` passed as third argument anymore, and can possibly remove this overload
 // If event is passed as third argument, we assume this is a count of 1
 const count = typeof eventOrCount === 'number' ? eventOrCount : 1;

 // We want to track each category (error, transaction, session, replay_event) separately
 // but still keep the distinction between different type of outcomes.
 // We could use nested maps, but it's much easier to read and type this way.
 // A correct type for map-based implementation if we want to go that route
 // would be `Partial<Record<SentryRequestType, Partial<Record<Outcome, number>>>>`
 // With typescript 4.1 we could even use template literal types
 const key = `${reason}:${category}`;
 DEBUG_BUILD && logger.log(`Adding outcome: "${key}"`);

 this._outcomes[key] = (this._outcomes[key] || 0) + 1;
 DEBUG_BUILD && logger.log(`Recording outcome: "${key}"${count > 1 ? ` (${count} times)` : ''}`);
 this._outcomes[key] = (this._outcomes[key] || 0) + count;
 }
 }

Expand DownExpand Up@@ -794,11 +795,11 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 .then(processedEvent => {
 if (processedEvent === null) {
 this.recordDroppedEvent('before_send', dataCategory, event);
 if (isTransactionEvent(event)) {
 if (isTransaction) {
 const spans = event.spans || [];
 // the transaction itself counts as one span, plus all the child spans that are added
 const spanCount = 1 + spans.length;
 this._outcomes['span'] = (this._outcomes['span'] || 0) + spanCount;
@mydeamydeaJul 23, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Noticed that this was actually buggy, because the key is built from reason + category 😬 now this is unified and should work consistently.
 this.recordDroppedEvent('before_send', 'span', spanCount);
 }
 throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
 }
Expand All@@ -808,6 +809,18 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 this._updateSessionFromEvent(session, processedEvent);
 }

 if (isTransaction) {
 const spanCountBefore =
 (processedEvent.sdkProcessingMetadata && processedEvent.sdkProcessingMetadata.spanCountBeforeProcessing) ||
 0;
 const spanCountAfter = processedEvent.spans ? processedEvent.spans.length : 0;

 const droppedSpanCount = spanCountBefore - spanCountAfter;
 if (droppedSpanCount > 0) {
 this.recordDroppedEvent('before_send', 'span', droppedSpanCount);
 }
 }

 // None of the Sentry built event processor will update transaction name,
 // so if the transaction name has been changed by an event processor, we know
 // it has to come from custom event processor added by a user
Expand DownExpand Up@@ -973,6 +986,15 @@ function processBeforeSend(
 }

 if (beforeSendTransaction) {
 if (event.spans) {
 // We store the # of spans before processing in SDK metadata,
 // so we can compare it afterwards to determine how many spans were dropped
 const spanCountBefore = event.spans.length;
 event.sdkProcessingMetadata = {
 ...event.sdkProcessingMetadata,
 spanCountBeforeProcessing: spanCountBefore,
 };
 }
 return beforeSendTransaction(event, hint);
 }
 }
Expand Down

28 changes: 26 additions & 2 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1042,6 +1042,30 @@ describe('BaseClient', () => {
 expect(TestClient.instance!.event!.transaction).toBe('/adopt/dont/shop');
 });

 test('calls `beforeSendTransaction` and drops spans', () => {
 const beforeSendTransaction = jest.fn(event => {
 event.spans = [{ span_id: 'span5', trace_id: 'trace1', start_timestamp: 1234 }];
 return event;
 });
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
 const client = new TestClient(options);

 client.captureEvent({
 transaction: '/dogs/are/great',
 type: 'transaction',
 spans: [
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
 ],
 });

 expect(beforeSendTransaction).toHaveBeenCalled();
 expect(TestClient.instance!.event!.spans?.length).toBe(1);

 expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
 });

 test('calls `beforeSendSpan` and uses the modified spans', () => {
 expect.assertions(3);

Expand DownExpand Up@@ -1120,8 +1144,6 @@ describe('BaseClient', () => {
 });

 test('calls `beforeSendSpan` and discards the span', () => {
 expect.assertions(2);

 const beforeSendSpan = jest.fn(() => null);
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendSpan });
 const client = new TestClient(options);
Expand DownExpand Up@@ -1149,6 +1171,7 @@ describe('BaseClient', () => {
 expect(beforeSendSpan).toHaveBeenCalledTimes(2);
 const capturedEvent = TestClient.instance!.event!;
 expect(capturedEvent.spans).toHaveLength(0);
 expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
 });

 test('calls `beforeSend` and logs info about invalid return value', () => {
Expand DownExpand Up@@ -2017,6 +2040,7 @@ describe('BaseClient', () => {

 describe('hook removal with `on`', () => {
 it('should return a cleanup function that, when executed, unregisters a hook', async () => {
 jest.useFakeTimers();
 expect.assertions(8);

 const client = new TestClient(
Expand Down

, '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
feat(core): Capture # of dropped spans through beforeSendTransaction#13022

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

mydea
merged 4 commits into

from

Jul 29, 2024
 Merged


feat(core): Capture # of dropped spans through beforeSendTransaction#13022
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
6b7d131

feat(core): Capture # of dropped spans through `beforeSendTransaction`


mydea Jul 23, 2024
495dbd7

small ref


mydea Jul 23, 2024
08c0ff7

add tests


mydea Jul 24, 2024
f6ddc1c

adjust size limits


mydea Jul 24, 2024

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


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,14 +48,14 @@ module.exports = [
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'replayCanvasIntegration'),
 gzip: true,
 limit: '76 KB',
 limit: '78 KB',
 },
 {
 name: '@sentry/browser (incl. Tracing, Replay, Feedback)',
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'feedbackIntegration'),
 gzip: true,
 limit: '89 KB',
 limit: '90 KB',
 },
 {
 name: '@sentry/browser (incl. Tracing, Replay, Feedback, metrics)',
Expand Down

38 changes: 30 additions & 8 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -371,20 +371,21 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 /**
 * @inheritDoc
 */
 public recordDroppedEvent(reason: EventDropReason, category: DataCategory, _event?: Event): void {
 // Note: we use `event` in replay, where we overwrite this hook.

 public recordDroppedEvent(reason: EventDropReason, category: DataCategory, eventOrCount?: Event | number): void {
 if (this._options.sendClientReports) {
 // TODO v9: We do not need the `event` passed as third argument anymore, and can possibly remove this overload
 // If event is passed as third argument, we assume this is a count of 1
 const count = typeof eventOrCount === 'number' ? eventOrCount : 1;

 // We want to track each category (error, transaction, session, replay_event) separately
 // but still keep the distinction between different type of outcomes.
 // We could use nested maps, but it's much easier to read and type this way.
 // A correct type for map-based implementation if we want to go that route
 // would be `Partial<Record<SentryRequestType, Partial<Record<Outcome, number>>>>`
 // With typescript 4.1 we could even use template literal types
 const key = `${reason}:${category}`;
 DEBUG_BUILD && logger.log(`Adding outcome: "${key}"`);

 this._outcomes[key] = (this._outcomes[key] || 0) + 1;
 DEBUG_BUILD && logger.log(`Recording outcome: "${key}"${count > 1 ? ` (${count} times)` : ''}`);
 this._outcomes[key] = (this._outcomes[key] || 0) + count;
 }
 }

Expand DownExpand Up@@ -794,11 +795,11 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 .then(processedEvent => {
 if (processedEvent === null) {
 this.recordDroppedEvent('before_send', dataCategory, event);
 if (isTransactionEvent(event)) {
 if (isTransaction) {
 const spans = event.spans || [];
 // the transaction itself counts as one span, plus all the child spans that are added
 const spanCount = 1 + spans.length;
 this._outcomes['span'] = (this._outcomes['span'] || 0) + spanCount;
@mydeamydeaJul 23, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Noticed that this was actually buggy, because the key is built from reason + category 😬 now this is unified and should work consistently.
 this.recordDroppedEvent('before_send', 'span', spanCount);
 }
 throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
 }
Expand All@@ -808,6 +809,18 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 this._updateSessionFromEvent(session, processedEvent);
 }

 if (isTransaction) {
 const spanCountBefore =
 (processedEvent.sdkProcessingMetadata && processedEvent.sdkProcessingMetadata.spanCountBeforeProcessing) ||
 0;
 const spanCountAfter = processedEvent.spans ? processedEvent.spans.length : 0;

 const droppedSpanCount = spanCountBefore - spanCountAfter;
 if (droppedSpanCount > 0) {
 this.recordDroppedEvent('before_send', 'span', droppedSpanCount);
 }
 }

 // None of the Sentry built event processor will update transaction name,
 // so if the transaction name has been changed by an event processor, we know
 // it has to come from custom event processor added by a user
Expand DownExpand Up@@ -973,6 +986,15 @@ function processBeforeSend(
 }

 if (beforeSendTransaction) {
 if (event.spans) {
 // We store the # of spans before processing in SDK metadata,
 // so we can compare it afterwards to determine how many spans were dropped
 const spanCountBefore = event.spans.length;
 event.sdkProcessingMetadata = {
 ...event.sdkProcessingMetadata,
 spanCountBeforeProcessing: spanCountBefore,
 };
 }
 return beforeSendTransaction(event, hint);
 }
 }
Expand Down

28 changes: 26 additions & 2 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1042,6 +1042,30 @@ describe('BaseClient', () => {
 expect(TestClient.instance!.event!.transaction).toBe('/adopt/dont/shop');
 });

 test('calls `beforeSendTransaction` and drops spans', () => {
 const beforeSendTransaction = jest.fn(event => {
 event.spans = [{ span_id: 'span5', trace_id: 'trace1', start_timestamp: 1234 }];
 return event;
 });
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
 const client = new TestClient(options);

 client.captureEvent({
 transaction: '/dogs/are/great',
 type: 'transaction',
 spans: [
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
 ],
 });

 expect(beforeSendTransaction).toHaveBeenCalled();
 expect(TestClient.instance!.event!.spans?.length).toBe(1);

 expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
 });

 test('calls `beforeSendSpan` and uses the modified spans', () => {
 expect.assertions(3);

Expand DownExpand Up@@ -1120,8 +1144,6 @@ describe('BaseClient', () => {
 });

 test('calls `beforeSendSpan` and discards the span', () => {
 expect.assertions(2);

 const beforeSendSpan = jest.fn(() => null);
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendSpan });
 const client = new TestClient(options);
Expand DownExpand Up@@ -1149,6 +1171,7 @@ describe('BaseClient', () => {
 expect(beforeSendSpan).toHaveBeenCalledTimes(2);
 const capturedEvent = TestClient.instance!.event!;
 expect(capturedEvent.spans).toHaveLength(0);
 expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
 });

 test('calls `beforeSend` and logs info about invalid return value', () => {
Expand DownExpand Up@@ -2017,6 +2040,7 @@ describe('BaseClient', () => {

 describe('hook removal with `on`', () => {
 it('should return a cleanup function that, when executed, unregisters a hook', async () => {
 jest.useFakeTimers();
 expect.assertions(8);

 const client = new TestClient(
Expand Down

, '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
feat(core): Capture # of dropped spans through beforeSendTransaction#13022

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

mydea
merged 4 commits into

from

Jul 29, 2024
 Merged


feat(core): Capture # of dropped spans through beforeSendTransaction#13022
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
6b7d131

feat(core): Capture # of dropped spans through `beforeSendTransaction`


mydea Jul 23, 2024
495dbd7

small ref


mydea Jul 23, 2024
08c0ff7

add tests


mydea Jul 24, 2024
f6ddc1c

adjust size limits


mydea Jul 24, 2024

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


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,14 +48,14 @@ module.exports = [
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'replayCanvasIntegration'),
 gzip: true,
 limit: '76 KB',
 limit: '78 KB',
 },
 {
 name: '@sentry/browser (incl. Tracing, Replay, Feedback)',
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'feedbackIntegration'),
 gzip: true,
 limit: '89 KB',
 limit: '90 KB',
 },
 {
 name: '@sentry/browser (incl. Tracing, Replay, Feedback, metrics)',
Expand Down

38 changes: 30 additions & 8 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -371,20 +371,21 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 /**
 * @inheritDoc
 */
 public recordDroppedEvent(reason: EventDropReason, category: DataCategory, _event?: Event): void {
 // Note: we use `event` in replay, where we overwrite this hook.

 public recordDroppedEvent(reason: EventDropReason, category: DataCategory, eventOrCount?: Event | number): void {
 if (this._options.sendClientReports) {
 // TODO v9: We do not need the `event` passed as third argument anymore, and can possibly remove this overload
 // If event is passed as third argument, we assume this is a count of 1
 const count = typeof eventOrCount === 'number' ? eventOrCount : 1;

 // We want to track each category (error, transaction, session, replay_event) separately
 // but still keep the distinction between different type of outcomes.
 // We could use nested maps, but it's much easier to read and type this way.
 // A correct type for map-based implementation if we want to go that route
 // would be `Partial<Record<SentryRequestType, Partial<Record<Outcome, number>>>>`
 // With typescript 4.1 we could even use template literal types
 const key = `${reason}:${category}`;
 DEBUG_BUILD && logger.log(`Adding outcome: "${key}"`);

 this._outcomes[key] = (this._outcomes[key] || 0) + 1;
 DEBUG_BUILD && logger.log(`Recording outcome: "${key}"${count > 1 ? ` (${count} times)` : ''}`);
 this._outcomes[key] = (this._outcomes[key] || 0) + count;
 }
 }

Expand DownExpand Up@@ -794,11 +795,11 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 .then(processedEvent => {
 if (processedEvent === null) {
 this.recordDroppedEvent('before_send', dataCategory, event);
 if (isTransactionEvent(event)) {
 if (isTransaction) {
 const spans = event.spans || [];
 // the transaction itself counts as one span, plus all the child spans that are added
 const spanCount = 1 + spans.length;
 this._outcomes['span'] = (this._outcomes['span'] || 0) + spanCount;
@mydeamydeaJul 23, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Noticed that this was actually buggy, because the key is built from reason + category 😬 now this is unified and should work consistently.
 this.recordDroppedEvent('before_send', 'span', spanCount);
 }
 throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
 }
Expand All@@ -808,6 +809,18 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 this._updateSessionFromEvent(session, processedEvent);
 }

 if (isTransaction) {
 const spanCountBefore =
 (processedEvent.sdkProcessingMetadata && processedEvent.sdkProcessingMetadata.spanCountBeforeProcessing) ||
 0;
 const spanCountAfter = processedEvent.spans ? processedEvent.spans.length : 0;

 const droppedSpanCount = spanCountBefore - spanCountAfter;
 if (droppedSpanCount > 0) {
 this.recordDroppedEvent('before_send', 'span', droppedSpanCount);
 }
 }

 // None of the Sentry built event processor will update transaction name,
 // so if the transaction name has been changed by an event processor, we know
 // it has to come from custom event processor added by a user
Expand DownExpand Up@@ -973,6 +986,15 @@ function processBeforeSend(
 }

 if (beforeSendTransaction) {
 if (event.spans) {
 // We store the # of spans before processing in SDK metadata,
 // so we can compare it afterwards to determine how many spans were dropped
 const spanCountBefore = event.spans.length;
 event.sdkProcessingMetadata = {
 ...event.sdkProcessingMetadata,
 spanCountBeforeProcessing: spanCountBefore,
 };
 }
 return beforeSendTransaction(event, hint);
 }
 }
Expand Down

28 changes: 26 additions & 2 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1042,6 +1042,30 @@ describe('BaseClient', () => {
 expect(TestClient.instance!.event!.transaction).toBe('/adopt/dont/shop');
 });

 test('calls `beforeSendTransaction` and drops spans', () => {
 const beforeSendTransaction = jest.fn(event => {
 event.spans = [{ span_id: 'span5', trace_id: 'trace1', start_timestamp: 1234 }];
 return event;
 });
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
 const client = new TestClient(options);

 client.captureEvent({
 transaction: '/dogs/are/great',
 type: 'transaction',
 spans: [
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
 ],
 });

 expect(beforeSendTransaction).toHaveBeenCalled();
 expect(TestClient.instance!.event!.spans?.length).toBe(1);

 expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
 });

 test('calls `beforeSendSpan` and uses the modified spans', () => {
 expect.assertions(3);

Expand DownExpand Up@@ -1120,8 +1144,6 @@ describe('BaseClient', () => {
 });

 test('calls `beforeSendSpan` and discards the span', () => {
 expect.assertions(2);

 const beforeSendSpan = jest.fn(() => null);
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendSpan });
 const client = new TestClient(options);
Expand DownExpand Up@@ -1149,6 +1171,7 @@ describe('BaseClient', () => {
 expect(beforeSendSpan).toHaveBeenCalledTimes(2);
 const capturedEvent = TestClient.instance!.event!;
 expect(capturedEvent.spans).toHaveLength(0);
 expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
 });

 test('calls `beforeSend` and logs info about invalid return value', () => {
Expand DownExpand Up@@ -2017,6 +2040,7 @@ describe('BaseClient', () => {

 describe('hook removal with `on`', () => {
 it('should return a cleanup function that, when executed, unregisters a hook', async () => {
 jest.useFakeTimers();
 expect.assertions(8);

 const client = new TestClient(
Expand Down

, '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
feat(core): Capture # of dropped spans through beforeSendTransaction#13022

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

mydea
merged 4 commits into

from

Jul 29, 2024
 Merged


feat(core): Capture # of dropped spans through beforeSendTransaction#13022
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
6b7d131

feat(core): Capture # of dropped spans through `beforeSendTransaction`


mydea Jul 23, 2024
495dbd7

small ref


mydea Jul 23, 2024
08c0ff7

add tests


mydea Jul 24, 2024
f6ddc1c

adjust size limits


mydea Jul 24, 2024

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


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,14 +48,14 @@ module.exports = [
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'replayCanvasIntegration'),
 gzip: true,
 limit: '76 KB',
 limit: '78 KB',
 },
 {
 name: '@sentry/browser (incl. Tracing, Replay, Feedback)',
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'feedbackIntegration'),
 gzip: true,
 limit: '89 KB',
 limit: '90 KB',
 },
 {
 name: '@sentry/browser (incl. Tracing, Replay, Feedback, metrics)',
Expand Down

38 changes: 30 additions & 8 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -371,20 +371,21 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 /**
 * @inheritDoc
 */
 public recordDroppedEvent(reason: EventDropReason, category: DataCategory, _event?: Event): void {
 // Note: we use `event` in replay, where we overwrite this hook.

 public recordDroppedEvent(reason: EventDropReason, category: DataCategory, eventOrCount?: Event | number): void {
 if (this._options.sendClientReports) {
 // TODO v9: We do not need the `event` passed as third argument anymore, and can possibly remove this overload
 // If event is passed as third argument, we assume this is a count of 1
 const count = typeof eventOrCount === 'number' ? eventOrCount : 1;

 // We want to track each category (error, transaction, session, replay_event) separately
 // but still keep the distinction between different type of outcomes.
 // We could use nested maps, but it's much easier to read and type this way.
 // A correct type for map-based implementation if we want to go that route
 // would be `Partial<Record<SentryRequestType, Partial<Record<Outcome, number>>>>`
 // With typescript 4.1 we could even use template literal types
 const key = `${reason}:${category}`;
 DEBUG_BUILD && logger.log(`Adding outcome: "${key}"`);

 this._outcomes[key] = (this._outcomes[key] || 0) + 1;
 DEBUG_BUILD && logger.log(`Recording outcome: "${key}"${count > 1 ? ` (${count} times)` : ''}`);
 this._outcomes[key] = (this._outcomes[key] || 0) + count;
 }
 }

Expand DownExpand Up@@ -794,11 +795,11 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 .then(processedEvent => {
 if (processedEvent === null) {
 this.recordDroppedEvent('before_send', dataCategory, event);
 if (isTransactionEvent(event)) {
 if (isTransaction) {
 const spans = event.spans || [];
 // the transaction itself counts as one span, plus all the child spans that are added
 const spanCount = 1 + spans.length;
 this._outcomes['span'] = (this._outcomes['span'] || 0) + spanCount;
@mydeamydeaJul 23, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Noticed that this was actually buggy, because the key is built from reason + category 😬 now this is unified and should work consistently.
 this.recordDroppedEvent('before_send', 'span', spanCount);
 }
 throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
 }
Expand All@@ -808,6 +809,18 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 this._updateSessionFromEvent(session, processedEvent);
 }

 if (isTransaction) {
 const spanCountBefore =
 (processedEvent.sdkProcessingMetadata && processedEvent.sdkProcessingMetadata.spanCountBeforeProcessing) ||
 0;
 const spanCountAfter = processedEvent.spans ? processedEvent.spans.length : 0;

 const droppedSpanCount = spanCountBefore - spanCountAfter;
 if (droppedSpanCount > 0) {
 this.recordDroppedEvent('before_send', 'span', droppedSpanCount);
 }
 }

 // None of the Sentry built event processor will update transaction name,
 // so if the transaction name has been changed by an event processor, we know
 // it has to come from custom event processor added by a user
Expand DownExpand Up@@ -973,6 +986,15 @@ function processBeforeSend(
 }

 if (beforeSendTransaction) {
 if (event.spans) {
 // We store the # of spans before processing in SDK metadata,
 // so we can compare it afterwards to determine how many spans were dropped
 const spanCountBefore = event.spans.length;
 event.sdkProcessingMetadata = {
 ...event.sdkProcessingMetadata,
 spanCountBeforeProcessing: spanCountBefore,
 };
 }
 return beforeSendTransaction(event, hint);
 }
 }
Expand Down

28 changes: 26 additions & 2 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1042,6 +1042,30 @@ describe('BaseClient', () => {
 expect(TestClient.instance!.event!.transaction).toBe('/adopt/dont/shop');
 });

 test('calls `beforeSendTransaction` and drops spans', () => {
 const beforeSendTransaction = jest.fn(event => {
 event.spans = [{ span_id: 'span5', trace_id: 'trace1', start_timestamp: 1234 }];
 return event;
 });
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
 const client = new TestClient(options);

 client.captureEvent({
 transaction: '/dogs/are/great',
 type: 'transaction',
 spans: [
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
 ],
 });

 expect(beforeSendTransaction).toHaveBeenCalled();
 expect(TestClient.instance!.event!.spans?.length).toBe(1);

 expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
 });

 test('calls `beforeSendSpan` and uses the modified spans', () => {
 expect.assertions(3);

Expand DownExpand Up@@ -1120,8 +1144,6 @@ describe('BaseClient', () => {
 });

 test('calls `beforeSendSpan` and discards the span', () => {
 expect.assertions(2);

 const beforeSendSpan = jest.fn(() => null);
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendSpan });
 const client = new TestClient(options);
Expand DownExpand Up@@ -1149,6 +1171,7 @@ describe('BaseClient', () => {
 expect(beforeSendSpan).toHaveBeenCalledTimes(2);
 const capturedEvent = TestClient.instance!.event!;
 expect(capturedEvent.spans).toHaveLength(0);
 expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
 });

 test('calls `beforeSend` and logs info about invalid return value', () => {
Expand DownExpand Up@@ -2017,6 +2040,7 @@ describe('BaseClient', () => {

 describe('hook removal with `on`', () => {
 it('should return a cleanup function that, when executed, unregisters a hook', async () => {
 jest.useFakeTimers();
 expect.assertions(8);

 const client = new TestClient(
Expand Down

, '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
feat(core): Capture # of dropped spans through beforeSendTransaction#13022

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

mydea
merged 4 commits into

from

Jul 29, 2024
 Merged


feat(core): Capture # of dropped spans through beforeSendTransaction#13022
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
6b7d131

feat(core): Capture # of dropped spans through `beforeSendTransaction`


mydea Jul 23, 2024
495dbd7

small ref


mydea Jul 23, 2024
08c0ff7

add tests


mydea Jul 24, 2024
f6ddc1c

adjust size limits


mydea Jul 24, 2024

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


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,14 +48,14 @@ module.exports = [
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'replayCanvasIntegration'),
 gzip: true,
 limit: '76 KB',
 limit: '78 KB',
 },
 {
 name: '@sentry/browser (incl. Tracing, Replay, Feedback)',
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'feedbackIntegration'),
 gzip: true,
 limit: '89 KB',
 limit: '90 KB',
 },
 {
 name: '@sentry/browser (incl. Tracing, Replay, Feedback, metrics)',
Expand Down

38 changes: 30 additions & 8 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -371,20 +371,21 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 /**
 * @inheritDoc
 */
 public recordDroppedEvent(reason: EventDropReason, category: DataCategory, _event?: Event): void {
 // Note: we use `event` in replay, where we overwrite this hook.

 public recordDroppedEvent(reason: EventDropReason, category: DataCategory, eventOrCount?: Event | number): void {
 if (this._options.sendClientReports) {
 // TODO v9: We do not need the `event` passed as third argument anymore, and can possibly remove this overload
 // If event is passed as third argument, we assume this is a count of 1
 const count = typeof eventOrCount === 'number' ? eventOrCount : 1;

 // We want to track each category (error, transaction, session, replay_event) separately
 // but still keep the distinction between different type of outcomes.
 // We could use nested maps, but it's much easier to read and type this way.
 // A correct type for map-based implementation if we want to go that route
 // would be `Partial<Record<SentryRequestType, Partial<Record<Outcome, number>>>>`
 // With typescript 4.1 we could even use template literal types
 const key = `${reason}:${category}`;
 DEBUG_BUILD && logger.log(`Adding outcome: "${key}"`);

 this._outcomes[key] = (this._outcomes[key] || 0) + 1;
 DEBUG_BUILD && logger.log(`Recording outcome: "${key}"${count > 1 ? ` (${count} times)` : ''}`);
 this._outcomes[key] = (this._outcomes[key] || 0) + count;
 }
 }

Expand DownExpand Up@@ -794,11 +795,11 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 .then(processedEvent => {
 if (processedEvent === null) {
 this.recordDroppedEvent('before_send', dataCategory, event);
 if (isTransactionEvent(event)) {
 if (isTransaction) {
 const spans = event.spans || [];
 // the transaction itself counts as one span, plus all the child spans that are added
 const spanCount = 1 + spans.length;
 this._outcomes['span'] = (this._outcomes['span'] || 0) + spanCount;
@mydeamydeaJul 23, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Noticed that this was actually buggy, because the key is built from reason + category 😬 now this is unified and should work consistently.
 this.recordDroppedEvent('before_send', 'span', spanCount);
 }
 throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
 }
Expand All@@ -808,6 +809,18 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 this._updateSessionFromEvent(session, processedEvent);
 }

 if (isTransaction) {
 const spanCountBefore =
 (processedEvent.sdkProcessingMetadata && processedEvent.sdkProcessingMetadata.spanCountBeforeProcessing) ||
 0;
 const spanCountAfter = processedEvent.spans ? processedEvent.spans.length : 0;

 const droppedSpanCount = spanCountBefore - spanCountAfter;
 if (droppedSpanCount > 0) {
 this.recordDroppedEvent('before_send', 'span', droppedSpanCount);
 }
 }

 // None of the Sentry built event processor will update transaction name,
 // so if the transaction name has been changed by an event processor, we know
 // it has to come from custom event processor added by a user
Expand DownExpand Up@@ -973,6 +986,15 @@ function processBeforeSend(
 }

 if (beforeSendTransaction) {
 if (event.spans) {
 // We store the # of spans before processing in SDK metadata,
 // so we can compare it afterwards to determine how many spans were dropped
 const spanCountBefore = event.spans.length;
 event.sdkProcessingMetadata = {
 ...event.sdkProcessingMetadata,
 spanCountBeforeProcessing: spanCountBefore,
 };
 }
 return beforeSendTransaction(event, hint);
 }
 }
Expand Down

28 changes: 26 additions & 2 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1042,6 +1042,30 @@ describe('BaseClient', () => {
 expect(TestClient.instance!.event!.transaction).toBe('/adopt/dont/shop');
 });

 test('calls `beforeSendTransaction` and drops spans', () => {
 const beforeSendTransaction = jest.fn(event => {
 event.spans = [{ span_id: 'span5', trace_id: 'trace1', start_timestamp: 1234 }];
 return event;
 });
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
 const client = new TestClient(options);

 client.captureEvent({
 transaction: '/dogs/are/great',
 type: 'transaction',
 spans: [
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
 ],
 });

 expect(beforeSendTransaction).toHaveBeenCalled();
 expect(TestClient.instance!.event!.spans?.length).toBe(1);

 expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
 });

 test('calls `beforeSendSpan` and uses the modified spans', () => {
 expect.assertions(3);

Expand DownExpand Up@@ -1120,8 +1144,6 @@ describe('BaseClient', () => {
 });

 test('calls `beforeSendSpan` and discards the span', () => {
 expect.assertions(2);

 const beforeSendSpan = jest.fn(() => null);
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendSpan });
 const client = new TestClient(options);
Expand DownExpand Up@@ -1149,6 +1171,7 @@ describe('BaseClient', () => {
 expect(beforeSendSpan).toHaveBeenCalledTimes(2);
 const capturedEvent = TestClient.instance!.event!;
 expect(capturedEvent.spans).toHaveLength(0);
 expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
 });

 test('calls `beforeSend` and logs info about invalid return value', () => {
Expand DownExpand Up@@ -2017,6 +2040,7 @@ describe('BaseClient', () => {

 describe('hook removal with `on`', () => {
 it('should return a cleanup function that, when executed, unregisters a hook', async () => {
 jest.useFakeTimers();
 expect.assertions(8);

 const client = new TestClient(
Expand Down

, '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
feat(core): Capture # of dropped spans through beforeSendTransaction#13022

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

mydea
merged 4 commits into

from

Jul 29, 2024
 Merged


feat(core): Capture # of dropped spans through beforeSendTransaction#13022
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
6b7d131

feat(core): Capture # of dropped spans through `beforeSendTransaction`


mydea Jul 23, 2024
495dbd7

small ref


mydea Jul 23, 2024
08c0ff7

add tests


mydea Jul 24, 2024
f6ddc1c

adjust size limits


mydea Jul 24, 2024

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


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,14 +48,14 @@ module.exports = [
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'replayCanvasIntegration'),
 gzip: true,
 limit: '76 KB',
 limit: '78 KB',
 },
 {
 name: '@sentry/browser (incl. Tracing, Replay, Feedback)',
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'feedbackIntegration'),
 gzip: true,
 limit: '89 KB',
 limit: '90 KB',
 },
 {
 name: '@sentry/browser (incl. Tracing, Replay, Feedback, metrics)',
Expand Down

38 changes: 30 additions & 8 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -371,20 +371,21 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 /**
 * @inheritDoc
 */
 public recordDroppedEvent(reason: EventDropReason, category: DataCategory, _event?: Event): void {
 // Note: we use `event` in replay, where we overwrite this hook.

 public recordDroppedEvent(reason: EventDropReason, category: DataCategory, eventOrCount?: Event | number): void {
 if (this._options.sendClientReports) {
 // TODO v9: We do not need the `event` passed as third argument anymore, and can possibly remove this overload
 // If event is passed as third argument, we assume this is a count of 1
 const count = typeof eventOrCount === 'number' ? eventOrCount : 1;

 // We want to track each category (error, transaction, session, replay_event) separately
 // but still keep the distinction between different type of outcomes.
 // We could use nested maps, but it's much easier to read and type this way.
 // A correct type for map-based implementation if we want to go that route
 // would be `Partial<Record<SentryRequestType, Partial<Record<Outcome, number>>>>`
 // With typescript 4.1 we could even use template literal types
 const key = `${reason}:${category}`;
 DEBUG_BUILD && logger.log(`Adding outcome: "${key}"`);

 this._outcomes[key] = (this._outcomes[key] || 0) + 1;
 DEBUG_BUILD && logger.log(`Recording outcome: "${key}"${count > 1 ? ` (${count} times)` : ''}`);
 this._outcomes[key] = (this._outcomes[key] || 0) + count;
 }
 }

Expand DownExpand Up@@ -794,11 +795,11 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 .then(processedEvent => {
 if (processedEvent === null) {
 this.recordDroppedEvent('before_send', dataCategory, event);
 if (isTransactionEvent(event)) {
 if (isTransaction) {
 const spans = event.spans || [];
 // the transaction itself counts as one span, plus all the child spans that are added
 const spanCount = 1 + spans.length;
 this._outcomes['span'] = (this._outcomes['span'] || 0) + spanCount;
@mydeamydeaJul 23, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Noticed that this was actually buggy, because the key is built from reason + category 😬 now this is unified and should work consistently.
 this.recordDroppedEvent('before_send', 'span', spanCount);
 }
 throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
 }
Expand All@@ -808,6 +809,18 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 this._updateSessionFromEvent(session, processedEvent);
 }

 if (isTransaction) {
 const spanCountBefore =
 (processedEvent.sdkProcessingMetadata && processedEvent.sdkProcessingMetadata.spanCountBeforeProcessing) ||
 0;
 const spanCountAfter = processedEvent.spans ? processedEvent.spans.length : 0;

 const droppedSpanCount = spanCountBefore - spanCountAfter;
 if (droppedSpanCount > 0) {
 this.recordDroppedEvent('before_send', 'span', droppedSpanCount);
 }
 }

 // None of the Sentry built event processor will update transaction name,
 // so if the transaction name has been changed by an event processor, we know
 // it has to come from custom event processor added by a user
Expand DownExpand Up@@ -973,6 +986,15 @@ function processBeforeSend(
 }

 if (beforeSendTransaction) {
 if (event.spans) {
 // We store the # of spans before processing in SDK metadata,
 // so we can compare it afterwards to determine how many spans were dropped
 const spanCountBefore = event.spans.length;
 event.sdkProcessingMetadata = {
 ...event.sdkProcessingMetadata,
 spanCountBeforeProcessing: spanCountBefore,
 };
 }
 return beforeSendTransaction(event, hint);
 }
 }
Expand Down

28 changes: 26 additions & 2 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1042,6 +1042,30 @@ describe('BaseClient', () => {
 expect(TestClient.instance!.event!.transaction).toBe('/adopt/dont/shop');
 });

 test('calls `beforeSendTransaction` and drops spans', () => {
 const beforeSendTransaction = jest.fn(event => {
 event.spans = [{ span_id: 'span5', trace_id: 'trace1', start_timestamp: 1234 }];
 return event;
 });
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
 const client = new TestClient(options);

 client.captureEvent({
 transaction: '/dogs/are/great',
 type: 'transaction',
 spans: [
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
 ],
 });

 expect(beforeSendTransaction).toHaveBeenCalled();
 expect(TestClient.instance!.event!.spans?.length).toBe(1);

 expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
 });

 test('calls `beforeSendSpan` and uses the modified spans', () => {
 expect.assertions(3);

Expand DownExpand Up@@ -1120,8 +1144,6 @@ describe('BaseClient', () => {
 });

 test('calls `beforeSendSpan` and discards the span', () => {
 expect.assertions(2);

 const beforeSendSpan = jest.fn(() => null);
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendSpan });
 const client = new TestClient(options);
Expand DownExpand Up@@ -1149,6 +1171,7 @@ describe('BaseClient', () => {
 expect(beforeSendSpan).toHaveBeenCalledTimes(2);
 const capturedEvent = TestClient.instance!.event!;
 expect(capturedEvent.spans).toHaveLength(0);
 expect(client['_outcomes']).toEqual({ 'before_send:span': 2 });
 });

 test('calls `beforeSend` and logs info about invalid return value', () => {
Expand DownExpand Up@@ -2017,6 +2040,7 @@ describe('BaseClient', () => {

 describe('hook removal with `on`', () => {
 it('should return a cleanup function that, when executed, unregisters a hook', async () => {
 jest.useFakeTimers();
 expect.assertions(8);

 const client = new TestClient(
Expand Down