Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RETL model-level and mapping-level alerting #7078

Merged
merged 5 commits into from
Sep 30, 2024
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 40 additions & 2 deletions src/connections/reverse-etl/manage-retl.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,12 @@ To reset a sync:
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.

## Alerting
You can opt in to receive email, Slack, and in-app alerts about Reverse ETL sync failures and partial successes.
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.

To subscribe to alerts:
The notification channels that you select for one alert will apply to all alerts in your workspace.

### Failed or partially successful syncs
To subscribe to alerts for a failed or partially successful sync:
1. Navigate to **Settings > User Preferences**.
2. Select **Reverse ETL** in the **Activity Notifications** section.
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:
Expand All @@ -69,3 +72,38 @@ To subscribe to alerts:

> success ""
> 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.

### Model-level volume spike alerts

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.

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.

1. Navigate to the model you'd like to create an alert for and select the **Alerts** tab.
2. Click **Create alert**.
3. Set a *change in event volume* percentage, or the percentage of change in event volume from your source that would prompt an alert.
4. Select one or more of the following notification channels:
- **Email**: Select this channel to receive emailed alerts at the email address that you use to sign in to Segment.
- **Slack notification**: Enter a Webhook URL and a Slack channel name to receive alerts in a Slack channel.
- **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.
5. Toggle the **Enable alert** setting on and click **Create**.

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.

### Mapping-level successful delivery rate fluctuations

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.

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.

To subscribe to alerts for successful delivery fluctuations at the mapping level:
1. Navigate to your intended mapping and select the **Alerts** tab.
2. Click **Create alert**.
3. Set an *alert threshold*, or the percentage of successfully delivered events that would prompt an alert.
4. Select one or more of the following notification channels:
- **Email**: Select this channel to receive emailed alerts at the email address that you use to sign in to Segment.
- **Slack notification**: Enter a Webhook URL and a Slack channel name to receive alerts in a Slack channel.
- **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.
5. Toggle the **Enable alert** setting on and click **Create**.

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.