You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/reverse-etl/manage-retl.md
+48-4Lines changed: 48 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,9 +53,17 @@ To reset a sync:
53
53
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.
54
54
55
55
## Alerting
56
-
You can opt in to receive email, Slack, and in-app alerts about Reverse ETL sync failuresand partial successes.
56
+
You can opt in to receive email, Slack, and in-app alerts about Reverse ETL sync failures, spikes in data ingested from your model, and fluctuations in the volume of events successfully delivered from your mapping.
57
57
58
-
To subscribe to alerts:
58
+
<!--- TODO: rewrite above + confrm w/ eric that the following is true--->
59
+
60
+
The notification channels that you select for one alert will apply to all alerts in your workspace.
61
+
62
+
> success ""
63
+
> 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.
64
+
65
+
### Failed or partially successful syncs
66
+
To subscribe to alerts for a failed or partially successful sync:
59
67
1. Navigate to **Settings > User Preferences**.
60
68
2. Select **Reverse ETL** in the **Activity Notifications** section.
61
69
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:
@@ -67,5 +75,41 @@ To subscribe to alerts:
67
75
-**Enable in-app notifications**: Select this option to see an in-app notification.
68
76
5. Click **Create alert**.
69
77
70
-
> success ""
71
-
> 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
+
### Model-level volume spike alerts
79
+
80
+
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.
81
+
82
+
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.
83
+
84
+
1. Navigate to the model you'd like to create an alert for and select the **Alerts** tab.
85
+
2. Click **Create alert**.
86
+
3. Set a *change in event volume* percentage, or the percentage of change in event volume from your source that would prompt an alert. <!--- TODO: add example (in this step or the section intro?)--->
87
+
4. Select one or more of the following notification channels:
88
+
-**Email**: Select this channel to receive emailed alerts at the email address that you use to sign in to Segment.
89
+
-**Slack notification**: Enter a Webhook URL and a Slack channel name to receive alerts in a Slack channel.
90
+
-**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.
91
+
5. Toggle the **Enable alert** setting on and click **Create**.
92
+
93
+
To edit or disable your alert, navigate to your model's Alerts tab and select the Actions menu.
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.
100
+
101
+
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.
102
+
103
+
To subscribe to alerts for successful delivery fluctuations at the mapping level:
104
+
1. Navigate to your intended mapping and select the **Alerts** tab.
105
+
2. Click **Create alert**.
106
+
3. Set an *alert threshold*, or the percentage of successfully delivered events that would prompt an alert.
107
+
4. Select one or more of the following notification channels:
108
+
-**Email**: Select this channel to receive emailed alerts at the email address that you use to sign in to Segment.
109
+
-**Slack notification**: Enter a Webhook URL and a Slack channel name to receive alerts in a Slack channel.
110
+
-**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.
111
+
5. Toggle the **Enable alert** setting on and click **Create**.
112
+
113
+
To edit or disable your alert, navigate to your mapping's Alerts tab and select the Actions menu.
0 commit comments