diff --git a/docs/concepts/data-management/data-forwarding.mdx b/docs/concepts/data-management/data-forwarding.mdx deleted file mode 100644 index e78dafd2314486..00000000000000 --- a/docs/concepts/data-management/data-forwarding.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "Data Forwarding" -sidebar_order: 3 -description: "Learn about forwarding processed events to third-party providers." ---- - - - - - -The plugins listed on this page have been deprecated and will be removed from Sentry in a future date. - - - -Sentry provides the ability to forward processed error events to certain third-party providers, such as [Segment](https://segment.com) and [Amazon SQS](https://aws.amazon.com/sqs/). - -This is often useful when you may want to analyze exceptions more deeply, or empower other teams, such as a Business Intelligence function. - -Configure Data Forwarding by navigating to your **[Project] » Settings » Data Forwarding**, then providing the required information for the given integration. - -Only error events will be forwarded. Forwarding of transaction events is not supported. - -## Amazon SQS - -Integration with Amazon SQS makes it quick and easy to pipe exceptions back into your own systems. - -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/). - -## Segment - -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: - -```json -{ - "userId": "1", - "event": "Error Captured", - "properties": { - "environment": "production", - "eventId": "002c8bbde8324dae9f12a0b96f5b1e51", - "exceptionType": "ValueError", - "release": "a2def1", - "transaction": "/api/0/users/{user}/", - "userAgent": "Mozilla/5.0 (X11; Linux x86_64; rv:54.0) Gecko/20100101 Firefox/54.0", - "page": { - "url": "https://sentry.io/api/0/users/{user}/", - "method": "GET", - "search": "", - "referer": "https://sentry.io/" - } - }, - "timestamp": "2017-05-20T15:29:06Z" -} -``` - -## Splunk - -For details on the Splunk integration, visit the dedicated [Splunk integration documentation](/organization/integrations/data-visualization/splunk/). diff --git a/docs/organization/integrations/data-forwarding/amazon-sqs/img/iam-config.png b/docs/organization/integrations/data-forwarding/amazon-sqs/img/iam-config.png new file mode 100644 index 00000000000000..7fa2e158de6266 Binary files /dev/null and b/docs/organization/integrations/data-forwarding/amazon-sqs/img/iam-config.png differ diff --git a/docs/organization/integrations/data-forwarding/amazon-sqs/img/sentry-config-form.png b/docs/organization/integrations/data-forwarding/amazon-sqs/img/sentry-config-form.png new file mode 100644 index 00000000000000..03cf3b4fdf3718 Binary files /dev/null and b/docs/organization/integrations/data-forwarding/amazon-sqs/img/sentry-config-form.png differ diff --git a/docs/organization/integrations/data-forwarding/amazon-sqs/img/sqs-config.png b/docs/organization/integrations/data-forwarding/amazon-sqs/img/sqs-config.png new file mode 100644 index 00000000000000..572a5b47580450 Binary files /dev/null and b/docs/organization/integrations/data-forwarding/amazon-sqs/img/sqs-config.png differ diff --git a/docs/organization/integrations/data-forwarding/amazon-sqs/index.mdx b/docs/organization/integrations/data-forwarding/amazon-sqs/index.mdx new file mode 100644 index 00000000000000..1b2828d9adf630 --- /dev/null +++ b/docs/organization/integrations/data-forwarding/amazon-sqs/index.mdx @@ -0,0 +1,50 @@ +--- +title: Amazon SQS +sidebar_order: 3 +description: >- + Learn about Sentry's Amazon SQS data forwarder, which enables creating custom data pipelines with Sentry errors through AWS. +--- + + +Data Forwarding is currently in a limited preview, and may not be accessible to all organizations. + + +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. + +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. + +## Installation + +Navigate to **Settings » Data Forwarding** and add a new forwarder. + +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**. +If you are using a FIFO queue (`.fifo` suffix on your Queue URL), you will also need to provide a **Message Group ID**. + +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. + +![Amazon SQS data forwarder configuration form](./img/sentry-config-form.png) + +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**. + +![Amazon IAM access key settings](./img/iam-config.png) + +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]**). + +![Amazon SQS queue details](./img/sqs-config.png) + +If you are using an S3 Bucket, ensure it is in the same region as the SQS queue. + +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/). + +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! + +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. + +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). + +## Troubleshooting + +- 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. +- 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. +- 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. +- 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. \ No newline at end of file diff --git a/docs/organization/integrations/data-forwarding/grafana/img/grafana-install.png b/docs/organization/integrations/data-forwarding/grafana/img/grafana-install.png new file mode 100644 index 00000000000000..54a1687e48aacc Binary files /dev/null and b/docs/organization/integrations/data-forwarding/grafana/img/grafana-install.png differ diff --git a/docs/organization/integrations/data-visualization/grafana.mdx b/docs/organization/integrations/data-forwarding/grafana/index.mdx similarity index 65% rename from docs/organization/integrations/data-visualization/grafana.mdx rename to docs/organization/integrations/data-forwarding/grafana/index.mdx index b5617df34238bd..9b3c2814687748 100644 --- a/docs/organization/integrations/data-visualization/grafana.mdx +++ b/docs/organization/integrations/data-forwarding/grafana/index.mdx @@ -1,13 +1,17 @@ --- title: Grafana -sidebar_order: 1 +sidebar_order: 4 description: "Learn about Sentry's Grafana integration, which allows you to query and visualize Sentry data within Grafana." --- - 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). - 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. + +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. + +![Grafana integration directory listing](./img/grafana-install.png) + +Note: These instructions and the Grafana integration are maintained by Grafana Labs. diff --git a/docs/organization/integrations/data-forwarding/img/df-edit-page.png b/docs/organization/integrations/data-forwarding/img/df-edit-page.png new file mode 100644 index 00000000000000..780d52561f7267 Binary files /dev/null and b/docs/organization/integrations/data-forwarding/img/df-edit-page.png differ diff --git a/docs/organization/integrations/data-forwarding/img/df-landing-page.png b/docs/organization/integrations/data-forwarding/img/df-landing-page.png new file mode 100644 index 00000000000000..4c2c0f5a304ac2 Binary files /dev/null and b/docs/organization/integrations/data-forwarding/img/df-landing-page.png differ diff --git a/docs/organization/integrations/data-forwarding/img/df-override-form.png b/docs/organization/integrations/data-forwarding/img/df-override-form.png new file mode 100644 index 00000000000000..7935aa8497e1b2 Binary files /dev/null and b/docs/organization/integrations/data-forwarding/img/df-override-form.png differ diff --git a/docs/organization/integrations/data-forwarding/img/df-project-form.png b/docs/organization/integrations/data-forwarding/img/df-project-form.png new file mode 100644 index 00000000000000..4cb58824b73c77 Binary files /dev/null and b/docs/organization/integrations/data-forwarding/img/df-project-form.png differ diff --git a/docs/organization/integrations/data-forwarding/img/override-confirmation.png b/docs/organization/integrations/data-forwarding/img/override-confirmation.png deleted file mode 100644 index d9cbea64628c80..00000000000000 Binary files a/docs/organization/integrations/data-forwarding/img/override-confirmation.png and /dev/null differ diff --git a/docs/organization/integrations/data-forwarding/img/project-override-field.png b/docs/organization/integrations/data-forwarding/img/project-override-field.png deleted file mode 100644 index e77940a0b2eedd..00000000000000 Binary files a/docs/organization/integrations/data-forwarding/img/project-override-field.png and /dev/null differ diff --git a/docs/organization/integrations/data-forwarding/img/project-overrides.png b/docs/organization/integrations/data-forwarding/img/project-overrides.png deleted file mode 100644 index c40f1dd64be61c..00000000000000 Binary files a/docs/organization/integrations/data-forwarding/img/project-overrides.png and /dev/null differ diff --git a/docs/organization/integrations/data-forwarding/index.mdx b/docs/organization/integrations/data-forwarding/index.mdx index b09e0a59127cd4..3aca55565e2a0a 100644 --- a/docs/organization/integrations/data-forwarding/index.mdx +++ b/docs/organization/integrations/data-forwarding/index.mdx @@ -1,58 +1,80 @@ --- title: "Data Forwarding" -sidebar_order: 3 +sidebar_order: 60 description: "Learn about forwarding processed events to third-party providers." --- + +Data Forwarding is currently in a limited preview, and may not be accessible to all organizations. + + - +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/). + +This is often useful when you may want to analyze errors in relation to other datasets, empower teams outside of engineering, and other business intelligence use cases. +Currently, only error events will be forwarded. Forwarding of other event types (such as spans or logs) is not supported. -The plugins listed on this page have been deprecated and will be removed from Sentry in a future date. +For more details on setup and troubleshooting with specific data forwarders, refer to the provider documentation below: + - [Splunk](/organization/integrations/data-forwarding/splunk/) + - [Amazon SQS](/organization/integrations/data-forwarding/amazon-sqs/) + - [Segment](/organization/integrations/data-forwarding/segment/) +Note: Grafana is not a first-party data forwarder, and must be configured separately. For more details, refer to the [these docs](/organization/integrations/data-forwarding/grafana/). + +## Global Configuration + + +Sentry owner or manager permissions are required to setup/modify a global data forwarder. -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/). +With a global data forwarding configuration, you can setup a single forwarder for your organization and apply it to how ever many projects you'd like, with the additional ability to automatically begin forwarding events from new projects as soon as they're created. + +To setup a global forwarder, navigate to **Settings » Data Forwarding**, and start the setup for a new provider. Note that we only allow one forwarder per provider per organization. + +![Data forwarding landing page](./img/df-landing-page.png) + +When creating a new forwarder, select the provider you'd like to forward events to and fill in the required fields. Each provider requires different configuration and permissions on that service, so please refer to the documentation below for more details on your specific provider. After a forwarder is created, you will not be able to switch providers, but you can modify the forwarding details at any time. + +![Data forwarding global configuration form](./splunk/img/sentry-config-form.png) + +You cannot create project-level overrides until you've setup the forwarder for the first time. Any projects you connect to the forwarder will begin forwarding (with the global configuration) as soon you complete the setup. You can also specify if new projects should automatically adopt the global configuration now. + +![Data forwarding project configuration form](./img/df-project-form.png) + +After completing the setup, you will be redirected to the forwarder list page, where you can see the newly-enabled forwarder and it's current status. Now you can edit the forwarder to add project-level overrides, if necessary. + +![Data forwarding edit list page](./img/df-edit-page.png) + +## Project Overrides + + +Owner, manager, or admin permissions are required to create/modify project-level overrides. + +Users with Team Admin permissions can create/modify overrides as well, but only for their respective teams' projects. + -This is often useful when you may want to analyze exceptions more deeply, or empower other teams, such as a Business Intelligence function. +You can manage your project overrides by navigating to **Settings » Data Forwarding » [Provider] » Edit** and scrolling to **Manage your overrides**. -Only error events will be forwarded. Forwarding of transaction events is not supported. +A project override will allow you to replace specified fields in the global configuration with custom values for a particular project. All the previously required fields on the provider are marked as optional, and only the specified fields will be overridden. If no value is provided for a field, the global configuration will be used. -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, -configs can be overridden with [project overrides](./project-overrides). +![Data forwarding project override form](./img/df-override-form.png) -## Amazon SQS +Empty values (`""`) are permitted in the override form, so manually deleting an override will _not_ revert to the global configuration. If you wish to remove an override, be sure to click the **Clear Override** button at the bottom of the form. After saving, be sure to check the status of the override in the corner of it's form. -Integration with Amazon SQS makes it quick and easy to pipe exceptions back into your own systems. +### Migrating from Legacy Integrations -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/). +If you've been a Sentry customer for a while, you may have seen a legacy version of data forwarding which was applied at the project level through legacy integrations (plugins). This is no longer supported, and organizations should see they've been automatically migrated to the new global (organization-level) configuration. -## Segment +The migration process will retain all the project-level configuration using the project-overrides, which you can manage/modify as needed. -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: -```json -{ - "userId": "1", - "event": "Error Captured", - "properties": { - "environment": "production", - "eventId": "002c8bbde8324dae9f12a0b96f5b1e51", - "exceptionType": "ValueError", - "release": "a2def1", - "transaction": "/api/0/users/{user}/", - "userAgent": "Mozilla/5.0 (X11; Linux x86_64; rv:54.0) Gecko/20100101 Firefox/54.0", - "page": { - "url": "https://sentry.io/api/0/users/{user}/", - "method": "GET", - "search": "", - "referer": "https://sentry.io/" - } - }, - "timestamp": "2017-05-20T15:29:06Z" -} -``` +## Troubleshooting -## Splunk +For provider-specific troubleshooting, refer to the provider documentation below: + - [Splunk](/organization/integrations/data-forwarding/splunk/#troubleshooting) + - [Amazon SQS](/organization/integrations/data-forwarding/amazon-sqs/#troubleshooting) + - [Segment](/organization/integrations/data-forwarding/segment/#troubleshooting) + - [Grafana (Third-Party)](/organization/integrations/data-forwarding/grafana/) + -For details on the Splunk integration, visit the dedicated [Splunk integration documentation](/organization/integrations/data-visualization/splunk/). diff --git a/docs/organization/integrations/data-forwarding/project-overrides.mdx b/docs/organization/integrations/data-forwarding/project-overrides.mdx deleted file mode 100644 index 9b5d2ab104f8c0..00000000000000 --- a/docs/organization/integrations/data-forwarding/project-overrides.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Project Overrides" -description: "Learn more about setting up a project override for data forwarding." ---- - -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**. - -![Edit Project Overrides Section](./img/project-overrides.png) - -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. - -![Edit Project's Config Field](./img/project-override-field.png) - -Click Save Override to apply the new field. Now the project should say it's "Forwarding with Overrides". - -![Edit Project Overrides Section](./img/project-overrides.png) \ No newline at end of file diff --git a/docs/organization/integrations/data-forwarding/segment/img/segment-source-catalog.png b/docs/organization/integrations/data-forwarding/segment/img/segment-source-catalog.png new file mode 100644 index 00000000000000..cd6c09431dc66f Binary files /dev/null and b/docs/organization/integrations/data-forwarding/segment/img/segment-source-catalog.png differ diff --git a/docs/organization/integrations/data-forwarding/segment/img/segment-source-config.png b/docs/organization/integrations/data-forwarding/segment/img/segment-source-config.png new file mode 100644 index 00000000000000..f65d6beedc3a2a Binary files /dev/null and b/docs/organization/integrations/data-forwarding/segment/img/segment-source-config.png differ diff --git a/docs/organization/integrations/data-forwarding/segment/img/sentry-config-form.png b/docs/organization/integrations/data-forwarding/segment/img/sentry-config-form.png new file mode 100644 index 00000000000000..05c0a6756f2ac4 Binary files /dev/null and b/docs/organization/integrations/data-forwarding/segment/img/sentry-config-form.png differ diff --git a/docs/organization/integrations/data-forwarding/segment/index.mdx b/docs/organization/integrations/data-forwarding/segment/index.mdx new file mode 100644 index 00000000000000..5c1ffa71ea3c3b --- /dev/null +++ b/docs/organization/integrations/data-forwarding/segment/index.mdx @@ -0,0 +1,64 @@ +--- +title: Segment +sidebar_order: 2 +description: >- + Learn about Sentry's Segment data forwarder, which enables tracking Sentry errors as Segment events. +--- + + +Data Forwarding is currently in a limited preview, and may not be accessible to all organizations. + + +Segment is useful for collecting, responsibly managing, and integrating your customer data with many other applications, including Sentry. + +Sentry supports Segment 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. + +## Installation + +Navigate to **Settings » Data Forwarding** and add a new forwarder. + +Ensure you have selected _Segment_ as the provider. The only required field for Segment is the **Write Key**. + +![Segment data forwarder configuration form](./img/sentry-config-form.png) + +You can get this value in your Segment workspace by navigating to **Connections > Catalog** and searching for **HTTP API**. This is a generic server forwarder that has the write key we'll need. + +![Segment HTTP API source in catalog](./img/segment-source-catalog.png) + +Click on **Add Source**, and it should provide you with a write key you can copy into Sentry's configuration form. + +![Segment source configuration view](./img/segment-source-config.png) + +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 Segment workspace! + +If you modify the Segment write key later on, you'll have to update the forwarder you've configured in Sentry as well, manually. + +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). + +## Troubleshooting + +- Sentry rate limits its sending of events to Segment at approximately 200 requests per second per organization. This is separate from the rate limit Segment enforces. Keep that in mind if you are noticing inconsistencies in your data, or missing events. +- Sentry will only forward error events to Segment when a [User, with an ID](/platforms/python/enriching-events/identify-user/) is present in the event context. +- Sentry uses a fixed event name of "Error Captured" for the event that is forwarded to Segment. At the moment, this cannot be modified. The general shape of the event will look roughly similar to: + +```json +{ + "userId": "1", + "event": "Error Captured", + "properties": { + "environment": "production", + "eventId": "002c8bbde8324dae9f12a0b96f5b1e51", + "exceptionType": "ValueError", + "release": "a2def1", + "transaction": "/api/0/users/{user}/", + "userAgent": "Mozilla/5.0 (X11; Linux x86_64; rv:54.0) Gecko/20100101 Firefox/54.0", + "page": { + "url": "https://sentry.io/api/0/users/{user}/", + "method": "GET", + "search": "", + "referer": "https://sentry.io/" + } + }, + "timestamp": "2017-05-20T15:29:06Z" +} +``` \ No newline at end of file diff --git a/docs/organization/integrations/data-forwarding/splunk/img/sentry-config-form.png b/docs/organization/integrations/data-forwarding/splunk/img/sentry-config-form.png new file mode 100644 index 00000000000000..6e949c0f96dfa5 Binary files /dev/null and b/docs/organization/integrations/data-forwarding/splunk/img/sentry-config-form.png differ diff --git a/docs/organization/integrations/data-visualization/splunk/img/splunk-data-inputs.png b/docs/organization/integrations/data-forwarding/splunk/img/splunk-data-inputs.png similarity index 100% rename from docs/organization/integrations/data-visualization/splunk/img/splunk-data-inputs.png rename to docs/organization/integrations/data-forwarding/splunk/img/splunk-data-inputs.png diff --git a/docs/organization/integrations/data-visualization/splunk/img/splunk-hec-global-settings.png b/docs/organization/integrations/data-forwarding/splunk/img/splunk-hec-global-settings.png similarity index 100% rename from docs/organization/integrations/data-visualization/splunk/img/splunk-hec-global-settings.png rename to docs/organization/integrations/data-forwarding/splunk/img/splunk-hec-global-settings.png diff --git a/docs/organization/integrations/data-visualization/splunk/img/splunk-hec-inputs.png b/docs/organization/integrations/data-forwarding/splunk/img/splunk-hec-inputs.png similarity index 100% rename from docs/organization/integrations/data-visualization/splunk/img/splunk-hec-inputs.png rename to docs/organization/integrations/data-forwarding/splunk/img/splunk-hec-inputs.png diff --git a/docs/organization/integrations/data-visualization/splunk/img/splunk-new-http-input.png b/docs/organization/integrations/data-forwarding/splunk/img/splunk-new-http-input.png similarity index 100% rename from docs/organization/integrations/data-visualization/splunk/img/splunk-new-http-input.png rename to docs/organization/integrations/data-forwarding/splunk/img/splunk-new-http-input.png diff --git a/docs/organization/integrations/data-visualization/splunk/img/splunk-new-input-final.png b/docs/organization/integrations/data-forwarding/splunk/img/splunk-new-input-final.png similarity index 100% rename from docs/organization/integrations/data-visualization/splunk/img/splunk-new-input-final.png rename to docs/organization/integrations/data-forwarding/splunk/img/splunk-new-input-final.png diff --git a/docs/organization/integrations/data-visualization/splunk/img/splunk-new-input-index.png b/docs/organization/integrations/data-forwarding/splunk/img/splunk-new-input-index.png similarity index 100% rename from docs/organization/integrations/data-visualization/splunk/img/splunk-new-input-index.png rename to docs/organization/integrations/data-forwarding/splunk/img/splunk-new-input-index.png diff --git a/docs/organization/integrations/data-visualization/splunk/img/splunk-new-input-name.png b/docs/organization/integrations/data-forwarding/splunk/img/splunk-new-input-name.png similarity index 100% rename from docs/organization/integrations/data-visualization/splunk/img/splunk-new-input-name.png rename to docs/organization/integrations/data-forwarding/splunk/img/splunk-new-input-name.png diff --git a/docs/organization/integrations/data-visualization/splunk/img/splunk-new-input-review.png b/docs/organization/integrations/data-forwarding/splunk/img/splunk-new-input-review.png similarity index 100% rename from docs/organization/integrations/data-visualization/splunk/img/splunk-new-input-review.png rename to docs/organization/integrations/data-forwarding/splunk/img/splunk-new-input-review.png diff --git a/docs/organization/integrations/data-visualization/splunk/img/splunk-search-sentry.png b/docs/organization/integrations/data-forwarding/splunk/img/splunk-search-sentry.png similarity index 100% rename from docs/organization/integrations/data-visualization/splunk/img/splunk-search-sentry.png rename to docs/organization/integrations/data-forwarding/splunk/img/splunk-search-sentry.png diff --git a/docs/organization/integrations/data-visualization/splunk/img/splunk-settings.png b/docs/organization/integrations/data-forwarding/splunk/img/splunk-settings.png similarity index 100% rename from docs/organization/integrations/data-visualization/splunk/img/splunk-settings.png rename to docs/organization/integrations/data-forwarding/splunk/img/splunk-settings.png diff --git a/docs/organization/integrations/data-forwarding/splunk/index.mdx b/docs/organization/integrations/data-forwarding/splunk/index.mdx new file mode 100644 index 00000000000000..49e802d8657048 --- /dev/null +++ b/docs/organization/integrations/data-forwarding/splunk/index.mdx @@ -0,0 +1,108 @@ +--- +title: Splunk +sidebar_order: 1 +description: >- + Learn about Sentry's Splunk data forwarder, which enables collecting Sentry Errors in your Splunk Cloud instance through an HTTP Event Collector. +--- + +Data Forwarding is currently in a limited preview, and may not be accessible to all organizations. + + +Splunk is a popular business intelligence and analytics platform for collecting, storing and analyzing your data from whatever source you need, including Sentry. + +Sentry supports Splunk 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. + + +We only support Splunk Cloud plans. We do not support Splunk Enterprise plans. See the [Splunk documentation](https://dev.splunk.com/) for specific details on your Splunk installation. + + +## Installation + + +Navigate to **Settings » Data Forwarding** and add a new forwarder. + +Ensure you have selected _Splunk_ as the provider. All of the fields are required for splunk; **Instance URL**, **Index**, **Source**, and **Token**. + +![Splunk data forwarder configuration form](./img/sentry-config-form.png) + +To fill out these values, you'll need your Splunk instance setup properly first. + +### Enabling an HTTP Event Collector in Splunk + +To get started, you’ll need to first enable the HTTP Event Collector: + +Under **Settings**, select **Data Inputs**: + +![Splunk settings](./img/splunk-settings.png) + +Select **HTTP Event Collector** under Local Inputs: + +![Splunk data inputs](./img/splunk-data-inputs.png) + +Under your HEC settings, click "Global Settings": + +![Splunk HEC inputs](./img/splunk-hec-inputs.png) + +Change **All Tokens** to **Enabled**, and note the HTTP Port Number (`8088` by default): + +![Splunk global settings](./img/splunk-hec-global-settings.png) + + + +If you’re running Splunk in a privileged environment, you may need to expose the HEC port. + + + +### Creating a Sentry Input in Splunk + +Under HTTP Event Collector, create a new Sentry input by clicking "New Token": + +![Splunk Sentry input](./img/splunk-new-http-input.png) + +Enter a name (e.g. `sentry`), and click "Next": + +![Input a name in Splunk](./img/splunk-new-input-name.png) + +Select the index you wish to make accessible (e.g. `main`), and click "Review": + +![Select index in Splunk](./img/splunk-new-input-index.png) + +You’ll be prompted to review the input details. Click "Submit" to continue: + +![Review form before submitting](./img/splunk-new-input-review.png) + +The input has now been created, and you should be presented with the **Token Value**: + +![Token has been successfully created in Splunk](./img/splunk-new-input-final.png) + +### Finish the Setup in Sentry + +Now, you can finish setting up the forwarder in Sentry. + +Your **Instance URL** is going to vary based on the type of Splunk service you’re using. If you’re using self-service Splunk Cloud, the instance URL will be the URL of the Splunk instance running the HTTP Event Collector (HEC): + +``` +https://:8088 +``` + +For all other Splunk Cloud plans, you’ll use the `http-inputs` prefix: + +``` +https://http-inputs-:8088 +``` + +If you’re using Splunk behind your firewall, you’ll need to fill in the appropriate host. + +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 Splunk instance! + +![Splunk page showing Sentry data](./img/splunk-search-sentry.png) + + + +If you modify any of the above details from the Splunk console, you'll have to update the forwarder you've configured in Sentry as well, manually. + +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). + +## Troubleshooting + +- Sentry rate limits its sending of events to Splunk at approximately 1000 requests per second per _unique token_. This is separate from the rate limit Splunk enforces. Keep that in mind if you are noticing inconsistencies in your data, or missing events. \ No newline at end of file diff --git a/docs/organization/integrations/data-visualization/amazon-sqs/img/amazon-sqs.png b/docs/organization/integrations/data-visualization/amazon-sqs/img/amazon-sqs.png deleted file mode 100644 index 3bad01422fc9df..00000000000000 Binary files a/docs/organization/integrations/data-visualization/amazon-sqs/img/amazon-sqs.png and /dev/null differ diff --git a/docs/organization/integrations/data-visualization/amazon-sqs/index.mdx b/docs/organization/integrations/data-visualization/amazon-sqs/index.mdx deleted file mode 100644 index 397360990e6bb8..00000000000000 --- a/docs/organization/integrations/data-visualization/amazon-sqs/index.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Amazon SQS (Legacy) -sidebar_order: 1 -description: >- - Learn about Sentry's Amazon SQS integration, which allows you to forward - Sentry events to Amazon SQS for further analysis. -og_image: /og-images/organization-integrations-data-visualization-amazon-sqs.png ---- - - -Amazon SQS integration is deprecated and is not available to be installed on new projects. - - -Amazon SQS is useful for a more in-depth analysis of exceptions, making it quick and easy to pipe exceptions back into your own systems. Or, use it to empower other teams, such as a Business Intelligence function. - -This integration needs to be set up in each project for which you wish to use it. It is maintained and supported by the [Sentry community](https://open.sentry.io/). - -## Install and Configure - - - -Sentry owner, manager, or admin permissions are required to install this integration. - - - -Navigate to **Settings > Integrations > Amazon SQS** - -![Install Amazon SQS integration](./img/amazon-sqs.png) - -### Data Forwarding - -Configure [data forwarding](/concepts/data-management/data-forwarding/) in **[Project] > Settings > Data Forwarding**, and provide the required information for the given integration. - -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/). diff --git a/docs/organization/integrations/data-visualization/index.mdx b/docs/organization/integrations/data-visualization/index.mdx deleted file mode 100644 index f7230cf0caaef1..00000000000000 --- a/docs/organization/integrations/data-visualization/index.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Data & Visualization -sidebar_order: 60 -description: "Learn more about Sentry's data and visualization integrations." ---- - -- [Amazon SQS (Legacy)](/organization/integrations/data-visualization/amazon-sqs/) -- [Grafana](/organization/integrations/data-visualization/grafana/) -- [Segment (Legacy)](/organization/integrations/data-visualization/segment/) -- [Splunk (Legacy)](/organization/integrations/data-visualization/splunk/) diff --git a/docs/organization/integrations/data-visualization/segment/img/segment.png b/docs/organization/integrations/data-visualization/segment/img/segment.png deleted file mode 100644 index 6469276f962c07..00000000000000 Binary files a/docs/organization/integrations/data-visualization/segment/img/segment.png and /dev/null differ diff --git a/docs/organization/integrations/data-visualization/segment/index.mdx b/docs/organization/integrations/data-visualization/segment/index.mdx deleted file mode 100644 index 88120bfaeb11eb..00000000000000 --- a/docs/organization/integrations/data-visualization/segment/index.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Segment (Legacy) -sidebar_order: 1 -description: >- - Learn about Sentry's Segment integration, which allows you to collect all your - client-side data for Sentry automatically. -og_image: /og-images/organization-integrations-data-visualization-segment.png ---- - - -Segment integration is deprecated and is not available to be installed on new projects. - - - - - -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). - - - -Segment is useful for collecting, responsibly managing, and integrating your customer data with many other applications, including Sentry. - -This integration needs to be set up in each project for which you wish to use it. It is maintained and supported by the [Sentry community](https://open.sentry.io/). - -## Install and Configure - - - -Sentry owner, manager, or admin permissions are required to install this integration. - - - -Navigate to **Settings > Integrations > Segment** - -![Install Segment integration](./img/segment.png) - -### Data Forwarding - -Configure [data forwarding](/concepts/data-management/data-forwarding/) in **[Project] > Settings > Data Forwarding**, and provide the required information for the given integration. diff --git a/docs/organization/integrations/data-visualization/splunk/img/splunk-data-forwarding-setting-complete.png b/docs/organization/integrations/data-visualization/splunk/img/splunk-data-forwarding-setting-complete.png deleted file mode 100644 index c99710092afd88..00000000000000 Binary files a/docs/organization/integrations/data-visualization/splunk/img/splunk-data-forwarding-setting-complete.png and /dev/null differ diff --git a/docs/organization/integrations/data-visualization/splunk/img/splunk-data-forwarding-setting.png b/docs/organization/integrations/data-visualization/splunk/img/splunk-data-forwarding-setting.png deleted file mode 100644 index c36c9424be0a34..00000000000000 Binary files a/docs/organization/integrations/data-visualization/splunk/img/splunk-data-forwarding-setting.png and /dev/null differ diff --git a/docs/organization/integrations/data-visualization/splunk/img/splunk.png b/docs/organization/integrations/data-visualization/splunk/img/splunk.png deleted file mode 100644 index 25bc8a13179afd..00000000000000 Binary files a/docs/organization/integrations/data-visualization/splunk/img/splunk.png and /dev/null differ diff --git a/docs/organization/integrations/data-visualization/splunk/index.mdx b/docs/organization/integrations/data-visualization/splunk/index.mdx deleted file mode 100644 index e0ef64c2719762..00000000000000 --- a/docs/organization/integrations/data-visualization/splunk/index.mdx +++ /dev/null @@ -1,128 +0,0 @@ ---- -title: Splunk (Legacy) -sidebar_order: 1 -description: >- - Learn more about Sentry's Splunk integration, which allows you to send Sentry - events to Splunk. -og_image: /og-images/organization-integrations-data-visualization-splunk.png ---- - - -Splunk integration is deprecated and is not available to be installed on new projects. The following docs are relevant only to projects that already have the integration installed. - - - -Connect Splunk to Sentry with the [Data Forwarding](/concepts/data-management/data-forwarding/) feature. - - - -We only support Splunk Cloud plans. We do not support Splunk Enterprise plans. See the [Splunk documentation](https://dev.splunk.com/) for specific details on your Splunk installation. - - - -This integration needs to be set up in each project for which you wish to use it. It is maintained and supported by the [Sentry community](https://open.sentry.io/). - -## Install and Configure - - - -Sentry owner, manager, or admin permissions are required to install this integration. - - - -Navigate to **Settings > Integrations > Splunk** - -![Install Splunk integration](./img/splunk.png) - -### Enabling HEC - -To get started, you’ll need to first enable the HTTP Event Collector: - -Under **Settings**, select **Data Inputs**: - -![Splunk settings](./img/splunk-settings.png) - -Select **HTTP Event Collector** under Local Inputs: - -![Splunk data inputs](./img/splunk-data-inputs.png) - -Under your HEC settings, click "Global Settings": - -![Splunk HEC inputs](./img/splunk-hec-inputs.png) - -Change **All Tokens** to **Enabled**, and note the HTTP Port Number (`8088` by default): - -![Splunk global settings](./img/splunk-hec-global-settings.png) - - - -If you’re running Splunk in a privileged environment, you may need to expose the HEC port. - - - -### Creating a Sentry Input - -Under HTTP Event Collector, create a new Sentry input by clicking "New Token": - -![Splunk Sentry input](./img/splunk-new-http-input.png) - -Enter a name (e.g. `Sentry`), and click "Next": - -![Input a name in Splunk](./img/splunk-new-input-name.png) - -Select the index you wish to make accessible (e.g. `main`), and click "Review": - -![Select index in Splunk](./img/splunk-new-input-index.png) - -You’ll be prompted to review the input details. Click "Submit" to continue: - -![Review form before submitting](./img/splunk-new-input-review.png) - -The input has now been created, and you should be presented with the **Token Value**: - -![Token has been successfully created in Splunk](./img/splunk-new-input-final.png) - -### Enabling Splunk Forwarding - -To enable Splunk forwarding, you’ll need the following: - -- Your instance URL (see note below) -- The Sentry HEC token value - -In Sentry, navigate to the project you want to forward events from, and click "Project Settings". - -### Data Forwarding - -Configure [data forwarding](/organization/integrations/data-forwarding) in **[Organization] > Settings > Data Forwarding**. - -After navigating to **Data Forwarding**, setup a new forwarder for the Splunk integration: - -![Data forwarding settings page](./img/splunk-data-forwarding-setting.png) - -Your instance URL is going to vary based on the type of Splunk service you’re using. If you’re using self-service Splunk Cloud, the instance URL will be the URL of the Splunk instance running the HTTP Event Collector (HEC): - -``` -https://:8088 -``` - -For all other Splunk Cloud plans, you’ll use the `http-inputs` prefix: - -``` -https://http-inputs-:8088 -``` - -If you’re using Splunk behind your firewall, you’ll need to fill in the appropriate host. - -Once you’ve filled in the required fields and added the projects you want to enable splunk for, hit **Complete Setup**: - -![Splunk settings form](./img/splunk-data-forwarding-setting-complete.png) - -We’ll now begin forwarding all new events into your Splunk instance. You can enroll more projects by hitting **Edit** and adding more projects to Forwarding projects. - - - -Sentry will internally limit the maximum number of events sent to your Splunk instance to 1000 per second. - - - -![Splunk page showing Sentry data](./img/splunk-search-sentry.png) diff --git a/docs/organization/integrations/index.mdx b/docs/organization/integrations/index.mdx index 6f4ac8fec44f12..acd15c5c974613 100644 --- a/docs/organization/integrations/index.mdx +++ b/docs/organization/integrations/index.mdx @@ -89,14 +89,14 @@ For more details, see the [full Integration Platform documentation](/organizatio | [Netlify](/product/releases/setup/release-automation/netlify/) | X | X | X | X | | [Vercel](/organization/integrations/deployment/vercel/) | X | X | X | X | -## Data & Visualization +## Data Forwarding | Integration | Data Forwarding | | ------------------------------------------------------------------ | --------------- | -| [Amazon SQS (Legacy)](/organization/integrations/data-visualization/amazon-sqs/) | X | -| [Grafana](/organization/integrations/data-visualization/grafana/) | X | -| [Segment (Legacy)](/organization/integrations/data-visualization/segment/) | X | -| [Splunk (Legacy)](/organization/integrations/data-visualization/splunk/) | X | +| [Amazon SQS](/organization/integrations/data-forwarding/amazon-sqs/) | X | +| [Segment](/organization/integrations/data-forwarding/segment/) | X | +| [Splunk](/organization/integrations/data-forwarding/splunk/) | X | +| [Grafana (Third Party)](/organization/integrations/data-forwarding/grafana/) | X | ## Session Replay diff --git a/docs/organization/integrations/troubleshooting.mdx b/docs/organization/integrations/troubleshooting.mdx index b525ec73936978..99b6b1e3dd0674 100644 --- a/docs/organization/integrations/troubleshooting.mdx +++ b/docs/organization/integrations/troubleshooting.mdx @@ -16,9 +16,8 @@ Sentry integrates with many third party services to make your development experi - [GitHub Actions](/product/releases/setup/release-automation/github-actions/) - [Netlify](/product/releases/setup/release-automation/netlify/) - [Vercel](/organization/integrations/deployment/vercel/) - - [Grafana](/organization/integrations/data-visualization/grafana/) + - [Grafana](/organization/integrations/data-forwarding/grafana/) - [Split](/organization/integrations/feature-flag/split/) - - [Segment](/organization/integrations/data-visualization/segment/) - [FullStory](/organization/integrations/session-replay/fullstory/) - [OpenReplay](/organization/integrations/session-replay/openreplay/) - [SourceGraph](/organization/integrations/issue-tracking/sourcegraph/) diff --git a/src/middleware.ts b/src/middleware.ts index 8d5120a1476dcf..7ea1691778256a 100644 --- a/src/middleware.ts +++ b/src/middleware.ts @@ -1893,31 +1893,55 @@ const USER_DOCS_REDIRECTS: Redirect[] = [ }, { from: '/workflow/integrations/amazon-sqs/', - to: '/organization/integrations/data-visualization/amazon-sqs/', + to: '/organization/integrations/data-forwarding/amazon-sqs/', }, { from: '/workflow/integrations/legacy-integrations/amazon-sqs/', - to: '/organization/integrations/data-visualization/amazon-sqs/', + to: '/organization/integrations/data-forwarding/amazon-sqs/', }, { from: '/product/integrations/amazon-sqs/', - to: '/organization/integrations/data-visualization/amazon-sqs/', + to: '/organization/integrations/data-forwarding/amazon-sqs/', }, { from: '/product/integrations/segment/', - to: '/organization/integrations/data-visualization/segment/', + to: '/organization/integrations/data-forwarding/segment/', }, { from: '/workflow/integrations/splunk/', - to: '/organization/integrations/data-visualization/splunk/', + to: '/organization/integrations/data-forwarding/splunk/', }, { from: '/workflow/integrations/legacy-integrations/splunk/', - to: '/organization/integrations/data-visualization/splunk/', + to: '/organization/integrations/data-forwarding/splunk/', }, { from: '/product/integrations/splunk/', - to: '/organization/integrations/data-visualization/splunk/', + to: '/organization/integrations/data-forwarding/splunk/', + }, + { + from: '/organization/integrations/data-visualization/splunk/', + to: '/organization/integrations/data-forwarding/splunk/', + }, + { + from: '/organization/integrations/data-visualization/segment/', + to: '/organization/integrations/data-forwarding/segment/', + }, + { + from: '/organization/integrations/data-visualization/amazon-sqs/', + to: '/organization/integrations/data-forwarding/amazon-sqs/', + }, + { + from: '/organization/integrations/data-visualization/grafana/', + to: '/organization/integrations/data-forwarding/grafana/', + }, + { + from: '/organization/integrations/data-visualization/', + to: '/organization/integrations/data-forwarding/', + }, + { + from: '/concepts/data-management/data-forwarding/', + to: '/organization/integrations/data-forwarding/', }, { from: '/workflow/integrations/gitlab/',