Skip to content

Commit 4ff9ce9

Browse files
forstisabellaforstisabella
committed
custom alerts to monitor tab
1 parent 91b5d05 commit 4ff9ce9

File tree

4 files changed

+95
-5
lines changed

4 files changed

+95
-5
lines changed

‎src/_data/sidenav/main.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -297,8 +297,6 @@ sections:
297297
title: Event Delivery
298298
- path: /connections/delivery-overview
299299
title: Delivery Overview
300-
- path: /connections/alerting
301-
title: Connections Alerting
302300
- path: /connections/find-writekey
303301
title: Locate Your Write Key
304302
- path: /connections/integration_error_codes
@@ -608,6 +606,8 @@ sections:
608606
title: Alerts Overview
609607
- path: /monitor/alerts/default-alerts
610608
title: Default Alerts
609+
- path: /monitor/alerts/custom-alerts
610+
title: Custom Alerts
611611
- section_title: Protocols
612612
section:
613613
- path: /protocols

‎src/connections/alerting.md

+3
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

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
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. During the public beta, only default alerts are located in the Monitor tab.
9+
10+
You can create alerts for the following product areas:
11+
- [Sources](#source-volume-alert)
12+
- [Destinations](#successful-delivery-rate-alert)
13+
- [Twilio Engage](#activation-event-health-spikes-or-drops)
14+
15+
## Source volume alert
16+
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 percentage you set. For example, if you set a change percentage 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.
17+
18+
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.
19+
20+
<img src="images/alerting-source-alert.png" alt="A screenshot of the Source Volume alert creation sidesheet." width="470px" height="540px">
21+
22+
To create a source volume alert:
23+
1. In your workspace, navigate to Connections, select Sources, and select the Event streams tab.
24+
2. Select the [event streams source](/docs/connections/sources/#event-streams-sources) you'd like to configure alerts for.
25+
2. Select the Alerts tab and click **Create alert**.
26+
3. On the Create alert sidesheet, enter a percentage of source volume change that you'd like to be notified for.
27+
4. Select one or more of the following alert channels:
28+
- **Email**: Select this to receive notifications at the provided email address.
29+
- **Slack**: Select this to send alerts to one or more channels in your workspace.
30+
- **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.
31+
5. Click **Save**.
32+
33+
To make changes to a source volume alert, select the icon in the Actions column for the alert and click **Edit**.
34+
35+
To delete a source volume alert, select the icon in the Actions column for the alert and click **Delete**.
36+
37+
> info "Deleting alerts created by other users requires Workspace Owner permissions"
38+
> All users can delete source volume alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
39+
40+
## Successful delivery rate alert
41+
42+
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.
43+
44+
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.
45+
46+
To create a successful delivery rate alert:
47+
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.
48+
2. Select the Alerts tab and click **Create alert**.
49+
3. On the Create alert sidesheet, enter a percentage. You will receive events if your successful delivery rate falls below this percentage.
50+
4. Select one of the following alert channels:
51+
- **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.
52+
- **Slack**: Select this and enter a Slack webhook URL and channel name to send alerts to a channel in your Slack workspace.
53+
- **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.
54+
5. Click **Save**.
55+
56+
To make changes to a successful delivery rate alert, select the icon in the Actions column for the alert and click **Edit**.
57+
58+
To delete a successful delivery rate alert, select the icon in the Actions column for the alert and click **Delete**.
59+
60+
## Activation event health spikes or drops
61+
62+
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 change percentage 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.
63+
64+
To create an Activation event health spikes or drops alert:
65+
1. From your Segment workspace's home page, navigate to **Engage > Audiences**.
66+
2. Select the Audience you want to create an alert for, select the Alerts tab, and click **Create alert**.
67+
3. On the Create alert sidesheet, select the destination for which you'd like to monitor event health.
68+
4. Enter a percentage threshold to trigger activation event health notifications.
69+
5. Select one or more of the following alert channels:
70+
- **Email**: Select this to receive notifications at the provided email address.
71+
- **Slack**: Select this to send alerts to one or more channels in your workspace.
72+
- **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.
73+
6. Click **Save**.
74+
75+
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**.
76+
77+
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

+13-3
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>

0 commit comments

Comments
 (0)