Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions docs/product/ai-in-sentry/sentry-prevent-ai/index.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Sentry Prevent AI
sidebar_order: 30
description: "AI-assisted code review and test generation to improve quality and test coverage."
description: "Get error predictions, code reviews and new tests for better code and coverage using Sentry Prevent AI."
---

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

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

## Getting Started

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

1. Install the [Seer by Sentry app](https://github.com/apps/seer-by-sentry) in your GitHub organization or specific repositories.
2. Enable these required settings in your Sentry [organization settings](https://sentry.io/orgredirect/settings/:orgslug/):
- `Show Generative AI Features`
- `Enable PR Review and Test Generation`

If you're not an admin, share the Sentry Prevent AI GitHub App Integration link with your organization's admin or owner to install.
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.

## Sentry Prevent AI Commands

After installing the app, use these commands in your pull request comments:
After installing the app, Sentry Prevent AI can help you in three ways:

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.

- `@sentry review` - The assistant will review the PR and make suggestions.
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.

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

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.

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

## Frequently Asked Questions

- **What data does Sentry Prevent need access to for the AI system to function, and what information is sent to third-party AI providers?**
- **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?**

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

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

Sentry Prevent AI only runs on GitHub, and only runs when triggered by a comment.
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.

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

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

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