feat(rust): add troubleshooting page #14595
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 ↗︎
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 5.02kB (0.02%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
coolguyzone
reviewed
Aug 13, 2025
| description: "If you need help solving issues with the Sentry Rust SDK, you can read the edge cases documented below." | ||
| --- | ||
|
|
||
| As a first step to debug any issue with the SDK, you should perform initialization with `debug: true` in your `ClientOptions` struct passed to `sentry::init`. |
There was a problem hiding this comment.
Suggested change
| As a first step to debug any issue with the SDK, you should perform initialization with `debug: true` in your `ClientOptions` struct passed to `sentry::init`. | |
| To start debugging any SDK issue, enable debug mode by setting debug: true in the ClientOptions struct you pass to sentry::init. |
coolguyzone
reviewed
Aug 13, 2025
| As a first step to debug any issue with the SDK, you should perform initialization with `debug: true` in your `ClientOptions` struct passed to `sentry::init`. | ||
| This will make the SDK log additional debug information on stderr. | ||
|
|
||
| Read below to find a list of common problems and how to solve them. |
There was a problem hiding this comment.
Suggested change
| Read below to find a list of common problems and how to solve them. | |
| Below is a list of common problems and how to solve them. |
coolguyzone
approved these changes
Aug 13, 2025
| ## General | ||
|
|
||
| <Expandable title="Panic on SDK initialization"> | ||
| The SDK has been reported to panic on initialization when using the `debug-images` feature on machines with specific versions of the Linux kernel due to an issue with one of its dependencies. |
There was a problem hiding this comment.
Not sure what the conventions in the Sentry docs are but I try to avoid passive language when possible.
Also, are you sure it has to do with the kernel? Because I don't think the kernel has dependencies in that sense, but potentially there is a problem with kernel modules or graphics drivers? If not, I would use some more generic term like below so users submit all potentially relevant information.
Suggested change
| The SDK has been reported to panic on initialization when using the `debug-images` feature on machines with specific versions of the Linux kernel due to an issue with one of its dependencies. | |
| Users have reported SDK initialization to panic when using the `debug-images` feature on machines with specific Linux platforms. |
| <Expandable title="Panic on SDK initialization"> | ||
| The SDK has been reported to panic on initialization when using the `debug-images` feature on machines with specific versions of the Linux kernel due to an issue with one of its dependencies. | ||
|
|
||
| Please open a GitHub [issue](https://github.com/getsentry/sentry-rust/issues/new/choose) with your OS and kernel version if you're affected by this. |
There was a problem hiding this comment.
Would graphics card drivers be relevant here? I think it might be worth asking for them as well
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
Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.
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