Skip to content

Commit 6f3ecb0

Browse files
committed
Merge branch 'master' of github.com:getsentry/sentry-docs into smi/sveltekit/clean-up-manual-qs
2 parents 3e00895 + d53605a commit 6f3ecb0

File tree

79 files changed

+673
-196
lines changed

Some content is hidden

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

79 files changed

+673
-196
lines changed

app/layout.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ export default function RootLayout({children}: {children: React.ReactNode}) {
5858
data-font-family="var(--font-rubik)"
5959
data-modal-disclaimer="Please note: This is a tool that searches publicly available sources. Do not include any sensitive or personal information in your queries. For more on how Sentry handles your data, see our [Privacy Policy](https://sentry.io/privacy/)."
6060
data-modal-example-questions="How to set up Sentry for Next.js?,What are tracePropagationTargets?"
61+
data-user-analytics-cookie-enabled="false"
6162
/>
6263
</body>
6364
</html>

develop-docs/backend/api/design.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -119,24 +119,24 @@ POST /resources/{id}
119119

120120
### Batch Operations
121121

122-
Resources can get complicated when you need to expose batch operations vs single resource operations. For batch operations it is preferred to expose them as a `POST` request on the collection when possible.
122+
Resources can get complicated when you need to expose batch operations vs single resource operations. For batch operations it is preferred to expose them as a `PUT` request on the collection when possible.
123123

124124
Let's say for example we have an endpoint that mutates an issue:
125125

126126
```
127-
POST /api/0/organizations/{org}/issues/{issue}/
127+
PUT /api/0/organizations/{org}/issues/{issue}/
128128
```
129129

130130
When designing a batch interface, we simply expose it on the collection instead of the individual resource:
131131

132132
```
133-
POST /api/0/organizations/{org}/issues/
133+
PUT /api/0/organizations/{org}/issues/
134134
```
135135

136136
You may also need to expose selectors on batch resources, which can be done through normal request parameters:
137137

138138
```
139-
POST /api/0/organizations/{org}/issues/
139+
PUT /api/0/organizations/{org}/issues/
140140
{
141141
"issues": [1, 2, 3]
142142
}
@@ -237,7 +237,7 @@ Expanding responses allow us to include relational information on a resource wit
237237

238238
In general, endpoints should expose the fewest fields that will make the API usable in the general scenario. Doing one SQL request per API request is a good rule of thumb. To return information on a bounded relationship, endpoints should rely on the `expand` parameter. To return an unbounded relationship, it should be another endpoint.
239239

240-
To take an example, let's talk about the projects list endpoint. A project belongs to an organizations but could be on multiple teams.
240+
To take an example, let's talk about the projects list endpoint. A project belongs to an organization but could be on multiple teams.
241241

242242
By default, here's what the project endpoint should look like
243243

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ KAFKA_CONSUMERS = {
3131
4. You may need to add some devserver options [here](https://github.com/getsentry/sentry/blob/master/src/sentry/runner/commands/devserver.py).
3232
4. Add tests for your consumer
3333

34-
## Run the consumer in production
35-
1. Discuss it with SRE during their office hours
36-
2. Create ops PR for adding your consumer to
37-
[k8s/services/getsentry/_consumer-deployment.yaml.j2](https://github.com/getsentry/ops/blob/master/k8s/services/getsentry/_consumer-deployment.yaml.j2).
38-
3. In the [Sentry Consumers metrics dashboard](https://www.notion.so/sentry/Kafka-e8b4f93595684c97b01fe831fbceb0dc?pvs=4#1fa8b10e4b5d8044859ecaf559463cb0), add a new saved view for your consumer.
34+
## Deployment
35+
36+
Visit the Ops repo and search for `shared_config/kafka/README.md` for a full, in-depth step-by-step guide.

develop-docs/sdk/expected-features/rate-limiting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ While these [data categories](https://github.com/getsentry/relay/blob/master/rel
8888
- `error`: Error events.
8989
- `transaction`: Transaction type events.
9090
- `span`: Span type events.
91-
- `security`: Events with event_type `csp`, `hpkp`, `expectct`, `expectstaple`
91+
- `security`: Events with event_type `csp`
9292
- `attachment`: Attachment bytes stored (unused for rate limiting)
9393
- `session`: Session update events
9494
- `profile`: Profiling events
122 KB
Loading
60.8 KB
Loading

docs/organization/integrations/issue-tracking/incidentio/index.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ This integration is maintained and supported by the company that created it. For
1313
<Alert>
1414

1515
Sentry owner, manager, or admin permissions are required to install this integration.
16-
1716
incident.io **won't** work with self-hosted Sentry.
1817

1918
</Alert>
@@ -40,7 +39,7 @@ The Sentry issue is now attached to the incident:
4039

4140
![Incident with Sentry issue attached](./img/incidentio-attach-post.png)
4241

43-
### In sentry.io
42+
### In Sentry
4443

4544
To attach a Sentry issue to an incident in [sentry.io](https://sentry.io), navigate to a specific Sentry issue and find the "Linked Issues" section on the right panel. Click "Link incident.io issue" and select your active incident from the dropdown:
4645

@@ -51,3 +50,17 @@ To attach a Sentry issue to an incident in [sentry.io](https://sentry.io), navig
5150
The incident's Slack channel will be updated with attached Sentry issue comments, edited comments, and when the Sentry issue is resolved:
5251

5352
![Synced comments from Sentry on an incident in Slack](./img/incidentio-issue-sync.png)
53+
54+
55+
## Alerting
56+
57+
Once installed, you can also set Sentry to be an alert source for incidents.
58+
59+
![incident.io alert setup](./img/incidentio-alert-setup.png)
60+
61+
Afterward, within Sentry you can connect it to that newly created source in an alert rule.
62+
63+
![incident.io alert rule](./img/incidentio-alert-rule.png)
64+
65+
66+
When the alert fires, it'll create an incident on incident.io, with all the downstream affects you set up on that side.

docs/organization/integrations/source-code-mgmt/github/index.mdx

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,13 @@ description: "Learn more about Sentry's GitHub integration and how it can track
55
---
66

77
There are two types of GitHub integrations, so make sure you're choosing the correct one:
8-
- [GitHub](#installing-github) - For regular GitHub accounts, these will have URLs like `https://github.com/org-name`. Follow the '[Installing GitHub](#installing-github)' instructions, **do not use the GitHub Enterprise integration**.
9-
- [GitHub Enterprise](#installing-github-enterprise) - For GitHub Enterprise Cloud or GitHub Enterprise Server instances. Some example URLs:
10-
- `https://github.org-name.com`
11-
- `https://github.com/enterprises/org-name`
12-
- `https://org-name.ghe.com/`
8+
- [GitHub](#installing-github) - For individual GitHub users/organizations (as well as most GitHub Enterprise Cloud customers), so long as they are hosted on `github.com`. Follow the '[Installing GitHub](#installing-github)' instructions, **Please begin the installation from Sentry**.
139

14-
These [can also be modified](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-your-enterprise-account/changing-the-url-for-your-enterprise) so make sure you have have the correct URL during installation. For these accounts, follow the '[Installing GitHub Enterprise](#installing-github-enterprise)' instructions, **do not use the regular GitHub integration**.
10+
- [GitHub Enterprise](#installing-github-enterprise) - For GitHub Enterprise instances that **cannot be accessed from `github.com`**. Usually these will have a custom domain, for example:
11+
- `https://github.example.com`
12+
- `https://ghe.example.com/`
1513

16-
## Installing GitHub
14+
For these accounts, follow the '[Installing GitHub Enterprise](#installing-github-enterprise)' instructions.
1715

1816
<Alert>
1917

docs/platforms/dotnet/common/security-policy-reporting/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Set Up Security Policy Reporting
33
sidebar_title: Security Policy Reporting
44
sidebar_order: 7500
5-
description: "Learn how Sentry can help manage Content-Security-Policy violations, CSP reports, Expect-CT, and HTTP Public Key Pinning (HPKP) failures here."
5+
description: "Learn how Sentry can help manage Content-Security-Policy violations and reports here."
66
---
77

88
<Include name="platforms/security-policy-reporting/content.mdx" />

docs/platforms/elixir/security-policy-reporting/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Set Up Security Policy Reporting
33
sidebar_title: Security Policy Reporting
44
sidebar_order: 7500
5-
description: "Learn how Sentry can help manage Content-Security-Policy violations, CSP reports, Expect-CT, and HTTP Public Key Pinning (HPKP) failures here."
5+
description: "Learn how Sentry can help manage Content-Security-Policy violations and reports here."
66
---
77

88
<Include name="platforms/security-policy-reporting/content.mdx" />

0 commit comments

Comments
 (0)