Skip to content

Commit 6248533

Browse files
author
Shannon Anahata
committed
Merge master into sentry-prevent-test-analytics-docs
- Resolved conflicts for directory rename from sentry-prevent-ai to ai-code-review - Added new image prevent-ai-response.png from master - Kept renamed sentry-prevent-review.png in new location - Resolved redirects.js conflicts by keeping both our redirect and master's .NET profiling redirects - Updated all content to use 'Sentry's AI Code Review' branding - Incorporated all master updates including error prediction features, enhanced setup instructions, and expanded FAQ
2 parents acf0fb0 + 80ddc8d commit 6248533

File tree

897 files changed

+21456
-7286
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

897 files changed

+21456
-7286
lines changed

app/[[...path]]/page.tsx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,12 @@ export const dynamic = 'force-static';
4747
const mdxComponentsWithWrapper = mdxComponents(
4848
{Include, PlatformContent},
4949
({children, frontMatter, nextPage, previousPage}) => (
50-
<DocPage frontMatter={frontMatter} nextPage={nextPage} previousPage={previousPage}>
50+
<DocPage
51+
frontMatter={frontMatter}
52+
nextPage={nextPage}
53+
previousPage={previousPage}
54+
fullWidth={frontMatter.fullWidth}
55+
>
5156
{children}
5257
</DocPage>
5358
)

app/globals.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,6 @@ body {
177177

178178
.onboarding-step .step-heading::before,
179179
.onboarding-step h2::before {
180-
content: "Step " counter(onboarding-step) ": ";
180+
content: 'Step ' counter(onboarding-step) ': ';
181181
font-weight: inherit;
182182
}

develop-docs/backend/application-domains/asynchronous-workers.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ title: Asynchronous Workers
33
sidebar_order: 70
44
---
55

6+
<Alert level="warning" title="Deprecated">
7+
Celery workers are deprecated, and will be removed as of the 25.10.x self-hosted
8+
release.
9+
</Alert>
10+
611
Sentry comes with a built-in queue to process tasks in a more asynchronous fashion. For example when an event comes in instead of writing it to the database immediately, it sends a job to the queue so that the request can be returned right away, and the background workers handle actually saving that data.
712

813
Sentry relies on the [Celery](https://docs.celeryproject.org/) library for managing workers.
@@ -75,7 +80,7 @@ There are a few important points:
7580
because this is what registers the task by name. Thus every module
7681
containing a task must be added to the `CELERY_IMPORTS` and `TASKWORKER_IMPORTS` settings in
7782
`src/sentry/conf/server.py`.
78-
83+
7984
We have a separate setting for the Taskbroker workers until we fully deprecate the Celery workers.
8085

8186
## Running a Worker

develop-docs/backend/application-domains/options.mdx

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,15 @@ sidebar_order: 10
55

66
Options are a way to store generic system-wide configuration. They serve a similar purpose to configuration files, but they are backed by a database, so it's possible to change them at runtime without a deploy. Options are stored in the database and cached, so they are performant and reliable. This makes options well-suited for rates, quotas, and limits.
77

8+
While the process for creating and using options in the codebase is universal, the method for *managing their values* differs between Sentry's internal SaaS platform and self-hosted instances.
9+
10+
> **For Sentry Employees**
11+
>
12+
> Option management for Sentry's internal SaaS environments is handled via a GitOps workflow. All changes to option values are proposed, reviewed, and deployed through pull requests. For complete details on changing values, handling drift, and deployment, please see the **[sentry-options-automator](https://github.com/getsentry/sentry-options-automator)** repository.
13+
814
## Adding New Options
915

10-
To add a new system option, add it to [`sentry/options/defaults.py`](https://github.com/getsentry/sentry/blob/master/src/sentry/options/defaults.py) by registering it. e.g.,
16+
The process for registering a new option is the same for all environments and is done in the Sentry codebase. Add your option to [`sentry/options/defaults.py`](https://github.com/getsentry/sentry/blob/master/sentry/options/defaults.py).
1117

1218
```python
1319
register("performance.some-feature-rate", default=0.0)
@@ -23,24 +29,23 @@ Follow these rules when adding new options:
2329
The value of an option can be any pickleable value.
2430

2531
<Alert>
26-
It is safe to declare and use an option in the same pull request, you don't need to
27-
split them up.
32+
It is safe to declare and use an option in the same pull request; you don't need to split them up.
2833
</Alert>
2934

3035
## Using Options
36+
To check the value of an option, import the options module and use the get method. This is universal across all environments.
3137

32-
To check the value of an option, import the `options` module and use the `get` method. e.g.,
3338

3439
```python
3540
from sentry import options
3641
feature_rate = options.get("performance.some-feature-rate")
3742
```
3843

3944
## Setting Options
40-
41-
You can change the value of an option using `sentry shell`, or by using the [options UI](#options-ui).
45+
For self-hosted instances, you can change the value of an option using `sentry shell`, or by using the [options UI](#options-ui).
4246

4347
### Sentry Shell
48+
For direct database manipulation, you can set option values using sentry shell.
4449

4550
You can set option values using `sentry shell`. e.g.,
4651

@@ -110,7 +115,9 @@ def test_some_feature(self):
110115

111116
## Removing Options
112117

113-
If your option is short-lived, you should remove it once it's no longer needed. First, create a pull request to remove the option and its usage. Once it's merged and deployed, remove the option from the database. To do this, you can use the Sentry shell. e.g.,
118+
If your option is short-lived, you should remove it once it's no longer needed. First, create a pull request to remove the option and its usage. Once it's merged and deployed, remove the option from the database. For self-hosted instances, this is done via the Sentry shell. Otherwise, remove it from the Options Automator repository.
119+
120+
For self hosted instances, you can use the Sentry shell. e.g.,
114121

115122
```bash
116123
sentry shell
@@ -122,8 +129,3 @@ then,
122129
from sentry import options
123130
options.delete("performance.some-feature-rate")
124131
```
125-
126-
<Alert>
127-
If you do not have access to the shell, you'll need to contact OPS to remove the option
128-
for you.
129-
</Alert>

develop-docs/backend/application-domains/pii/index.mdx

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -68,39 +68,6 @@ some SDK. Go to our PII config editor [Piinguin], and:
6868
3. Paste in other payloads and see if they look fine, go to step **2** if
6969
necessary.
7070

71-
After iterating on the config, paste it back into the project config located at
72-
`.relay/projects/<PROJECT_ID>.json`
73-
74-
For example:
75-
76-
```json
77-
{
78-
"publicKeys": [
79-
{
80-
"publicKey": "___PUBLIC_KEY___",
81-
"isEnabled": true
82-
}
83-
],
84-
"config": {
85-
"allowedDomains": ["*"],
86-
"piiConfig": {
87-
"rules": {
88-
"device_id": {
89-
"type": "pattern",
90-
"pattern": "d/[a-f0-9]{12}",
91-
"redaction": {
92-
"method": "hash"
93-
}
94-
}
95-
},
96-
"applications": {
97-
"freeform": ["device_id"]
98-
}
99-
}
100-
}
101-
}
102-
```
103-
10471
[advanced data scrubbing]: https://docs.sentry.io/product/data-management-settings/scrubbing/advanced-datascrubbing/
10572
[relay]: https://github.com/getsentry/relay
10673
[piinguin]: https://getsentry.github.io/piinguin

0 commit comments

Comments
 (0)