Skip to content

Commit 947acf4

Browse files
sfanahataShannon Anahata
andauthored
Adding error prediction to Prevent AI docs (#14641)
## DESCRIBE YOUR PR We're releasing error prediction ASAP, and these docs now show that feature. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [x] Urgent deadline (GA date, etc.): 8.15.2025 - [ ] Other deadline: <!-- ENTER DATE HERE --> - [ ] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Shannon Anahata <[email protected]>
1 parent d80be14 commit 947acf4

File tree

1 file changed

+15
-11
lines changed
  • docs/product/ai-in-sentry/sentry-prevent-ai

1 file changed

+15
-11
lines changed
Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: Sentry Prevent AI
33
sidebar_order: 30
4-
description: "AI-assisted code review and test generation to improve quality and test coverage."
4+
description: "Get error predictions, code reviews and new tests for better code and coverage using Sentry Prevent AI."
55
---
66

7-
Sentry Prevent AI is a generative AI assistant developed by Sentry that reviews your pull requests, suggests improvements, and generates tests for uncovered code before you merge.
7+
Sentry Prevent AI is a generative AI assistant developed by Sentry. It helps you generate new tests for uncovered code and reviews your code changes, predicting errors and offering suggestions for improvement before merging pull requests.
88

99
<Alert>
1010
Sentry Prevent AI is currently in <strong>beta</strong>. Beta features are
@@ -15,37 +15,41 @@ Sentry Prevent AI is a generative AI assistant developed by Sentry that reviews
1515

1616
## Getting Started
1717

18+
To enable Sentry Prevent AI in your GitHub organization or on specific repositories, you need to install the [Seer by Sentry app](https://github.com/apps/seer-by-sentry). This allows the assistant to analyze pull requests, provide insights, and write tests. **You must also have the [Sentry Github integration](/organization/integrations/source-code-mgmt/github/) enabled.**
19+
1820
1. Install the [Seer by Sentry app](https://github.com/apps/seer-by-sentry) in your GitHub organization or specific repositories.
1921
2. Enable these required settings in your Sentry [organization settings](https://sentry.io/orgredirect/settings/:orgslug/):
2022
- `Show Generative AI Features`
2123
- `Enable PR Review and Test Generation`
2224

23-
If you're not an admin, share the Sentry Prevent AI GitHub App Integration link with your organization's admin or owner to install.
25+
If you're not an admin, share the Seer by Sentry GitHub App Integration link with your organization's admin or owner to install it.
2426

2527
## Sentry Prevent AI Commands
2628

27-
After installing the app, use these commands in your pull request comments:
29+
After installing the app, Sentry Prevent AI can help you in three ways:
30+
31+
1. **Error Prediction** - When you create a pull request and set it to `Ready for Review`, Sentry Prevent AI will check for errors in your code. If no error is found, you will see a 🎉 emoji as a reaction to your PR description. Otherwise, Sentry Prevent AI will add comments to your PR.
2832

29-
- `@sentry review` - The assistant will review the PR and make suggestions.
33+
2. **`@sentry review`** - Use this command in a PR comment, and the assistant will review the PR and predict errors, as well as make suggestions.
3034

31-
- `@sentry generate-test` - The assistant will generate tests for your PR.
35+
3. **`@sentry generate-test`** - Use this command in a PR comment, and the assistant will generate tests for your PR.
3236

3337
Once you have added a comment, the assistant will reply, acknowledging the request. For code reviews, you will then see comments added to your PR. For test generation, you will see a comment with a link to the generated tests.
3438

3539
![Sentry Prevent AI Overview](./img/sentry-prevent-review.png)
3640

3741
## Frequently Asked Questions
3842

39-
- **What data does Sentry Prevent need access to for the AI system to function, and what information is sent to third-party AI providers?**
43+
- **What data does Sentry Prevent AI need access to for the AI system to function, and what information is sent to third-party AI providers?**
4044

41-
Sentry Prevent AI works by analyzing pull request details, such as metadata, file names, directory structure, and code changes. Only file names, code diffs, and PR descriptions are shared with the AI provider for analysis.
45+
Sentry Prevent AI requires access to your pull requests, including PR metadata, repository information, file names, directory structures, and code diffs. Only file names, code diffs, and PR descriptions are sent to the AI provider for analysis.
4246

43-
- **Does Sentry Prevent run anywhere outside of GitHub, and does it run in the background?**
47+
- **Does Sentry Prevent AI run anywhere outside of GitHub, and does it run in the background?**
4448

45-
Sentry Prevent AI only runs on GitHub, and only runs when triggered by a comment.
49+
Sentry Prevent AI only runs on GitHub. It will run once when a PR is marked `ready for review`, and otherwise only runs when triggered by a comment.
4650

4751
You can learn more about AI privacy and security [here](/product/ai-in-sentry/ai-privacy-and-security/).
4852

4953
- **Why aren't `@sentry` commands working?**
5054

51-
Sentry Prevent AI will respond with a message to enable the `Show Generative AI Features` and `Enable PR Review and Test Generation` settings in your [organization settings](https://sentry.io/orgredirect/settings/:orgslug/), if you have not already enabled them. Once enabled, try `@sentry review` or `@sentry generate-test` again to run Prevent AI.
55+
Sentry Prevent AI will respond with a message to enable the `Show Generative AI Features` and `Enable PR Review and Test Generation` settings in your [organization settings](https://sentry.io/orgredirect/settings/:orgslug/), if you have not already enabled them. Once enabled, try `@sentry review` or `@sentry generate-test` again to run Sentry Prevent AI.

0 commit comments

Comments
 (0)