Skip to content

Conversation

@lcian
Copy link
Member

@lcian lcian commented Aug 7, 2025

Adds getting started docs for the tracing integration.
This is our most popular integration, so we want to have a dedicated page to give it even more visibility.
Currently the only docs we have for this are here which means they're hard to find, and they only document the tracing functionality.

@lcian lcian requested a review from giortzisg August 7, 2025 09:58
@vercel
Copy link

vercel bot commented Aug 7, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
sentry-docs Ready Ready Preview Comment Sep 12, 2025 9:51am
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
develop-docs Ignored Ignored Preview Sep 12, 2025 9:51am

@codeowner-assignment codeowner-assignment bot requested a review from a team August 7, 2025 09:59
@codecov
Copy link

codecov bot commented Aug 7, 2025

Bundle Report

Changes will decrease total bundle size by 72.39kB (-0.32%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 9.91MB -290 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 12.55MB -72.1kB (-0.57%) ⬇️

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.78MB -0.0%
../instrumentation.js -3 bytes 1.1MB -0.0%
9523.js -3 bytes 1.08MB -0.0%
../app/[[...path]]/page.js.nft.json -24.03kB 785.36kB -2.97%
../app/platform-redirect/page.js.nft.json -24.03kB 785.28kB -2.97%
../app/sitemap.xml/route.js.nft.json -24.03kB 782.75kB -2.98%
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 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
static/media/7c239973d8aef789-*.woff2 (New) 32.56kB 32.56kB 100.0% 🚀
static/media/32c80fb7588b7a2e-*.woff2 (New) 32.48kB 32.48kB 100.0% 🚀
static/media/a5d9f2ead0568494-*.woff2 (New) 21.08kB 21.08kB 100.0% 🚀
static/media/5b25d60b4670300e-*.woff2 (New) 19.29kB 19.29kB 100.0% 🚀
static/media/fc5b975a09123a00-*.woff2 (New) 9.75kB 9.75kB 100.0% 🚀
static/media/99e31c27a1524300-*.woff2 (New) 9.35kB 9.35kB 100.0% 🚀
server/middleware-*.js -5.55kB 1.0kB -84.74%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
static/6Ob0CtklYA5x0z5LEGCuL/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/6Ob0CtklYA5x0z5LEGCuL/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/media/4fca85807f6c09f6-*.woff2 (Deleted) -32.6kB 0 bytes -100.0% 🗑️
static/media/d695df15e3ff125c-*.woff2 (Deleted) -32.58kB 0 bytes -100.0% 🗑️
static/media/acdf4f392b58827a-*.woff2 (Deleted) -21.13kB 0 bytes -100.0% 🗑️
static/media/501d9eeee6e2b0cc-*.woff2 (Deleted) -19.41kB 0 bytes -100.0% 🗑️
static/media/a72efd2c2476ebb2-*.woff2 (Deleted) -9.7kB 0 bytes -100.0% 🗑️
static/media/9d7436bc73437f75-*.woff2 (Deleted) -9.36kB 0 bytes -100.0% 🗑️
static/tz-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
static/tz-*.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️

@lcian lcian force-pushed the lcian/feat/rust-tracing-docs branch from 057ab7a to de9699d Compare August 7, 2025 11:00
@@ -0,0 +1,120 @@
---
title: tracing
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm a little concerned that this could cause confusion since we also have our own 'Tracing' product. I think it's possible search might send people looking for /platforms/rust/tracing/ to this page or vice-versa. Would it make sense to update the title to something like 'tracing by tokio'? Or maybe add a little notification explaining that this is not about Sentry Tracing?

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

See my note about the title, but overall looks good to me!

Copy link
Member

@adinauer adinauer left a comment

Choose a reason for hiding this comment

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

/platforms/rust/tracing/ links to /platforms/rust/tracing/instrumentation/automatic-instrumentation/ here:
Screenshot 2025-08-13 at 08 39 16

Do we also want to link to this new guide?

Also should /platforms/rust/tracing/instrumentation/automatic-instrumentation/ link to the guide too?

Do we want to include "Tokio" in the name of the guide? From what I understand the tracing crate and tokio:tracing aren't the same thing. Not sure if all rust devs know the difference. I'm a bit confused on the differences and what they have in common.

@lcian
Copy link
Member Author

lcian commented Sep 9, 2025

I mistakenly merged this as part of another commit.
Will update this one by addressing the feedback and then merge it.

@lcian
Copy link
Member Author

lcian commented Sep 12, 2025

Do we want to include "Tokio" in the name of the guide? From what I understand the tracing crate and tokio:tracing aren't the same thing. Not sure if all rust devs know the difference. I'm a bit confused on the differences and what they have in common.

For the record they're the same thing. The only confusion that could arise is from our own tracing product vs tokio-rs/tracing, therefore now I'm making it explicit what this is about.

@lcian
Copy link
Member Author

lcian commented Sep 12, 2025

/platforms/rust/tracing/ links to /platforms/rust/tracing/instrumentation/automatic-instrumentation/ here:
...
Do we also want to link to this new guide?

I think we can remove that link now as docs for the tracing integration are now easily findable.

@codeowner-assignment codeowner-assignment bot requested a review from a team September 12, 2025 09:10
@lcian lcian changed the title feat(rust): add getting started docs for tracing ref(rust): Adjust getting started docs for tracing Sep 12, 2025
@lcian lcian enabled auto-merge (squash) September 12, 2025 09:32
@lcian lcian merged commit f677958 into master Sep 12, 2025
13 checks passed
@lcian lcian deleted the lcian/feat/rust-tracing-docs branch September 12, 2025 09:51
@github-actions github-actions bot locked and limited conversation to collaborators Sep 28, 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.

5 participants