Merge pull request #6198 from segmentio/DOC-808

forstisabella · web-flow · commit e5ac8426b13a · 2024-04-09T16:31:30.000-04:00
Connections Alerting GA [DOC-809]
diff --git a/src/_data/sidenav/main.yml b/src/_data/sidenav/main.yml
@@ -276,6 +276,8 @@ sections:
     title: Event Delivery
   - path: /connections/delivery-overview
     title: Delivery Overview
+  - path: /connections/alerting
+    title: Connections Alerting
   - path: /connections/find-writekey
     title: Locate Your Write Key
   - path: /connections/integration_error_codes
diff --git a/src/connections/alerting.md b/src/connections/alerting.md
@@ -0,0 +1,54 @@
+---
+title: Connections Alerting
+beta: true
+---
+
+Connections Alerting allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection. 
+
+
+To access Connections Alerting, select an event-streaming connection (like a web library source or cloud mode destination) and click the **Alerts** tab. 
+
+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 create.
+
+## Source volume 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 percentage you set. For example, if you set a change percentage of 4%, Segment notifies you when your source ingests less than 96% or more than 104% of the typical event volume. 
+
+To receive a source volume 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.
+
+<img src="images/alerting-source-alert.png" alt="A screenshot of the Source Volume alert creation sidesheet." width="470px" height="540px">
+
+To create a source volume alert: 
+1. In your workspace, navigate to Connections, select Sources, and select the Event streams tab. 
+2. Select the [event streams source](/docs/connections/sources/#event-streams-sources) you'd like to configure alerts for. 
+2. Select the Alerts tab and click **Create alert**. 
+3. On the Create alert sidesheet, enter a percentage of source volume change that you'd like to be notified for. 
+4. Select one or more of the following alert channels:
+  - **Email**: Select this to receive notifications at the provided email address. 
+  - **Slack**: Select this to send alerts to one or more channels in your workspace. 
+  - **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**.
+
+To make changes to a source volume alert that you created, select the icon in the Actions column for the alert and click **Edit**. 
+
+To delete a source volume alert that you created, select the icon in the Actions column for the alert and click **Delete**. 
+
+## Successful delivery rate alerts
+
+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%, Segment notifies you if your destination had a successful delivery rate of 98% or below. 
+
+To receive a successful delivery rate 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.
+
+To create a successful delivery rate alert: 
+1. Navigate to the [cloud-mode destinations](/docs/connections/destinations/#:~:text=Cloud%2Dmode%3A%20The%20sources%20send%20data%20directly%20to%20the%20Segment%20servers%2C%20which%20then%20translate%20it%20for%20each%20connected%20downstream%20destination%2C%20and%20send%20it%20on.) you'd like to configure alerts for. 
+2. Select the Alerts tab and click **Create alert**. 
+3. On the Create alert sidesheet, enter a percentage. You will receive events if your successful delivery rate falls below this percentage. 
+4. Select one of the following alert channels:
+  - **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. 
+  - **Slack**: Select this and enter a Slack webhook URL and channel name to send alerts to a channel in your Slack workspace.
+  - **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**.
+
+To make changes to a successful delivery rate alert that you created, select the icon in the Actions column for the alert and click **Edit**. 
+
+To delete a successful delivery rate alert that you created, select the icon in the Actions column for the alert and click **Delete**. 
diff --git a/src/connections/delivery-overview.md b/src/connections/delivery-overview.md
@@ -81,18 +81,23 @@ To use Delivery Overview:
 2. On the **Delivery Overview** tab, select a time period from the time picker. The time picker reflects data in the user's local time. <br/> ___Optional___: *Turn the metric toggle off if you'd like to see the quantity of events as counts instead of percentages. Delivery Overview shows percentages by default.*
 3. Select a success or discard step to view additional context about the events that passed through that step.
 
-## How does Delivery Overview differ from other Segment monitoring and observability products?
+## How does Delivery Overview differ from other Segment monitoring and observability tools?
 With Source Debugger or Event Delivery, you can only verify that events are successfully making it from your source or to your destination. If events fail, you have to troubleshoot to see where in the pipeline your events are getting stuck. With Event Tester, you can verify that your event makes it from your source to your destination, but if the results aren't what you expected, you're stuck troubleshooting your source, filters, tracking plans, and destinations. 
 
 With Delivery Overview, you can verify that your source receives your events, that any filters and tracking plans work as expected, and that events successfully make it to your destination. Any errors or unexpected behavior can be identified using the pipeline view, leading to quicker resolution. 
 
 ## How can I configure alerts?
-During the Delivery Overview beta, you can use the Event Delivery alerting features (Delivery Alerts) by selecting the **Alerts** tab in the destination header. 
 
-After you enable alerts, if the successful delivery rate of all events is less than the threshold percentage in the last 24 hours, you'll be notified through in-app notification and/or workspace email. 
+You can use the Event Delivery alerting features (Delivery Alerts) by selecting the **Alerts** tab in the destination header. Once you enable alerts, if the successful delivery rate of all events is less than the threshold percentage in the last 24 hours, you'll be notified through in-app notification and/or workspace email. 
 
 Note that this is dependent on your [notification settings](/docs/segment-app/#segment-settings). For example, if the threshold is set to 99%, then you'll be notified each time less than 100% of events fail. 
 
+You can also use Connections Alerting: a feature that allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection.
+
+Connections Alerting allows you to create two different alerts:
+- **Source volume alerts**: These alerts notify you if your source ingests an abnormally small or large amount of data. 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.
+- **Successful delivery rate alerts**: These alerts notify you if your destination's successful delivery rate falls outside of a percentage that you set. For example, if you set a percentage of 99%, you would be notified if you destination had a successful delivery rate of 98% or below.
+
 
 ## Why is the Delivery Overview page only available for cloud-mode destinations? 
 Similar to Segment's [Event Delivery](/docs/connections/event-delivery/) feature, the Delivery Overview page is only available for server-side integrations (also known as cloud-mode destinations). You won't be able to use the Delivery Overview page for client side integrations (also known as device-mode destinations) because device-mode data is sent directly to the destination tool's API. In order to report on deliverability, data must be sent to destinations using a server-side connection. 
diff --git a/src/connections/images/alerting-source-alert.png b/src/connections/images/alerting-source-alert.png
diff --git a/src/guides/how-to-guides/set-up-notifications-alerts.md b/src/guides/how-to-guides/set-up-notifications-alerts.md
@@ -4,20 +4,33 @@ title: How do we set up event-triggered notifications or alerts?
 
 Below you'll find a bunch of ways to set up notifications for yourself based on the data you're sending through Segment. 
 
-### Google Analytics custom alerts
+## Connections Alerting
+
+Connections Alerting allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection.
+
+> info "Connections Alerting is in beta"
+> 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).
+
+Connections Alerting allows you to create two different alerts:
+- **Source volume alerts**: These alerts notify you if your source ingests an abnormally small or large amount of data. 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.
+- **Successful delivery rate alerts**: These alerts notify you if your destination's successful delivery rate falls outside of a percentage that you set. For example, if you set a percentage of 99%, you would be notified if you destination had a successful delivery rate of 98% or below.
+
+For more information about Connections Alerting, see the [Connections Alerting](/docs/connections/alerting) documentation. 
+
+## Google Analytics custom alerts
 
 You can use Google Analytics Custom Alerts to send yourself emails whenever a specific traffic segment drops below (or above) a threshold you set. 
 
-[Learn how to set up email alerts here](https://support.google.com/analytics/answer/1033021?hl=en){:target="_blank"}.
+Learn how to set up email alerts in [Google's documentation](https://support.google.com/analytics/answer/1033021?hl=en){:target="_blank"}.
 
-### Analytics email summaries
+## Analytics email summaries
 
 With tools like Amplitude, Kissmetrics, and Mixpanel, you can set up email reports delivered to you on a daily basis. They are completely customizable, so you can keep an eye on as many events or other metrics you'd like. 
 
-*   [Mixpanel email reports](https://mixpanel.com/blog/2011/04/14/email-reports/)
-*   [Amplitude email alerts (scroll down a bit)](https://amplitude.com/blog/2015/03/20/new-features-stickiness-team-access-controls-email-alerts-redshift-playbook/)
+*   [Mixpanel email reports](https://mixpanel.com/blog/2011/04/14/email-reports/){:target="_blank"}
+*   [Amplitude email alerts](https://amplitude.com/blog/2015/03/20/new-features-stickiness-team-access-controls-email-alerts-redshift-playbook/){:target="_blank"}
 
-### Realtime traffic monitoring
+## Realtime traffic monitoring
 
 Chartbeat and GoSquared both offer awesome real-time dashboards to see what's happening right now on your site. They both include the option to get notified when your traffic hits a certain threshold. For example, if your on-site visitors is less than 100 people, or more than 1,000.
 
@@ -27,10 +40,10 @@ Chartbeat and GoSquared both offer awesome real-time dashboards to see what's h
 > info ""
 > GoSquared also offers in-depth historical and user analysis. Chartbeat sticks to realtime anonymous traffic, but offers some sweet features for publishers.
 
-### Webhook-based alerts
+## Webhook-based alerts
 
-The last option Segment recommends is to use a monitoring tool like [PagerDuty](https://www.pagerduty.com/){:target="_blank"} or [Data Dog](https://www.datadoghq.com/){:target="_blank"} and point Segment's [webhooks](/docs/connections/destinations/catalog/webhooks/) destination at them. That way you can set up custom alerts in their system.
+The last option Segment recommends is to use a monitoring tool like [PagerDuty](https://www.pagerduty.com/){:target="_blank"} or [Datadog](https://www.datadoghq.com/){:target="_blank"} and point Segment's [webhooks](/docs/connections/destinations/catalog/webhooks/) destination at them. That way you can set up custom alerts in their system.
 
-### Event-triggered emails
+## Event-triggered emails
 
 The last option for alerting based off of Segment events is to use one of the email tools available on the Segment platform that offers event-triggered emails. Your options there are Customer.io, Vero, Autopilot, Outbound, Klaviyo, or Threads.
