Skip to content

Commit 7052c23

Browse files
committed
add procedures
1 parent ec82077 commit 7052c23

File tree

1 file changed

+41
-3
lines changed

1 file changed

+41
-3
lines changed

src/connections/alterting.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,49 @@ title: Connections Alerting
33
beta: true
44
---
55

6-
With Connections Alerting, Segment users can set up and receive in-app, email, and Slack notifications in response to automatic or user-defined triggers to monitor the performance and throughput of a event-streaming connection.
6+
Connections Alerting allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of a event-streaming connection.
77

88
> info "Connections Alerting is currently in beta"
9-
> This means that the Connections Alerting feature is in active development, and some functionality may change before it becomes generally available. During the public beta, Connections Alerting supports event-streaming connections: [event streaming sources](/docs/connections/sources/#event-streams-sources) and [cloud-mode destinations](/docs/connections/destinations/#event-streams-destinations).
9+
> This means that the Connections Alerting feature is in active development, and some functionality may change before it becomes generally available. During the beta, Connections Alerting supports event-streaming connections: [event streaming sources](/docs/connections/sources/#event-streams-sources) and [cloud-mode destinations](/docs/connections/destinations/#event-streams-destinations).
1010
1111
To access Connections Alerting, select an event-streaming connection (like a web library source or cloud mode destination) and click the **Alerts** tab.
1212

13-
On the Alerts tab, you can
13+
On the Alerts tab, you can create alerts and view all active alerts for this connection. You can only edit or delete the alerts that you've created.
14+
15+
## Source volume alerts
16+
17+
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%, you would be notified when your source ingests less than 96% or more than 104% of the typical event volume.
18+
19+
To receive a source volume alert in a Slack channel, you must create a Slack webhook first. For more information about Slack webhooks, see the [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation.
20+
21+
To create a source volume alert:
22+
1. Open your workspace and navigate to the [event streaming source](/docs/connections/sources/#event-streams-sources) you'd like to configure alerts for.
23+
2. Select the Alerts tab and click **Create alert**.
24+
3. On the Create alert sidesheet, enter a percentage of source volume change that you'd like to be notified for.
25+
4. Select one or more channels you'd like to receive alerts in.
26+
- **Email**: Select this to receive notifications at the provided email address.
27+
- **Slack**: Select this to send alerts to one or more channels in your workspace.
28+
- **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.
29+
5. Click **Save**.
30+
31+
To make changes to a source alert that you created, select the icon in the Actions column for the alert and click **Edit**.
32+
33+
## Successful delivery rate alerts
34+
35+
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%, you would be notified if you source had a successful delivery rate of 98% or below.
36+
37+
To receive a successful delivery rate alert in a Slack channel, you must create a Slack webhook first. For more information about Slack webhooks, see the [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation.
38+
39+
To create a successful delivery rate alert:
40+
1. Open your workspace and navigate to the [cloud-mode destinations](/docs/connections/destinations/#event-streams-destinations) you'd like to configure alerts for.
41+
2. Select the Alerts tab and click **Create alert**.
42+
3. On the Create alert sidesheet, enter a percentage. You will receive events if your successful delivery rate falls below this percentage.
43+
4. Select one or more channels you'd like to receive alerts in.
44+
- **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.
45+
- **Slack**: Select this and enter a Slack webhook URL and channel name to send alerts to a channel in your Slack workspace.
46+
- **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.
47+
5. Click **Save**.
48+
49+
To make changes to a source alert that you created, select the icon in the Actions column for the alert and click **Edit**.
50+
51+
To delete a successful delivery rate alert that you created, select the icon in the Actions column for the alert and click **Delete**.

0 commit comments

Comments
 (0)