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
Connections Alerting allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection.
7
+
8
+
9
+
To access Connections Alerting, select an event-streaming connection (like a web library source or cloud mode destination) and click the **Alerts** tab.
10
+
11
+
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.
12
+
13
+
## Source volume alerts
14
+
15
+
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 if your source ingests less than 96% or more than 104% of the event volume over the previous 24 hour period.
16
+
17
+
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.
18
+
19
+
<imgsrc="images/alerting-source-alert.png"alt="A screenshot of the Source Volume alert creation sidesheet."width="470px"height="540px">
20
+
21
+
To create a source volume alert:
22
+
1. In your workspace, navigate to Connections, select Sources, and select the Event streams tab.
23
+
2. Select the [event streams source](/docs/connections/sources/#event-streams-sources) you'd like to configure alerts for.
24
+
2. Select the Alerts tab and click **Create alert**.
25
+
3. On the Create alert sidesheet, enter a percentage of source volume change that you'd like to be notified for.
26
+
4. Select one or more of the following alert channels:
27
+
-**Email**: Select this to receive notifications at the provided email address.
28
+
-**Slack**: Select this to send alerts to one or more channels in your workspace.
29
+
-**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.
30
+
5. Click **Save**.
31
+
32
+
To make changes to a source volume alert that you created, select the icon in the Actions column for the alert and click **Edit**.
33
+
34
+
To delete a source volume alert that you created, select the icon in the Actions column for the alert and click **Delete**.
35
+
36
+
## Successful delivery rate alerts
37
+
38
+
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.
39
+
40
+
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.
41
+
42
+
To create a successful delivery rate alert:
43
+
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.
44
+
2. Select the Alerts tab and click **Create alert**.
45
+
3. On the Create alert sidesheet, enter a percentage. You will receive events if your successful delivery rate falls below this percentage.
46
+
4. Select one of the following alert channels:
47
+
-**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.
48
+
-**Slack**: Select this and enter a Slack webhook URL and channel name to send alerts to a channel in your Slack workspace.
49
+
-**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.
50
+
5. Click **Save**.
51
+
52
+
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**.
53
+
54
+
To delete a successful delivery rate alert that you created, select the icon in the Actions column for the alert and click **Delete**.
Copy file name to clipboardExpand all lines: src/connections/delivery-overview.md
+15-6Lines changed: 15 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,11 @@ title: Delivery Overview
4
4
5
5
Delivery Overview is a visual observability tool designed to help Segment users diagnose event delivery issues for any cloud-streaming destination receiving events from cloud-streaming sources.
6
6
7
-
> info "Delivery Overview is currently in beta"
8
-
> This means that the Delivery Overview feature is in active development, and some functionality may change before it becomes generally available. Beta users of Delivery Overview will still have access to the Event Delivery tab. During the public beta, Delivery Overview supports event-streaming, cloud-mode destinations.
7
+
> info "Delivery Overview for RETL destinations, Storage destinations, and Engage Audience Syncs currently in development"
8
+
> This means that Segment is actively developing Delivery Overview features for RETL destinations, Storage destinations, and Engage Audience syncs. Some functionality may change before Delivery Overview for these integrations becomes generally available.
9
+
>
10
+
> Delivery Overview is generally available for streaming connections (cloud-streaming sources and cloud-streaming destinations).
11
+
> All users of Delivery Overview have access to the Event Delivery tab, and can configure delivery alerts for their destinations.
9
12
10
13
## Key features
11
14
@@ -24,7 +27,7 @@ The pipeline view shows the following steps:
24
27
-**Successfully received**: Events that Segment ingested from your source
25
28
-**Failed on ingest**: Events that Segment received, but were dropped due to internal data validation rules
26
29
-**Filtered at source**: Events that were discarded due to schema settings or [Protocols](/docs/protocols/) Tracking Plans
27
-
-**Filtered at destination**: Events that were discarded due to [Destination Filters](/docs/guides/filtering-data/#destination-filters), [filtering in the Integrations object](/docs/guides/filtering-data/#filtering-with-the-integrations-object), or [per source schema integration filters](/docs/guides/filtering-data/#per-source-schema-integrations-filters). [Actions destinations](/docs/connections/destinations/actions/) also have a filtering capability: for example, if your Action is set to only send Identify events, all other event types will be filtered out. Actions destinations with incomplete triggers or disabled mappings are filtered out at this step. [Consent Management](/docs/privacy/consent-management/) users also see events discarded due to consent preferences.
30
+
-**Filtered at destination**: Events that were discarded due to [Destination Filters](/docs/guides/filtering-data/#destination-filters), [filtering in the Integrations object](/docs/guides/filtering-data/#filtering-with-the-integrations-object), [Destination Insert functions](/docs/connections/functions/insert-functions/), or [per source schema integration filters](/docs/guides/filtering-data/#per-source-schema-integrations-filters). [Actions destinations](/docs/connections/destinations/actions/) also have a filtering capability: for example, if your Action is set to only send Identify events, all other event types will be filtered out. Actions destinations with incomplete triggers or disabled mappings are filtered out at this step. [Consent Management](/docs/privacy/consent-management/) users also see events discarded due to consent preferences.
28
31
-**Failed delivery**: Events that have been discarded due to errors or unmet destination requirements
29
32
-**Successful delivery**: Events that were successfully delivered to the destination
30
33
@@ -52,6 +55,7 @@ The discard table provides you with greater detail about the events that failed
52
55
To open the discard table, click on one of the discard steps. If you click on a row in the discard table, you can see the breakdown table for the discarded events.
53
56
54
57
The discard table displays the following details:
58
+
55
59
-**Discard reason**: Any relevant error code, message, or description associated with the event's failure. When possible, Delivery Overview links to any troubleshooting information you can use to get your events up and running again. Clicking on a discard reason brings you to the [breakdown table](#breakdown-table,) where you can see more detail about discarded events. For more context about discard reasons, see the [Troubleshooting](#troubleshooting) documentation.
56
60
-**Details & Samples**: View up to ten samples over the selected time range. Examine the error message and reason for the error or discard and inspect the payloads involved with the attempted transaction (*not available for inspection at all steps*)
57
61
-**Event count**: How many of each event were discarded in this pipeline step
@@ -81,18 +85,23 @@ To use Delivery Overview:
81
85
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.*
82
86
3. Select a success or discard step to view additional context about the events that passed through that step.
83
87
84
-
## How does Delivery Overview differ from other Segment monitoring and observability products?
88
+
## How does Delivery Overview differ from other Segment monitoring and observability tools?
85
89
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.
86
90
87
91
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.
88
92
89
93
## How can I configure alerts?
90
-
During the Delivery Overview beta, you can use the Event Delivery alerting features (Delivery Alerts) by selecting the **Alerts** tab in the destination header.
91
94
92
-
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.
95
+
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.
93
96
94
97
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.
95
98
99
+
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.
100
+
101
+
Connections Alerting allows you to create two different alerts:
102
+
-**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.
103
+
-**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.
104
+
96
105
97
106
## Why is the Delivery Overview page only available for cloud-mode destinations?
98
107
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.
Copy file name to clipboardExpand all lines: src/guides/how-to-guides/set-up-notifications-alerts.md
+22-9Lines changed: 22 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -4,20 +4,33 @@ title: How do we set up event-triggered notifications or alerts?
4
4
5
5
Below you'll find a bunch of ways to set up notifications for yourself based on the data you're sending through Segment.
6
6
7
-
### Google Analytics custom alerts
7
+
## Connections Alerting
8
+
9
+
Connections Alerting allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection.
10
+
11
+
> info "Connections Alerting is in beta"
12
+
> 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).
13
+
14
+
Connections Alerting allows you to create two different alerts:
15
+
-**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.
16
+
-**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.
17
+
18
+
For more information about Connections Alerting, see the [Connections Alerting](/docs/connections/alerting) documentation.
19
+
20
+
## Google Analytics custom alerts
8
21
9
22
You can use Google Analytics Custom Alerts to send yourself emails whenever a specific traffic segment drops below (or above) a threshold you set.
10
23
11
-
[Learn how to set up email alerts here](https://support.google.com/analytics/answer/1033021?hl=en){:target="_blank"}.
24
+
Learn how to set up email alerts in [Google's documentation](https://support.google.com/analytics/answer/1033021?hl=en){:target="_blank"}.
12
25
13
-
###Analytics email summaries
26
+
## Analytics email summaries
14
27
15
28
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.
*[Amplitude email alerts (scroll down a bit)](https://amplitude.com/blog/2015/03/20/new-features-stickiness-team-access-controls-email-alerts-redshift-playbook/)
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.
23
36
@@ -27,10 +40,10 @@ Chartbeat and GoSquared both offer awesome real-time dashboards to see what's h
27
40
> info ""
28
41
> GoSquared also offers in-depth historical and user analysis. Chartbeat sticks to realtime anonymous traffic, but offers some sweet features for publishers.
29
42
30
-
###Webhook-based alerts
43
+
## Webhook-based alerts
31
44
32
-
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.
45
+
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.
33
46
34
-
###Event-triggered emails
47
+
## Event-triggered emails
35
48
36
49
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.
0 commit comments