Skip to content

Commit b72e7a2

Browse files
Merge pull request #7078 from segmentio/retl-alerting
RETL model-level and mapping-level alerting
2 parents 7dc8500 + 46bdcce commit b72e7a2

File tree

2 files changed

+44
-2
lines changed

2 files changed

+44
-2
lines changed
174 KB
Loading

src/connections/reverse-etl/manage-retl.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,12 @@ To reset a sync:
5656
You can choose to replay syncs. To replay a specific sync, contact [[email protected]](mailto:[email protected]). Keep in mind that triggering a replay resyncs all records for a given sync.
5757

5858
## Alerting
59-
You can opt in to receive email, Slack, and in-app alerts about Reverse ETL sync failures and partial successes.
59+
You can opt in to receive email, Slack, and in-app alerts about Reverse ETL sync failures and fluctuations in the volume of events successfully delivered to your mapping.
6060

61-
To subscribe to alerts:
61+
The notification channels that you select for one alert will apply to all alerts in your workspace.
62+
63+
### Failed or partially successful syncs
64+
To subscribe to alerts for a failed or partially successful sync:
6265
1. Navigate to **Settings > User Preferences**.
6366
2. Select **Reverse ETL** in the **Activity Notifications** section.
6467
3. Click the Reverse ETL sync status that you'd like to receive notifications for. You can select one or more of the following sync statuses:
@@ -72,3 +75,42 @@ To subscribe to alerts:
7275

7376
> success ""
7477
> If you opted to receive notifications by email, you can click **View active email addresses** to see the email addresses that are currently signed up to receive notifications.
78+
79+
<!--- IG 9/2024 - not yet working
80+
### Model-level volume spike alerts
81+
82+
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 set percentage. 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.
83+
84+
To receive a volume spike 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.
85+
86+
1. Navigate to the model you'd like to create an alert for and select the **Alerts** tab.
87+
2. Click **Create alert**.
88+
3. Set a *change in event volume* percentage, or the percentage of change in event volume from your source that would prompt an alert.
89+
4. Select one or more of the following notification channels:
90+
- **Email**: Enter an email address or alias that should receive alerts.
91+
- **Slack notification**: Enter a Webhook URL and a Slack channel name to receive alerts in a Slack channel.
92+
- **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.
93+
5. Toggle the **Enable alert** setting on and click **Create**.
94+
95+
To edit or disable your alert, navigate to your model's Alerts tab and select the Actions menu for the model you'd like to edit.
96+
--->
97+
98+
### Mapping-level successful delivery rate fluctuations
99+
100+
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 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.
101+
102+
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.
103+
104+
![A screenshot of the Alerts tab for a Mapping, with the new mapping sidesheet partially filled out.](images/mapping-alerting.jpeg)
105+
106+
To subscribe to alerts for successful delivery fluctuations at the mapping level:
107+
1. Navigate to your intended mapping and select the **Alerts** tab.
108+
2. Click **Create alert**.
109+
3. Set an *alert threshold*, or the percentage of successfully delivered events that would prompt an alert.
110+
4. Select one or more of the following notification channels:
111+
- **Email**: Enter an email address or alias that should receive alerts.
112+
- **Slack notification**: Enter a Webhook URL and a Slack channel name to receive alerts in a Slack channel.
113+
- **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.
114+
5. Toggle the **Enable alert** setting on and click **Create**.
115+
116+
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.

0 commit comments

Comments
 (0)