feat(core): Add `beforeSendSpan` hook (#11886) #11918

andreiborza · 2024-05-06T15:43:32Z

No description provided.

github-actions · 2024-05-06T15:53:19Z

size-limit report 📦

Path	Size
@sentry/browser	21.72 KB (+0.19% 🔺)
@sentry/browser (incl. Tracing)	32.86 KB (+0.28% 🔺)
@sentry/browser (incl. Tracing, Replay)	68.21 KB (+0.17% 🔺)
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags	61.6 KB (+0.16% 🔺)
@sentry/browser (incl. Tracing, Replay with Canvas)	72.25 KB (+0.16% 🔺)
@sentry/browser (incl. Tracing, Replay, Feedback)	84.25 KB (+0.14% 🔺)
@sentry/browser (incl. Feedback)	37.68 KB (+0.12% 🔺)
@sentry/browser (incl. sendFeedback)	26.29 KB (+0.16% 🔺)
@sentry/browser (incl. FeedbackAsync)	30.66 KB (+0.14% 🔺)
@sentry/react	24.41 KB (+0.15% 🔺)
@sentry/react (incl. Tracing)	35.85 KB (+0.32% 🔺)
@sentry/vue	25.65 KB (+0.48% 🔺)
@sentry/vue (incl. Tracing)	34.68 KB (+0.36% 🔺)
@sentry/svelte	21.86 KB (+0.2% 🔺)
CDN Bundle	24.26 KB (+0.17% 🔺)
CDN Bundle (incl. Tracing)	34.29 KB (+0.35% 🔺)
CDN Bundle (incl. Tracing, Replay)	67.99 KB (+0.19% 🔺)
CDN Bundle (incl. Tracing, Replay, Feedback)	72.95 KB (+0.15% 🔺)
CDN Bundle - uncompressed	71.33 KB (+0.18% 🔺)
CDN Bundle (incl. Tracing) - uncompressed	101.68 KB (+0.33% 🔺)
CDN Bundle (incl. Tracing, Replay) - uncompressed	211.3 KB (+0.16% 🔺)
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed	223.6 KB (+0.15% 🔺)
@sentry/nextjs (client)	35.07 KB (+0.32% 🔺)
@sentry/sveltekit (client)	33.44 KB (+0.32% 🔺)
@sentry/node	141.06 KB (+0.03% 🔺)
@sentry/aws-serverless	128.07 KB (+0.03% 🔺)

mydea · 2024-05-07T07:21:35Z

packages/core/src/envelope.ts

@@ -109,6 +114,15 @@ export function createSpanEnvelope(spans: SentrySpan[]): SpanEnvelope {
    sent_at: new Date().toISOString(),
    ...(dscHasRequiredProps(dsc) && { trace: dsc }),
  };
-  const items = spans.map(span => createSpanEnvelopeItem(spanToJSON(span)));
+
+  const beforeSend = client && client.getOptions().beforeSendSpan;


Suggested change

const beforeSend = client && client.getOptions().beforeSendSpan;

const beforeSendSpan = client && client.getOptions().beforeSendSpan;

let's call it that, I was confused for a sec because we also have an actual beforeSend hook (for error events) 😅

Right, not sure why I named it that way 😅 ...

mydea · 2024-05-07T07:23:51Z

packages/core/src/envelope.ts

+  if (beforeSend) {
+    items = spans.map(span => createSpanEnvelopeItem(beforeSend(spanToJSON(span) as SpanJSON)));
+  } else {
+    items = spans.map(span => createSpanEnvelopeItem(spanToJSON(span)));
+  }


I'm not even sure if there is a difference, but feels like it could be a micro-bundlesize-improvement: What if we do this in a single loop, something like this:

const items = spans.map(span => { const spanJson = spanToJSON(span) as SpanJSON; return beforeSend ? beforeSend(spanJson) : spanJson; });

added benefit is that we save a let items that we need to re-assign 🤔 but no strong feelings, it probably doesn't matter either way.

I was considering that but thought it wastes cycles checking the same thing over and over again. Not sure how big spans gets tho. Thoughts?

yeah, you're probably right!

What about a combination of both:

const convertToSpanJson = beforeSendSpan ? (span: Span) => beforeSendSpan(spanToJSON(span) as SpanJSON)) : (span: Span) => spanToJSON(span) as SpanJSON; const items = spans.map(convertToSpanJson);

Yea nice, fixed.

mydea · 2024-05-07T12:15:19Z

packages/core/src/baseclient.ts

-    return beforeSendTransaction(event, hint);
+  if (isTransactionEvent(event)) {
+    if (event.spans && beforeSendSpan) {
+      event.spans = event.spans.map(span => beforeSendSpan(span));


Just a note for ourselves: Wait with merging this until we verified with the performance team that this is OK, if this is undefined, for example.

mydea

sweet, pretty awesome first PR (well, first since you officially joined the team ;)) 🚀 let's just wait for feedback from the performance team about how to handle/allow dropping spans etc!

mydea · 2024-05-16T12:44:15Z

packages/core/src/envelope.ts

 */
-export function createSpanEnvelope(spans: SentrySpan[]): SpanEnvelope {
+export function createSpanEnvelope(spans: SentrySpan[], client?: Client): SpanEnvelope | null {


technically speaking this is breaking (as we export it from @sentry/core) 🤔 it is unlikely that a user is using this, but... hmm, not sure - maybe it is "safer" to still always return an envelope, and then check (outside) to only send this envelope if there are any spans inside of it?

Good point, thanks!

I changed it to check the span items on the returned envelope before sending it and pulled everything down into the helper method for sending.

… span envelope based on items length

mydea

very nice!

andreiborza requested a review from mydea May 6, 2024 15:43

andreiborza force-pushed the ab/before-send-span branch from 351ea5e to 3789160 Compare May 6, 2024 15:46

mydea assigned andreiborza May 7, 2024

mydea reviewed May 7, 2024

View reviewed changes

andreiborza force-pushed the ab/before-send-span branch 3 times, most recently from a7df1ef to ff1193c Compare May 7, 2024 11:47

mydea reviewed May 7, 2024

View reviewed changes

mydea approved these changes May 7, 2024

View reviewed changes

andreiborza marked this pull request as draft May 7, 2024 12:22

andreiborza added 2 commits May 16, 2024 14:30

feat(core): Add beforeSendSpan hook (#11886)

a368ce1

feat(core): Improve envelope span transformation readability

85df82e

andreiborza force-pushed the ab/before-send-span branch from 222bcb0 to 8698a17 Compare May 16, 2024 12:30

feat(core): Drop spans if beforeSendSpan returns null

bf687e4

andreiborza force-pushed the ab/before-send-span branch from 8698a17 to bf687e4 Compare May 16, 2024 12:34

mydea reviewed May 16, 2024

View reviewed changes

feat(core): Undo createSpanEnvelope returning null, drop standalone…

7fed679

… span envelope based on items length

mydea approved these changes May 16, 2024

View reviewed changes

andreiborza marked this pull request as ready for review May 16, 2024 13:55

andreiborza merged commit f1d1a16 into develop May 16, 2024
100 checks passed

andreiborza deleted the ab/before-send-span branch May 16, 2024 13:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): Add `beforeSendSpan` hook (#11886) #11918

feat(core): Add `beforeSendSpan` hook (#11886) #11918

andreiborza commented May 6, 2024

github-actions bot commented May 6, 2024 •

edited

Loading

mydea May 7, 2024

andreiborza May 7, 2024

andreiborza May 7, 2024

mydea May 7, 2024

andreiborza May 7, 2024 •

edited

Loading

mydea May 7, 2024

andreiborza May 7, 2024

mydea May 7, 2024

mydea left a comment

mydea May 16, 2024

andreiborza May 16, 2024

mydea left a comment

	const beforeSend = client && client.getOptions().beforeSendSpan;
	const beforeSendSpan = client && client.getOptions().beforeSendSpan;

feat(core): Add beforeSendSpan hook (#11886) #11918

feat(core): Add beforeSendSpan hook (#11886) #11918

Conversation

andreiborza commented May 6, 2024

github-actions bot commented May 6, 2024 • edited Loading

size-limit report 📦

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andreiborza May 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mydea left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mydea left a comment

Choose a reason for hiding this comment

feat(core): Add `beforeSendSpan` hook (#11886) #11918

feat(core): Add `beforeSendSpan` hook (#11886) #11918

github-actions bot commented May 6, 2024 •

edited

Loading

andreiborza May 7, 2024 •

edited

Loading