Skip to content

Commit 841b9da

Browse files
forstisabellaforstisabella
authored
Merge pull request #7536 from segmentio/custom-alerts
Add custom alerts to the monitor tab
2 parents ef063b6 + fc858ae commit 841b9da

File tree

5 files changed

+118
-5
lines changed

5 files changed

+118
-5
lines changed

‎src/_data/sidenav/main.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -316,8 +316,6 @@ sections:
316316
title: Event Delivery
317317
- path: /connections/delivery-overview
318318
title: Delivery Overview
319-
- path: /connections/alerting
320-
title: Connections Alerting
321319
- path: /connections/find-writekey
322320
title: Locate Your Write Key
323321
- path: /connections/integration_error_codes
@@ -635,6 +633,8 @@ sections:
635633
title: Alerts Overview
636634
- path: /monitor/alerts/default-alerts
637635
title: Default Alerts
636+
- path: /monitor/alerts/custom-alerts
637+
title: Custom Alerts
638638
- section_title: Protocols
639639
section:
640640
- path: /protocols

‎src/connections/alerting.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Connections Alerting
33
beta: true
4+
hidden: true
45
---
56

67
Connections Alerting allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection.
@@ -34,6 +35,8 @@ To delete a source volume alert, select the icon in the Actions column for the a
3435

3536
> info "Deleting alerts created by other users requires Workspace Owner permissions"
3637
> All users can delete source volume alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
38+
39+
3740
## Successful delivery rate alerts
3841

3942
You can create an alert that notifies you when the volume of events successfully received by your destination in the last 24 hours falls below a percentage you set. For example, if you set a percentage of 99%, Segment notifies you if your destination had a successful delivery rate of 98% or below.

‎src/monitor/alerts/custom-alerts.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
title: Custom Alerts
3+
---
4+
5+
Segment's custom alerts allow you to customize the sensitivity of the trigger that activates an alert so you can more accurately detect event volume fluctuations in your integrations.
6+
7+
> info "Public beta"
8+
> The Monitor hub is in Public Beta. Some functionality may change before it becomes generally available.
9+
10+
![A screenshot of the custom alerts tab for a Segment workspace depicting three different source volume alerts with different integrations and thresholds.](/docs/monitor/images/custom-alerting.png)
11+
12+
You can create alerts for the following product areas:
13+
- [Sources](#source-volume-alert)
14+
- [Destinations](#successful-delivery-rate-alert)
15+
- [Reverse ETL](#mapping-level-successful-delivery-rate-fluctuations)
16+
- [Twilio Engage](#activation-event-health-spikes-or-drops)
17+
18+
## Source volume alert
19+
You can create an alert that notifies you when the volume of events received by your source in the last 24 hours changes beyond a threshold you set. For example, if you set a threshold of 4% and your source received 100 events over the first 24 hours, Segment would notify you the following day if your source ingested fewer than 96 or more than 104 events.
20+
21+
To receive a source volume alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see the [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation.
22+
23+
<img src="/docs/connections/images/alerting-source-alert.png" alt="A screenshot of the Source Volume alert creation sidesheet." width="470px" height="540px">
24+
25+
To create a source volume alert:
26+
1. In your workspace, navigate to Connections, select Sources, and select the Event streams tab.
27+
2. Select the [event streams source](/docs/connections/sources/#event-streams-sources) you'd like to configure alerts for.
28+
2. Select the Alerts tab and click **Create alert**.
29+
3. On the Create alert sidesheet, enter a percentage of source volume change that you'd like to be notified for.
30+
4. Select one or more of the following alert channels:
31+
- **Email**: Select this to receive notifications at the provided email address.
32+
- **Slack**: Select this to send alerts to one or more channels in your workspace.
33+
- **In-app**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app.
34+
5. Click **Save**.
35+
36+
To make changes to a source volume alert, select the icon in the Actions column for the alert and click **Edit**.
37+
38+
To delete a source volume alert, select the icon in the Actions column for the alert and click **Delete**.
39+
40+
> info "Deleting alerts created by other users requires Workspace Owner permissions"
41+
> All users can delete source volume alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
42+
43+
## Successful delivery rate alert
44+
45+
You can create an alert that notifies you when the volume of events successfully received by your destination in the last 24 hours falls below a threshold you set. For example, if you set a threshold of 99%, Segment notifies you if your destination had a successful delivery rate of 98% or below.
46+
47+
To receive a successful delivery rate alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see the [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation.
48+
49+
To create a successful delivery rate alert:
50+
1. Navigate to the [cloud-mode destinations](/docs/connections/destinations/#:~:text=Cloud%2Dmode%3A%20The%20sources%20send%20data%20directly%20to%20the%20Segment%20servers%2C%20which%20then%20translate%20it%20for%20each%20connected%20downstream%20destination%2C%20and%20send%20it%20on.) you'd like to configure alerts for.
51+
2. Select the Alerts tab and click **Create alert**.
52+
3. On the Create alert sidesheet, enter a percentage. You will receive events if your successful delivery rate falls below this threshold.
53+
4. Select one of the following alert channels:
54+
- **Email**: Select this to receive notifications at either the email address associated with your account or another email address that you enter into this field.
55+
- **Slack**: Select this and enter a Slack webhook URL and channel name to send alerts to a channel in your Slack workspace.
56+
- **In-app**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app.
57+
5. Click **Save**.
58+
59+
To make changes to a successful delivery rate alert, select the icon in the Actions column for the alert and click **Edit**.
60+
61+
To delete a successful delivery rate alert, select the icon in the Actions column for the alert and click **Delete**.
62+
63+
## Mapping-level successful delivery rate fluctuations
64+
65+
You can create an alert that notifies you when the volume of events successfully received by your mapping in the last 24 hours falls below a threshold you set. For example, if you set a threshold of 99%, Segment notifies you if your destination had a successful delivery rate of 98% or below.
66+
67+
To receive a successful delivery rate fluctuation alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see Slack's [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation.
68+
69+
![A screenshot of the Alerts tab for a Mapping, with the new mapping sidesheet partially filled out.](/docs/connections/reverse-etl/images/mapping-alerting.jpeg)
70+
71+
To subscribe to alerts for successful delivery fluctuations at the mapping level:
72+
1. Navigate to your intended mapping and select the **Alerts** tab.
73+
2. Click **Create alert**.
74+
3. Set an *alert threshold*, or the percentage of successfully delivered events that would prompt an alert.
75+
4. Select one or more of the following notification channels:
76+
- **Email**: Enter an email address or alias that should receive alerts.
77+
- **Slack notification**: Enter a Webhook URL and a Slack channel name to receive alerts in a Slack channel.
78+
- **In-app notifications**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app.
79+
5. Toggle the **Enable alert** setting on and click **Create**.
80+
81+
To edit or disable your alert, navigate to your mapping's Alerts tab and select the Actions menu for the alert you'd like to edit.
82+
83+
## Activation event health spikes or drops
84+
85+
You can create an Activation event health spikes or drops alert that notifies you when events sent from your audience to a downstream destination have failures to a destination above a certain threshold. For example, if you set a threshold of 4% and your destination received 100 events from your Audience over the first 24 hours, Segment would notify you the following day if your destination ingested fewer than 96 or more than 104 events.
86+
87+
To create an Activation event health spikes or drops alert:
88+
1. From your Segment workspace's home page, navigate to **Engage > Audiences**.
89+
2. Select the Audience you want to create an alert for, select the Alerts tab, and click **Create alert**.
90+
3. On the Create alert sidesheet, select the destination for which you'd like to monitor event health.
91+
4. Enter a percentage threshold to trigger activation event health notifications.
92+
5. Select one or more of the following alert channels:
93+
- **Email**: Select this to receive notifications at the provided email address.
94+
- **Slack**: Select this to send alerts to one or more channels in your workspace.
95+
- **In-app**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app.
96+
6. Click **Save**.
97+
98+
To make changes to an Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Edit**.
99+
100+
To delete a Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Delete**.

‎src/monitor/alerts/index.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,20 @@ Segment has two kinds of alerts:
1010
- **Default alerts**: Alerts that have a preset threshold and are often used to detect changes users make to the integrations in your workspace. For example, a _Source created_ alert is a default alert.
1111
- **Custom alerts**: Alerts that allow you to customize the sensitivity of the trigger that activates an alert so you can more accurately detect event volume fluctuations in your sources and destinations. For example, a _Source volume fluctuation_ alert would be a custom alert, as you could select a percentage of fluctuation that would work for your business needs.
1212

13+
14+
<div class="double">
1315
{% include components/reference-button.html
1416
href="/monitor/alerts/default-alerts"
1517
variant="related"
16-
icon="monitor.svg"
18+
icon="segment-app.svg"
1719
title="Default alerts"
18-
description="Learn more about Segment's default alerts."
19-
%}
20+
description="Default alerts are often used to detect changes users made in your workspace."
21+
%}
22+
23+
{% include components/reference-button.html
24+
href="/monitor/alerts/custom-alerts"
25+
icon="book.svg"
26+
title="Custom alerts"
27+
description="Custom alerts allow you detect fluctuations in event volumes."
28+
%}
29+
</div>

‎src/monitor/images/custom-alerting.png

116 KB
Loading

0 commit comments

Comments
 (0)