-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(AI): Update Sentry AI docs #11825
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
Changes from 3 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
984d3e1
Update Sentry AI docs
roaga af48fc9
Update AI/ML policy
roaga 9dff966
Update redirects
roaga 93cb96b
Update docs/product/issues/issue-details/sentry-ai/index.mdx
roaga 33b8707
Update docs/product/issues/issue-details/sentry-ai/index.mdx
roaga 819295c
Update docs/product/issues/issue-details/sentry-ai/index.mdx
roaga c1a4842
Update docs/product/issues/issue-details/sentry-ai/index.mdx
roaga 9ede9b5
Update docs/product/issues/issue-details/sentry-ai/index.mdx
roaga 4331a73
Update docs/product/issues/issue-details/sentry-ai/index.mdx
roaga d7a566b
Update docs/product/issues/issue-details/sentry-ai/index.mdx
roaga 04250f1
Add suggested fix callout
roaga 2301692
Update docs/product/issues/issue-details/sentry-ai/index.mdx
roaga bff1046
Update docs/product/issues/issue-details/sentry-ai/index.mdx
roaga 1d00591
Update docs/product/issues/issue-details/sentry-ai/index.mdx
roaga 78b129b
Update docs/product/issues/issue-details/sentry-ai/index.mdx
roaga 540ff41
Update docs/product/issues/issue-details/sentry-ai/index.mdx
roaga 574ca52
Update docs/product/issues/issue-details/sentry-ai/index.mdx
roaga 1bdd019
Update docs/product/issues/issue-details/sentry-ai/index.mdx
roaga File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file removed
BIN
-60.1 KB
docs/product/issues/issue-details/ai-suggested-solution/img/banner.png
Binary file not shown.
Binary file removed
BIN
-156 KB
docs/product/issues/issue-details/ai-suggested-solution/img/disabling-feature.png
Binary file not shown.
Binary file removed
BIN
-386 KB
docs/product/issues/issue-details/ai-suggested-solution/img/solution.png
Binary file not shown.
52 changes: 0 additions & 52 deletions
52
docs/product/issues/issue-details/ai-suggested-solution/index.mdx
This file was deleted.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+246 KB
docs/product/issues/issue-details/sentry-ai/img/autofix-start-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| --- | ||
| title: Sentry AI | ||
| description: "Learn more about AI that helps you understand and fix issues faster." | ||
| sidebar_order: 50 | ||
| --- | ||
|
|
||
| Sentry AI is a set of tools that help you quickly understand an issue, find a root cause, and create a fix. | ||
| You can find it in the Solutions Hub in the sidebar of the issue details page for any error: | ||
roaga marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|  | ||
roaga marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Once you've set up Sentry AI, you'll be able to use the following features: | ||
|
|
||
| - [**Issue Summary**](#issue-summary): A quick summary of all the data in the issue to help you understand what's going on at a glance. | ||
roaga marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - [**Autofix**](#autofix): An agent that collaborates with you to find the root cause of an error and create a PR that fixes it. | ||
roaga marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Issue Summary | ||
|
|
||
| Issue Summary quickly orients you with the issue by summarizing the key insights to know across all the issue details. | ||
roaga marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| When you open an issue, you'll see a quick overview of what's going wrong in the issue in the Solutions Hub in the sidebar: | ||
|
|
||
|  | ||
|
|
||
| Opening the Solutions Hub will show you a more detailed overview of the issue. It will summarize what's going wrong, a possible cause, and if relevant, insights from trace-connected issues: | ||
|
|
||
|  | ||
|
|
||
| ## Autofix | ||
|
|
||
| When you want to understand the root cause more deeply, you can use Autofix. It uses the issue details, your codebase (integrated through GitHub), and its interactions with you to gain context and reason through the problem. | ||
|
|
||
| When you start an Autofix run, you'll see the following screen, with an option to share initial helpful context on the issue: | ||
|
|
||
|  | ||
|
|
||
| Autofix then starts analyzing the issue and the relevant code. You can see it's status at the bottom of the screen. As it goes through the process, Autofix will share its key insights along the way. You can expand each one to see the exact event data and code that it used to justify it. These insights build up a chain of reasoning to the root cause of the error. | ||
roaga marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Autofix obviously doesn't know everything, so it collaborates with you. At any point, you can jump in with helpful context or feedback. You can also directly edit its line of reasoning. Just click the "Edit" button above any of them, provide any thoughts or instructions you have, and Autofix will walk back its thought process and rethink from that point. Autofix can also recognize when it doesn't know something, and ask you for the context it needs to continue. | ||
roaga marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|  | ||
|
|
||
| Once you reach a root cause you're happy with, or have enough context to propose your own, Autofix will use the same process to find a fix. When complete, you'll see the diff of its proposed code changes. You can directly reject, edit, rethink, and give feedback on the changes. You can also ask Autofix to add tests to ensure the issue doesn't happen again. | ||
|
|
||
|  | ||
|
|
||
| Once you're happy with the changes, Autofix can create a draft PR for you to review and merge in GitHub. | ||
|
|
||
| ## Data Processing | ||
|
|
||
| Under normal circumstances we do not send data to a third party | ||
| undisclosed in our [subprocessor list](https://sentry.io/legal/subprocessors/). | ||
| Because of this you need to provide consent to do so. If your organization has | ||
| signed a DPA with us, an owner of the organization will also need to sign a | ||
| "OpenAI Subprocessor Acknowledgement" in the organization [Legal & Compliance | ||
| page](https://sentry.io/orgredirect/organizations/:orgslug/settings/legal/). Otherwise an individual | ||
| user will receive a prompt to confirm that data will be sent to a third party. | ||
|
|
||
| The data shared via this feature will not be used to train any AI models. The data used for these features includes: | ||
roaga marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - Error messages | ||
| - Stack traces | ||
| - Sentry spans | ||
| - DOM interactions | ||
| - Relevant code from linked repositories | ||
|
|
||
roaga marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Disabling AI Features | ||
|
|
||
| If you don't find the feature useful and want to disable it for all users, you | ||
| can do so in your organization's settings with the "Hide AI Features" toggle. Also remember that the features won't be available until the proper consent is given for your organization. | ||
|
|
||
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.