Skip to content

feat(rust): add getting started docs for tracing #14578

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

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
Copy link

vercel bot commented Aug 7, 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 Aug 7, 2025 11:34am
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 7, 2025 11:34am

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

codecov bot commented Aug 7, 2025

Bundle Report

Changes will increase total bundle size by 8.63kB (0.04%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 12.37MB 3.79kB (0.03%) ⬆️
sentry-docs-client-array-push 9.86MB 4.84kB (0.05%) ⬆️

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.77MB -0.0%
../instrumentation.js -3 bytes 1.1MB -0.0%
9523.js -3 bytes 1.08MB -0.0%
../app/[[...path]]/page.js.nft.json 119 bytes 742.84kB 0.02%
../app/platform-redirect/page.js.nft.json 119 bytes 742.76kB 0.02%
../app/sitemap.xml/route.js.nft.json 119 bytes 740.23kB 0.02%
../app/[[...path]]/page.js 160 bytes 567.65kB 0.03%
9883.js (New) 218.27kB 218.27kB 100.0% 🚀
4873.js 174 bytes 89.71kB 0.19%
../app/platform-redirect/page.js 160 bytes 32.06kB 0.5%
../../static/media/tracing.*.svg (New) 1.16kB 1.16kB 100.0% 🚀
../../static/media/tracing.*.svg (New) 1.15kB 1.15kB 100.0% 🚀
5109.js (Deleted) -217.64kB 0 bytes -100.0% 🗑️

Files in 4873.js:

  • ./src/components/platformIcon.tsx → Total Size: 36.87kB

  • ./src/components/platformIcon.tsx → Total Size: 36.87kB

App Routes Affected:

App Route Size Change Total Size Change (%)
/[[...path]] 160 bytes 3.13MB 0.01%
/platform-redirect 160 bytes 2.59MB 0.01%
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%
server/app/api/ip-*.js 520 bytes 263.16kB 0.2%
server/app/_not-*.js 520 bytes 263.15kB 0.2%
server/app/[[...path]]/page_client-*.js 520 bytes 263.12kB 0.2%
server/app/platform-*.js 420 bytes 247.79kB 0.17%
static/chunks/124-*.js (New) 145.04kB 145.04kB 100.0% 🚀
static/chunks/app/[[...path]]/page-*.js 79 bytes 84.28kB 0.09%
static/chunks/4145-*.js 87 bytes 49.88kB 0.17%
static/chunks/app/platform-*.js 79 bytes 13.3kB 0.6%
app-*.json -2 bytes 4.59kB -0.04%
/static/media/tracing.*.svg (New) 1.16kB 1.16kB 100.0% 🚀
/static/media/tracing.*.svg (New) 1.15kB 1.15kB 100.0% 🚀
static/kjcqePNpfuKMh5hcQva_B/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/kjcqePNpfuKMh5hcQva_B/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/chunks/7909-*.js (Deleted) -144.72kB 0 bytes -100.0% 🗑️
static/9Ol5ZLeRauHN2LZh1fsuh/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/9Ol5ZLeRauHN2LZh1fsuh/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

Files in static/chunks/4145-*.js:

  • ./src/components/platformIcon.tsx → Total Size: 36.94kB

@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.

}
```

By default, error level events are captured as Sentry events, while anything at or above info is added as a breadcrumb.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should be explicit when talking about Tokio and Sentry events, even if it's arguably clear from context.

Suggested change
By default, error level events are captured as Sentry events, while anything at or above info is added as a breadcrumb.
By default, error level events from Tokio are captured as Sentry events, while anything at or above info is added as a breadcrumb.


{/* ___PRODUCT_OPTION_START___ logs */}

To capture structured logs for `tracing` events instead, you need to set up the Sentry layer with a custom event filter that maps to logs, like so:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To capture structured logs for `tracing` events instead, you need to set up the Sentry layer with a custom event filter that maps to logs, like so:
To capture structured logs for Tokio `tracing` events instead, you need to set up the Sentry layer with a custom event filter that maps to logs, like so:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants