feat(core): Send user-agent header with envelope requests in server SDKs
#17929
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Lms24
changed the title
Lms24
requested review from
a team,
chargome and
cleptric
and removed request for
a team
Lms24
force-pushed
the
lms/feat-core-send-user-agent-envelope-requests
branch
from
0c5731c to
8b51d2e
Compare
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
size-limit report 📦
|
node-overhead report 🧳Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.
|
Lms24
changed the title
Lms24
changed the title
user-agent header with envelope requests in server SDKs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update: Removed browser functionality (see below for reasons)
As a follow-up of an incident (quite a while ago, but this unfortunately slipped through), SDKs were asked to send a
user-agentHttp header to determine by just looking at incoming request headers which SDK the request is coming from. See develop specification.This PR makes the following changes to sending user agent HTTP headers with envelope requests made by the transport:
user-agentin all server-runtime SDKsheadersoption from individual transport options toBaseTransportOptions. This allows us to type-safely add the user agent header to the SDKs transport options which is the easiest way to pass a header to the transport without having to modify or extend any of the existing transport APIs. I checked and every transport implementation we currently export exposed aheadersoption anyway, so this just unifies it. Given this is an optional property, custom transport implementations extendingBaseTransportOptionswon't break either. The problem here is only that they might not actually support this option which all things considered I think is fine. If reviewers have different opinions, I'm happy to revisit this.This PR makes no change to the
sdkenvelope header which carries the same (more detailed) information (but in the request body)Why not in Browser SDKs?
user-agent, so we cannot set a custom user agent name that overwrites it.x-sentry-user-agent) because then the SDK would send a non-standard header which could block all requests to Sentry, depending on the CORS setup of the application the SDK is added to. This is especially relvant for users who usetunneland forward the SDK requests to a proxy server.ref: https://linear.app/getsentry/project/chore-alignextend-user-agents-795bfddfa217/overview