Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sentry integration docs revamped #27

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ redirects:
alert-modes/out-of-office-mode: alerts/personal-alerts-management/out-of-office.md
alert-modes/deep-work-mode: alerts/personal-alerts-management/deep-work-and-cooldown-modes.md
alert-modes/cooldown-mode: alerts/personal-alerts-management/deep-work-and-cooldown-modes.md
alerts/vacation-mode: alerts/personal-alerts-management/out-of-office.md
alerts/vacation-mode: alerts/personal-alerts-management/out-of-office.md
integrations-guideline/integrate-spike-with-sentry-webhook: integrations-guideline/integrate-spike-with-sentry.md
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,6 @@
* [Integrate Spike with Healthchecks](integrations-guideline/integrate-healthchecks-with-spike.md)
* [Integrate Spike with Pingdom](integrations-guideline/integrate-spike-with-pingdom.md)
* [Integrate Spike.sh with Sentry](integrations-guideline/integrate-spike-with-sentry.md)
* [Integrate Spike with Sentry webhook](integrations-guideline/integrate-spike-with-sentry-webhook.md)
* [Integrate Spike with Apex ping](integrations-guideline/integrate-apex-ping-with-spike.md)
* [Integrate Spike with Uptime Robot](integrations-guideline/integrate-spike-with-uptime-robot.md)
* [Integrate Spike with Twilio](integrations-guideline/integrate-spike-with-twilio.md)
Expand Down
65 changes: 0 additions & 65 deletions integrations-guideline/integrate-spike-with-sentry-webhook.md

This file was deleted.

126 changes: 109 additions & 17 deletions integrations-guideline/integrate-spike-with-sentry.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,125 @@
# Integrate Spike.sh with Sentry
---
description: Connect Sentry with Spike and get incident alerts over phone calls, sms, Slack, etc to the on-call responder
---

## Service and Integration
<figure><img src="../.gitbook/assets/integrations/sentry/Sentry cover.png" alt=""><figcaption></figcaption></figure>

In your Spike.sh account, make sure that you have the service and integration already setup for Sentry. You can check the link below to learn how to do that.
# Integrate Spike with Sentry
[Sentry](https//sentry.io) is a powerful error monitoring and performance tracking platform designed for developers. It provides real-time insights into application issues, helping teams identify, troubleshoot, and resolve errors quickly. With detailed stack traces, performance metrics, and contextual data, Sentry ensures that you can proactively manage your application's health and deliver a seamless user experience.

{% content-ref url="create-integration-and-service-on-dashboard.md" %}
[create-integration-and-service-on-dashboard.md](create-integration-and-service-on-dashboard.md)
{% endcontent-ref %}

This guide talks about connecting Spike.sh from inside your Sentry account with the help of Spike.sh's deep integration. If you want to use the older webhook method of connecting Sentry to Spike.sh, please use [this guide](https://docs.spike.sh/integrations-guideline/integrate-spike-with-sentry-webhook).
## Overview
The Spike integration with Sentry bridges error monitoring and incident response. Connect Sentry to Spike to automatically trigger real-time incident alerts for critical errors.

## Use Spike.sh Integration on Sentry
You can setup Spike with Sentry in two ways.

* On [Sentry](https://sentry.io), go to settings > Integrations and install **our native Spike.sh Integration.**
1. Single-click install on Sentry
1. Connect with Spike webhook (_paste webhook on Sentry_)

![Select Spike.sh in your Sentry account](../.gitbook/assets/sentry-native-1.png)
### Integrating with multiple projects on Sentry
![Multiple projects on Sentry](../.gitbook/assets/integrations/sentry/sentry-multiple-projects.png)

* Sentry will redirect you to Spike.sh to select an existing Sentry integration that should be connected to your Sentry account.
To integrate multiple projects on Sentry with Spike, you will need to use both Spike app on Sentry and the webhook integration.

![Select integration on Spike.sh](<../.gitbook/assets/Screenshot 2021-03-10 at 3.23.02 AM.png>)
Consider you have services A,B, and C to integrate with Sentry.

**Service A**: Utilize Sentry's 1-click app for a streamlined integration. This is limited to a single project on Sentry.

**Services B, C and so on..**: Establish a webhook integration by creating it on [Spike](https://app.spike.sh/integrations/new) and subsequently configuring it in Sentry.

The 1-click app offers an effortless setup for one project, while the webhook integration allows for unrestricted application across multiple projects.

## How to set up?
To set up, you will need a Sentry integration on Spike no matter which way you choose. So please make sure you have created one on [Spike](https//app.spike.sh/integrations)

### 1. Single-click install on Sentry
{% tabs %}
{% tab title="Installation steps" %}
* **Install and connect**
* On Sentry, go to settings > Integrations
* Locate the Spike integration and click to begin setup.
* Sentry will redirect you to Spike, where you can select an existing Sentry integration to connect with your Sentry account.
* Choose your integration on Spike and complete the installation process.
* **Route alerts from Sentry**
* Once the installation is verified, go to the Alerts section in Sentry and configure alert rules to start receiving alerts on Spike.
* Add your conditions for alerts and in actions select **Send a notification via an integration and then Select Spike.**
{% endtab %}
{% tab title="Installation with images" %}
* On Sentry, go to settings > Integrations and install our native Spike Integration

![Select Spike in your Sentry account](../.gitbook/assets/integrations/sentry/sentry-native-1.png)

* Sentry will redirect you to Spike to select an existing Sentry integration that should be connected to your Sentry account.

![Select integration on Spike](<../.gitbook/assets/integrations/sentry/select integration on spike.png>)

* Once you have installed and the installation is verified, visit Alerts section in your Sentry account and click on **Create Alert rule.**

![Select alerts from sidebar](<../.gitbook/assets/image (44).png>)
![Select alerts from sidebar](<../.gitbook/assets/integrations/sentry/sentry - select alerts.png>)

* Add your conditions for alerts and in actions select **Send a notification via an integration and then Select Spike.**
![](<../.gitbook/assets/integrations/sentry/sentry - alert conditions.png>)
{% endtab %}
{% endtabs %}

* Test by generating a new error on Sentry.

### 2. Integrating with Sentry's webhook

{% tabs %}
{% tab title="Set up steps" %}
* **On Sentry**
* On your Sentry account, navigate to Settings > Integrations and select Webhook.
* Paste the webhook URL copied from Spike into the Webhook field in Sentry's integration settings.
* Enable the plugin to activate the integration.
* **Configure alert rules**
* Go to the Alerts section in the Sentry sidebar and select Create Alert Rule.
* Define the conditions under which alerts should be triggered.
* In the Actions section, select Send a notification via an integration and choose the Spike webhook integration.
{% endtab %}
{% tab title="Set up with images" %}
**Step 1:** On [Sentry](https://sentry.io), go to settings > Integrations and **select Webhook**

![Webhooks on Sentry](../.gitbook/assets/integrations/sentry/sentry-webhook.png)

![Add to project](<../.gitbook/assets/integrations/sentry/add to project.png>)

Paste your copied webhook from Spike to Sentry's webhook integration.

![Paste Spike webhook on Sentry](<../.gitbook/assets/integrations/sentry/paste spike webhook on sentry.png>)

{% hint style="warning" %}
Do not forget to **Enable** the plugin
{% endhint %}

**Step 2: Set up alerts**

Visit Sentry's new Alerts section from the sidebar and select **Create Alert Rule**

![](<../.gitbook/assets/integrations/sentry/sentry - alert conditions.png>)

Add your conditions for alerts and in actions select **Send a notification via an integration**

![Select notification via Integration for Webhook](../.gitbook/assets/integrations/sentry/sentry-alert-2.png)

This is how the end result might look

![Spike webook integration on Sentry](<../.gitbook/assets/integrations/sentry/webhooks-end-result.png>)

{% endtab %}
{% endtabs %}

* Add your conditions for alerts and in actions select **Send a notification via an integration and then Select Spike.sh.**
* Test by generating a new error on Sentry.

![](<../.gitbook/assets/image (45).png>)
## FAQs

* You can test the integration alerts by generating a new error on Sentry.
<details>
<summary>Why create a Sentry integration on Spike?</summary>
Creating a Sentry integration on Spike allows you to group and suppress incidents effectively, ensuring better incident management.
</details>

If you face any issues then please ping us from this page or email at [[email protected]](mailto:[email protected])
<details>
<summary>Is there a limit on Sentry integrations?</summary>
**Single-click install**: Only one integration is allowed per Sentry account.
**Sentry webhook integration**: Unlimited integrations are supported.
</details>
Loading