-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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.
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
feat: Streamline sentry-trace
, baggage
and DSC handling
#14364
Conversation
}; | ||
|
||
const trace = evt.contexts && evt.contexts.trace; | ||
if (!trace && propagationContext) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These checks were not really necessary, I believe - first, propagationContext
cannot be empty here. And second, we do not need to check for trace
as this will be overwritten anyhow by ...evt.contexts
if it already exists.
}; | ||
|
||
const sentryTraceHeader = | ||
span && hasTracingEnabled() ? spanToTraceHeader(span) : generateSentryTraceHeader(traceId, spanId, sampled); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here, we have checked for span && hasTracingEnabled()
, while in fetch we did not check for hasTracingEnabled()
. I opted to use this logic (just check span) everywhere now...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For browser, I think that's fine!
size-limit report 📦
|
63ab398
to
0d74e78
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe I'm missing something obvious but why do we need getSentryHeaders
? Doesn't getTraceData
already do this? I'd prefer we avoid adding another utility function if we don't strictly have to do it.
Hmm, you are right that these are kind of similar 🤔 but |
a376535
to
1608c4c
Compare
packages/core/src/fetch.ts
Outdated
request, | ||
client, | ||
scope, | ||
undefined, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these just remain for backwards compatibility, because addTracingHeadersToFetchRequest
is exported :/
client.init(); | ||
|
||
return client; | ||
} | ||
|
||
describe('getTraceData', () => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these tests relied a lot on mocks, and since the underlying implementation was changed a bunch of this broke. So I rewrote these tests to use "real" stuff as much as possible, but tried to keep the scenarios we want to cover intact.
❌ 15 Tests Failed:
View the top 3 failed tests by shortest run time
To view more test analytics, go to the Test Analytics Dashboard |
Nevermind, still not working - need another round 😬 |
@lforst & @Lms24 OK, Now for real I think it should work. I had to change the custom |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is a good refactor! A bit concerned that bundle size is increasing although it looks like we removed more code than we added 😅
}; | ||
|
||
const sentryTraceHeader = | ||
span && hasTracingEnabled() ? spanToTraceHeader(span) : generateSentryTraceHeader(traceId, spanId, sampled); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For browser, I think that's fine!
yeah this is really weird 😬 not really sure where this is coming from... I think I'd still do this and hope that some follow up refactoring can safe a few bytes there. Sometimes, the ways of bundle size are not easy to understand 😬 |
sentry-trace
, baggage
and DSC handlingsentry-trace
, baggage
and DSC handling
@Lms24 so, after digging some more into why this increases bundle size, I believe it is because of this code in const isValidSentryTraceHeader = TRACEPARENT_REGEXP.test(sentryTrace);
if (!isValidSentryTraceHeader) {
logger.warn('Invalid sentry-trace data. Cannot generate trace data');
return {};
}
const validBaggage = isValidBaggageString(baggage);
if (!validBaggage) {
logger.warn('Invalid baggage data. Not returning "baggage" value');
} which basically checks some regexes. We have not checked this before, so now we have to include these regexes in the browser bundles which increases bundle size 😬 So IMHO either we accept this, or we only check these things in debug mode (?). I am not aware of any problems we had with this so far in browser land where we did not use to check this, so I am missing context for why we are checking this so defensively here. |
Honestly checking for validity of shapes is a bit weird. Our parsing/writing logic should just have sensible defaults and there is no need to be so defensive. Can we remove this checking logic? |
I think it's fine to remove the validation logic! For the record: We introduced the baggage validation logic because of XSS concerns (#9483 (comment)), originally in the Astro SDK. The Astro SDK code was later extracted to the core SDK for I'm not sure though how valid the potential vector here is so chances are we were over-cautious back then. |
I will merge this as is for now, and we can look into the validation in a follow up PR 👍 |
As a first step for #12385, I looked though our current implementations, and tried to streamline this. We have a bunch of somewhat duplicate code there that handles sentry-trace & baggage headers mostly the same but not fully the same, as well as relatedly the DSC.
To streamline this, I added some new methods in core:
getTraceData
already exists, but was extended to also allow to pass a specificspan
to it. I updated some code to use this method that hasn't used it before, and also added some more tests - also around the ACS and the otel-specific implementation for this.getDynamicSamplingContextFromScope
andgetTraceContextFromScope
which handle picking these things from given scope etc.While working on this, I also noticed that
captureCheckIn
in ServerRuntimeClient was actually not properly working in Node (OTEL), as it relied on the core way of scope-span coupling. So I also updated this to actually work as expected.