Skip to content

docs(react-router): Add docs for distributed tracing #13467

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

Merged
merged 2 commits into from
Apr 23, 2025

Conversation

chargome
Copy link
Member

@chargome chargome self-assigned this Apr 22, 2025
Copy link

vercel bot commented Apr 22, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 23, 2025 3:14pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 23, 2025 3:14pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Apr 23, 2025 3:14pm

@chargome chargome requested a review from sfanahata April 22, 2025 11:12
Copy link

codecov bot commented Apr 22, 2025

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 11.14MB -9 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 9.47MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.75MB -0.0%
../instrumentation.js -3 bytes 1.08MB -0.0%
9523.js -3 bytes 1.05MB -0.0%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 868.7kB -0.0%
static/chunks/8165-*.js -3 bytes 410.1kB -0.0%
static/5BagOYWCSTwKxnxxZ6QfX/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/5BagOYWCSTwKxnxxZ6QfX/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/jYozXpIJzN-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
static/jYozXpIJzN-*.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️

Comment on lines +232 to +233
<Expandable title="Do you need to customize your handleRequest function?">
If you need to update the logic of your `handleRequest` function you'll need to include the provided Sentry helper functions (`getMetaTagTransformer` and `wrapSentryHandleRequest`) manually:
Copy link
Member

Choose a reason for hiding this comment

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

Do I understand this correctly that this more manual approach is necessary when users have their own handleRequest function already? If so, I think we should point this out more clearly because I didn't fully understand the "If you need to update the logic of your handleRequest function" part. (Maybe that's just me though, so feel free to disregard)

Suggested change
<Expandable title="Do you need to customize your handleRequest function?">
If you need to update the logic of your `handleRequest` function you'll need to include the provided Sentry helper functions (`getMetaTagTransformer` and `wrapSentryHandleRequest`) manually:
<Expandable title="Do you have your own handleRequest function?">
If already defined your own `handleRequest` function you'll need to include the provided Sentry helper functions (`getMetaTagTransformer` and `wrapSentryHandleRequest`) manually:

(feel free to go with different wording as you see fit

Copy link
Member Author

@chargome chargome Apr 23, 2025

Choose a reason for hiding this comment

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

yeah that is correct, BUT whenever a user creates this hook, the handleRequest function is already defined – so I only want to encourage this path when they need some special logic in their function .. not sure how to name this though

Copy link
Member

Choose a reason for hiding this comment

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

Maybe I don't fully understand this yet but I guess what you mean is that when you run react-router reveal there already is a predefined handleRequest and this is the one users don't need to add Sentry stuff to?
So it's just for the case that users have a custom behaviour in the function already prior to adding Sentry?

I don't think this is a blocker btw, so if you wanna merge this today, feel free. Maybe we have a minute tomorrow to chat about it this quickly in person

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah let's talk talk about this tomorrow 👍

@Lms24
Copy link
Member

Lms24 commented Apr 23, 2025

Probably unrelated to this specific PR but I noticed that the * character in the diff code block (entry.client.tsx) has a bit too much right padding:

image

@chargome chargome merged commit d66dcb3 into master Apr 23, 2025
15 checks passed
@chargome chargome deleted the cg-rr-7-metatags-docs branch April 23, 2025 16:26
@github-actions github-actions bot locked and limited conversation to collaborators May 9, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants