feat(axum): provide docs for Axum #13822
Open
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Bundle ReportChanges will increase total bundle size by 20.51kB (0.1%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
Files in
App Routes Affected:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
Files in
|
|
@lcian Looks like the build deploys were canceled. I can't seem to try to deploy or redeploy them. Can you? Or can you force push to this branch so we can have those builds run? |
Now it's working! |
sfanahata
reviewed
Jun 5, 2025
| description: "Learn about monitoring your axum application with Sentry." | ||
| --- | ||
|
|
||
| The Sentry SDK offers a middleware for the [`axum`](https://github.com/tokio-rs/axum) framework that supports: |
There was a problem hiding this comment.
Suggested change
| The Sentry SDK offers a middleware for the [`axum`](https://github.com/tokio-rs/axum) framework that supports: | |
| The Sentry SDK offers a middleware for the [axum](https://github.com/tokio-rs/axum) framework that supports: |
This is looking a bit strange as code and a link. I suggest just keeping it as a hyperlink.
sfanahata
reviewed
Jun 5, 2025
| The Sentry SDK offers a middleware for the [`axum`](https://github.com/tokio-rs/axum) framework that supports: | ||
|
|
||
| - Reporting errors and panics with the correct request correlation. | ||
| - Starting a [transaction](https://docs.sentry.io/concepts/key-terms/tracing/) for each request-response cycle. |
There was a problem hiding this comment.
Suggested change
| - Starting a [transaction](https://docs.sentry.io/concepts/key-terms/tracing/) for each request-response cycle. | |
| - Starting a <PlatformLink to="/concepts/key-terms/tracing/">transaction</PlatformLink> for each request-response cycle. |
We try to do platform links when linking to other parts of our own documentation site.
sfanahata
reviewed
Jun 5, 2025
| - Reporting errors and panics with the correct request correlation. | ||
| - Starting a [transaction](https://docs.sentry.io/concepts/key-terms/tracing/) for each request-response cycle. | ||
|
|
||
| The integration actually supports any crate based on [`tower`](https://github.com/tower-rs/tower), not just `axum`. |
There was a problem hiding this comment.
Suggested change
| The integration actually supports any crate based on [`tower`](https://github.com/tower-rs/tower), not just `axum`. | |
| The integration actually supports any crate based on [tower](https://github.com/tower-rs/tower), not just `axum`. |
Code + hyperlink looks a little strange.
sfanahata
reviewed
Jun 5, 2025
Comment on lines
+83
to
+87
| ## Verify | ||
|
|
||
| The snippet above sets up a service that always panics, so you can test that everything is working as soon as you set it up. | ||
|
|
||
| Send a request to the application. The panic will be captured by Sentry. |
There was a problem hiding this comment.
This should be moved up above the snippet. We want to make sure that we're explaining things before demoing them. Change it to say "the following snippet sets up...".
sfanahata
reviewed
Jun 5, 2025
|
|
||
| </Alert> | ||
|
|
||
| To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved. |
There was a problem hiding this comment.
Would that error now be found under issues > errors & outages in our new nav? It would be helpful to be specific about where to find the error to select.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
DESCRIBE YOUR PR
Provides getting started docs for Axum.
The structure is very similar to the one used in #13821, only the code snippets are different.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES