diff --git a/src/monitor/alerts/custom-alerts.md b/src/monitor/alerts/custom-alerts.md index f63d4f72ad..bbc92d39d1 100644 --- a/src/monitor/alerts/custom-alerts.md +++ b/src/monitor/alerts/custom-alerts.md @@ -22,12 +22,31 @@ The Alerting table includes the following information about each alert: - **Notification channels**: Icons describing what notification channels you'll receive the alerts on - through a Slack webhook, Slack workflow, email, or in-app notification. - **Actions**: By selecting the menu icon for an individual alert, you can edit or delete it from the Alerting page. Only users with the Workspace Owner role can delete alerts created by other users. -> info "Slack and mailing list notification channels require additional setup" -> Before sending an alert to Slack, 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. -> -> While you can only enter one email address per alert when signing up for email alerts, you can send the alert to multiple users by entering the email address of a mailing list. To create a mailing list, refer to the documentation for your email provider, like Google's [Create a group & choose group settings](https://support.google.com/groups/answer/2464926?hl=en){:target="_blank”} for Gmail or Microsoft's [Create and manage distribution groups](https://support.microsoft.com/en-us/office/distribution-groups-e8ba58a8-fab2-4aaf-8aa1-2a304052d2de#bkmk_create){:target="_blank”} for Outlook. +## Alert prerequisites -## Source volume alert +First, create webhooks or notification services in the tools you use as notification channels, then return to the Segment app to set up your alert. + +### Set up your notification tools + +The following tools require prerequisite setup before you can use them as notification channels: + +- **Slack**: You must create a Slack webhook before setting up an alert in the Segment app. For more information, see Slack's [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation. +- **Email (optional)**: While you can only enter one email address at a time when signing up for email alerts, you can send the alert to multiple users by entering the email address of a mailing list. To create a mailing list, refer to the documentation for your email provider, like Google's [Create a group & choose group settings](https://support.google.com/groups/answer/2464926?hl=en){:target="_blank”} for Gmail or Microsoft's [Create and manage distribution groups](https://support.microsoft.com/en-us/office/distribution-groups-e8ba58a8-fab2-4aaf-8aa1-2a304052d2de#bkmk_create){:target="_blank”} for Outlook. +- **PagerDuty**: You must create an integration key in PagerDuty before setting up an alert in the Segment app. + +To create a PagerDuty integration key: + +1. Open PagerDuty and navigate to **Services > Service Directory**. +2. Select the service that you'd like to send incidents to. +3. Under Integrations, select **Add Integration**. +4. Select **Events API v2**. +5. PagerDuty displays a 32-character integration key. + +## Create alerts + +Once you've set up your notification services, return to the Segment app to create an alert. + +### Source volume alert 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 threshold you set. For example, if you set a threshold 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. A screenshot of the Source Volume alert creation sidesheet. @@ -43,7 +62,7 @@ To create a source volume alert: - **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. 5. Click **Save**. -## Successful delivery rate alert +### Successful delivery rate alert 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 threshold you set. For example, if you set a threshold of 99%, Segment notifies you if your destination had a successful delivery rate of 98% or below. @@ -58,7 +77,7 @@ To create a successful delivery rate alert: 5. Click **Save**. -## Mapping-level successful delivery rate fluctuations +### 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 threshold you set. For example, if you set a threshold of 99%, Segment notifies you if your destination had a successful delivery rate of 98% or below. @@ -74,7 +93,7 @@ To subscribe to alerts for successful delivery fluctuations at the mapping level - **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**. -## Activation event health spikes or drops +### Activation event health spikes or drops 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 threshold 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. @@ -89,7 +108,7 @@ To create an Activation event health spikes or drops alert: - **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. 6. Click **Save**. -## Audience size change +### Audience size change You can create an Audience size change alert that notifies you when your audience increases or decreases by a certain threshold. For example, if you set a change percentage of 4% and your destination had 100 members over the first 24 hours, Segment would notify you the following day if your audience had fewer than 96 or more than 104 members. To create an Audience size change alert: diff --git a/src/monitor/alerts/default-alerts.md b/src/monitor/alerts/default-alerts.md index b72c236981..4cdd17a20a 100644 --- a/src/monitor/alerts/default-alerts.md +++ b/src/monitor/alerts/default-alerts.md @@ -25,21 +25,38 @@ The Alerting table includes the following information about each event: - **Alert name**: The type of alert; for example, "Audience created" or "Audience deleted". - **Last triggered**: The most recent date and time, in your local time zone, that the alert was triggered. Some alerts, like **Violations Detected**, trigger only once per day. - **Status**: Either **enabled**, if the alert is currently configured in your workspace, or **disabled**, if you're not configured to receive alerts for an event. -- **Notification channels**: Icons describing what notification channels you'll receive the alerts on - through a Slack webhook, Slack workflow, email, or in-app notification. +- **Notification channels**: Icons describing what notification channels you'll receive the alerts on - through a Slack webhook, Slack workflow, PagerDuty notification, email, or in-app notification. - **Actions**: By selecting the menu icon for an individual alert, you can edit or delete it from the Alerting page. -## Create a new alert +## Create alerts + +First, create webhooks or notification services in the tools you use as notification channels, then return to the Segment app to set up your alert. + +### Set up your notification tools + +The following tools require prerequisite setup before you can use them as notification channels: + +- **Slack**: You must create a Slack webhook before setting up an alert in the Segment app. For more information, see Slack's [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation. +- **Email (optional)**: While you can only enter one email address at a time when signing up for email alerts, you can send the alert to multiple users by entering the email address of a mailing list. To create a mailing list, refer to the documentation for your email provider, like Google's [Create a group & choose group settings](https://support.google.com/groups/answer/2464926?hl=en){:target="_blank”} for Gmail or Microsoft's [Create and manage distribution groups](https://support.microsoft.com/en-us/office/distribution-groups-e8ba58a8-fab2-4aaf-8aa1-2a304052d2de#bkmk_create){:target="_blank”} for Outlook. +- **PagerDuty**: You must create an integration key in PagerDuty before setting up an alert in the Segment app. + +To create a PagerDuty integration key: + +1. Open PagerDuty and navigate to **Services > Service Directory**. +2. Select the service that you'd like to send incidents to. +3. Under Integrations, select **Add Integration**. +4. Select **Events API v2**. +5. PagerDuty displays a 32-character integration key. + +### Create an alert in the Segment app + +Once you've set up any required notification services, like Slack webhooks, mailing lists, or PagerDuty services, use the Segment app to create your notification. To create a new alert: 1. From the Segment app, navigate to the **Monitor** tab and select **Alerts**. 2. On the **Default** tab, identify the event you'd like to be alerted for and select the menu icon under the **Actions** tab. 3. Click **Enable alert**. -> info "Slack and mailing list notification channels require additional setup" -> Before sending an alert to Slack, 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. -> -> While you can only enter one email address at a time when signing up for email alerts, you can send the alert to multiple users by entering the email address of a mailing list. To create a mailing list, refer to the documentation for your email provider, like Google's [Create a group & choose group settings](https://support.google.com/groups/answer/2464926?hl=en){:target="_blank”} for Gmail or Microsoft's [Create and manage distribution groups](https://support.microsoft.com/en-us/office/distribution-groups-e8ba58a8-fab2-4aaf-8aa1-2a304052d2de#bkmk_create){:target="_blank”} for Outlook. - ## Alert descriptions View a brief description of each alert type.