Skip to content

Commit ff09ab4

Browse files
liuirene256Irene Liu
andauthored
df docs (#15704)
Add data forwarding page under /organizations/integrations/data-forwarding ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] None: Not urgent, can wait up to 1 week+ ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [x] 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: Irene Liu <[email protected]>
1 parent 478847f commit ff09ab4

File tree

5 files changed

+74
-0
lines changed

5 files changed

+74
-0
lines changed
60.2 KB
Loading
234 KB
Loading
59.8 KB
Loading
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: "Data Forwarding"
3+
sidebar_order: 3
4+
description: "Learn about forwarding processed events to third-party providers."
5+
---
6+
7+
<Include name="feature-available-for-plan-trial-business.mdx" />
8+
9+
<Alert>
10+
11+
The plugins listed on this page have been deprecated and will be removed from Sentry in a future date.
12+
13+
</Alert>
14+
15+
Sentry provides the ability to forward processed error events to certain third-party providers, namely [Segment](https://segment.com), [Amazon SQS](https://aws.amazon.com/sqs/), and [Splunk](https://www.splunk.com/).
16+
17+
This is often useful when you may want to analyze exceptions more deeply, or empower other teams, such as a Business Intelligence function.
18+
19+
Only error events will be forwarded. Forwarding of transaction events is not supported.
20+
21+
Configure Data Forwarding for your organization by navigating to **Settings » Data Forwarding**, then providing the required information for the given integration. Note that only one org-level forwarder can be created for each integration. However,
22+
configs can be overridden with [project overrides](./project-overrides).
23+
24+
## Amazon SQS
25+
26+
Integration with Amazon SQS makes it quick and easy to pipe exceptions back into your own systems.
27+
28+
The payload for Amazon is identical to our standard API event payload, and will evolve over time. For more details on the format of this data, see our [API documentation](/api/events/retrieve-an-event-for-a-project/).
29+
30+
## Segment
31+
32+
The Segment integration will generate _Error Captured_ events within your data pipeline. These events will **only** be captured for `error` events, and only when an ID is present the user context. The general shape of the event will look roughly similar to:
33+
34+
```json
35+
{
36+
"userId": "1",
37+
"event": "Error Captured",
38+
"properties": {
39+
"environment": "production",
40+
"eventId": "002c8bbde8324dae9f12a0b96f5b1e51",
41+
"exceptionType": "ValueError",
42+
"release": "a2def1",
43+
"transaction": "/api/0/users/{user}/",
44+
"userAgent": "Mozilla/5.0 (X11; Linux x86_64; rv:54.0) Gecko/20100101 Firefox/54.0",
45+
"page": {
46+
"url": "https://sentry.io/api/0/users/{user}/",
47+
"method": "GET",
48+
"search": "",
49+
"referer": "https://sentry.io/"
50+
}
51+
},
52+
"timestamp": "2017-05-20T15:29:06Z"
53+
}
54+
```
55+
56+
## Splunk
57+
58+
For details on the Splunk integration, visit the dedicated [Splunk integration documentation](/organization/integrations/data-visualization/splunk/).
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: "Project Overrides"
3+
description: "Learn more about setting up a project override for data forwarding."
4+
---
5+
6+
Project Overrides allows you to have a different forwarding configuration to be different for a particular project. They can be configured for each provider by navigating to **Settings » Data Forwarding » [Provider] » Edit** and scrolling down to **Manage your overrides**.
7+
8+
![Edit Project Overrides Section](./img/project-overrides.png)
9+
10+
Click on the project you wish to override and provide inputs for the particular fields you wish to override. Note that fields you do not fill in will use the main org-level config fields.
11+
12+
![Edit Project's Config Field](./img/project-override-field.png)
13+
14+
Click Save Override to apply the new field. Now the project should say it's "Forwarding with Overrides".
15+
16+
![Edit Project Overrides Section](./img/project-overrides.png)

0 commit comments

Comments
 (0)