Skip to content

Commit 41be196

Browse files
authored
docs(data-forwarding): More provider specific details and optimized images (#15745)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR - This PR adds a lot more detail to the installation instructions and data forwarder details. - New screenshots that have all been passed through ImageOptim as well ## 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+
1 parent beee511 commit 41be196

Some content is hidden

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

44 files changed

+324
-337
lines changed

docs/concepts/data-management/data-forwarding.mdx

Lines changed: 0 additions & 57 deletions
This file was deleted.
101 KB
Loading
176 KB
Loading
66.7 KB
Loading
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Amazon SQS
3+
sidebar_order: 3
4+
description: >-
5+
Learn about Sentry's Amazon SQS data forwarder, which enables creating custom data pipelines with Sentry errors through AWS.
6+
---
7+
8+
<Alert>
9+
Data Forwarding is currently in a limited preview, and may not be accessible to all organizations.
10+
</Alert>
11+
12+
Amazon SQS is a generic queueing service provided by Amazon Web Services that Sentry supports sending error events to. The SQS forwarder may be useful for building your own data pipelines that might require Sentry errors as a source to eventually compare with some other data living elsewhere.
13+
14+
Sentry supports Amazon SQS as a first-party **Data Forwarder**, which currently only supports forwarding error events. For more details on Data Forwarding in general (including basic setup and overrides), check out the [Data Forwarding](/organization/integrations/data-forwarding/) documentation.
15+
16+
## Installation
17+
18+
Navigate to **Settings » Data Forwarding** and add a new forwarder.
19+
20+
Ensure you have selected _Amazon SQS_ as the provider. For standard queues, the required fields are the **Queue URL**, **Region**, **Access Key**, and **Secret Key**.
21+
If you are using a FIFO queue (`.fifo` suffix on your Queue URL), you will also need to provide a **Message Group ID**.
22+
23+
Optionally, you can also provide an **S3 Bucket** for storing events. This will allow forwarding of event payloads greater than 256KB, and the SQS message will contain the bucket URL for the event instead of the event payload itself.
24+
25+
![Amazon SQS data forwarder configuration form](./img/sentry-config-form.png)
26+
27+
For an AWS Access Key and Secret Key, you can get these from the AWS IAM console. Navigate to **IAM > Users > [Your User] > Security credentials** and click on **Create access key**.
28+
29+
![Amazon IAM access key settings](./img/iam-config.png)
30+
31+
For the Queue URL, Navigate to **Amazon SQS > Queues > [Your Queue]** and click on the name of the queue you'd like to use, or create a new one. Afterward, the details should be visible. This also apples to the S3 Bucket (if you are using one, **Amazon S3 > Buckets > [Your Bucket]**).
32+
33+
![Amazon SQS queue details](./img/sqs-config.png)
34+
35+
If you are using an S3 Bucket, ensure it is in the same region as the SQS queue.
36+
37+
The payload for the SQS message (or S3 bucket object) 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/).
38+
39+
Once you’ve filled in the required fields, and added any projects you'd like events forwarded for, click **Complete Setup**. These projects will now begin forwarding events to your SQS queue!
40+
41+
If you modify any of the above details from the AWS console, you'll have to update the forwarder you've configured in Sentry as well, manually.
42+
43+
If you wish to modify your forwarder configuration per project, you can do so by following the [Project Overrides documentation](/organization/integrations/data-forwarding/#project-overrides).
44+
45+
## Troubleshooting
46+
47+
- Unlike the other data forwarders, Sentry does not rate limit its sending of events to Amazon SQS. This is separate from the rate limit Amazon SQS enforces. Keep that in mind if you are noticing inconsistencies in your data, or missing events.
48+
- Double check that your specified region is correct, both when monitoring the queue/bucket in AWS, and configuring the forwarder in Sentry. Sentry expects the region in the format of `us-east-1`, `us-west-1`, etc.
49+
- If your Sentry event payloads are greater than 256KB and you have not provided an S3 Bucket, the event will _not_ be forwarded to your SQS queue. You'll need to setup an S3 Bucket for these events to be forwarded.
50+
- If you are using an S3 Bucket, ensure it is in the same AWS region as the SQS queue otherwise you may experience issues with forwarding events.
85.5 KB
Loading

docs/organization/integrations/data-visualization/grafana.mdx renamed to docs/organization/integrations/data-forwarding/grafana/index.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
---
22
title: Grafana
3-
sidebar_order: 1
3+
sidebar_order: 4
44
description: "Learn about Sentry's Grafana integration, which allows you to query and visualize Sentry data within Grafana."
55
---
66

77
<Alert level="warning">
8-
98
If you make changes to your organization slug, you'll need to update your configuration for this integration. Learn more in our [troubleshooting guide](/organization/integrations/troubleshooting).
10-
119
</Alert>
1210

1311
Visualize your Sentry [Issues](/product/issues/) and [Stats](/product/stats/) data in Grafana with the Sentry [data source plugin](https://grafana.com/grafana/plugins/grafana-sentry-datasource/). Once installed, you can combine Sentry data with that of other sources, like your infrastructure data through Prometheus or your business data from your data warehouse, in a single dashboard.
12+
13+
Unlike [Segment](../segment/), [Amazon SQS](../amazon-sqs/), and [Splunk](../splunk/), Grafana is not supported as a first-party data forwarder. Instead, you can find the installation instructions in the integration directory page.
14+
15+
![Grafana integration directory listing](./img/grafana-install.png)
16+
17+
Note: These instructions and the Grafana integration are maintained by Grafana Labs.
57.4 KB
Loading
261 KB
Loading
126 KB
Loading

0 commit comments

Comments
 (0)