Skip to content

Commit 69cc140

Browse files
committedMar 19, 2025·
arrrrrgggghhhhhh
·
25.25.125.13.01
1 parent 452ec33 commit 69cc140

File tree

6 files changed

+158
-127
lines changed

6 files changed

+158
-127
lines changed
 

‎src/_data/sidenav/main.yml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -604,12 +604,10 @@ sections:
604604
- section_title: Alerts
605605
slug: /monitor/alerts
606606
section:
607-
- path: /monitor/alerts/connections-alerts
608-
title: Connections Alerting
609-
- path: /monitor/alerts/reverse-etl-alerts
610-
title: Reverse ETL Alerting
611-
- path: /monitor/alerts/connections/alerts
612-
title: Audience Alerting
607+
- path: /monitor/alerts
608+
title: Alerts Overview
609+
- path: /monitor/alerts/default-alerts
610+
title: Default Alerts
613611
- path: /monitor/audit-trail
614612
title: Audit Trail
615613
- section_title: Protocols

‎src/_includes/icons/monitor.svg

Lines changed: 1 addition & 1 deletion
Loading

‎src/monitor/alerts/connections-alerts.md

Lines changed: 0 additions & 61 deletions
This file was deleted.

‎src/monitor/alerts/default-alerts.md

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
title: Default Alerts
3+
---
4+
5+
Segment's default alerts have a preset trigger and are often used to detect changes users make to the integrations in your workspace.
6+
7+
In the Monitor tab, you can see all of your alerts, separated by product area, in a tabular format.
8+
9+
> info "Only Workspace Owners can view and edit all alerts"
10+
> Users with other roles can see all alerts in a workspace, but can only edit or see the configured details for alerts that they created.
11+
12+
You can create alerts for the following product areas:
13+
- [Sources](#source-alerts)
14+
- [Destinations](#destination-alerts)
15+
- [Storage Destinations](#storage-destination-alerts)
16+
- [Protocols](#protocol-alerts)
17+
- [Unify](#unify-alerts)
18+
- [Engage](#engage-alerts)
19+
- [Functions](#functions-alerts)
20+
- [Reverse ETL](#reverse-etl-alerts)
21+
- [Data Graph](#data-graph-alerts)
22+
23+
The Alerting table includes the following information about each event:
24+
- **Alert name**: The type of alert, for example, "Audience created" or "Audience deleted".
25+
- **Last triggered**: The most recent date and time, in your local time zone, that the alert was triggered.
26+
- **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.
27+
- **Notification channels**: Icons describing what notification channels you'll receive the alerts on - through a Slack webhook, email, or in-app notification.
28+
- **Actions**: By selecting the menu icon for an individual alert, you can edit or delete it from the Alerting page.
29+
30+
## Create a new alert
31+
32+
To create a new alert:
33+
1. From the Segment app, navigate to the **Monitor** tab and select **Alerts**.
34+
2. On the **Default** tab, identify the event you'd like to be alerted for and select the menu icon under the **Actions** tab.
35+
3. Click **Enable alert**.
36+
37+
## Alert descriptions
38+
39+
View a brief description of each alert type. 
40+
41+
### Source alerts
42+
- **New Event Blocked**: Segment blocked an event not previously specified in your [Source Schema](/docs/connections/sources/schema/) from entering a downstream destination.
43+
- **New Forbidden Event Property**:
44+
- **Source Created**: A user in your workspace created a new source.
45+
- **Source Deleted**: A user in your workspace deleted a source.
46+
- **Source Disabled**: A source was disabled, either by a user in your workspace or by Segment. Segment automatically disables a source after 14 days if the source isn't connected to an enabled destination.
47+
- **Source Run Failed**: After Segment fails to extract data from your source 3 consecutive times, you'll be notified.
48+
- **Source Settings Modified**: A user in your workspace modified the settings for one of your sources.
49+
50+
> info "Custom Source alerts"
51+
> During the Monitor public beta, you can configure custom [source volume alerts](/docs/connections/alerting/#source-volume-alerts), but these alerts won't appear in the Monitor tab.
52+
53+
## Destination alerts
54+
- **Destination Disabled**: A user in your workspace disabled a destination.
55+
- **Destination Enabled**: A user in your workspace enabled a destination.
56+
- **Destination Filter Created**: A user in your workspace created a [destination filter](/docs/connections/destinations/destination-filters/).
57+
- **Destination Filter Deleted**: A user in your workspace deleted a [destination filter](/docs/connections/destinations/destination-filters/).
58+
- **Destination Filter Disabled**: A user in your workspace disabled a [destination filter](/docs/connections/destinations/destination-filters/).
59+
- **Destination Filter Enabled**: A user in your workspace enabled a [destination filter](/docs/connections/destinations/destination-filters/).
60+
- **Destination Filter Modified**: A user in your workspace modified a [destination filter](/docs/connections/destinations/destination-filters/).
61+
- **Destination Modified**: A user in your workspace made changes to a destination.
62+
63+
> info "Custom Destination alerts"
64+
> During the Monitor public beta, you can configure custom [Successful delivery rate alerts](/docs/connections/alerting/#successful-delivery-rate-alerts), but these alerts won't appear in the Monitor tab.
65+
66+
## Storage Destination alerts
67+
- **Storage Destination Created**: A user in your workspace created a new instance of a storage destination.
68+
- **Storage Destination Deleted**: A user in your workspace deleted a storage destination.
69+
- **Storage Destination Disabled**: A user in your workspace disabled a storage destination.
70+
- **Storage Destination Modified**: A user in your workspace modified an existing storage destination.
71+
- **Storage Destination Sync Failed**: Segment failed to sync any rows of data from your source to your storage destination.
72+
- **Storage Destination Sync Partially Succeeded**: Segment encountered some notices and was only able to sync some of your data from your source to your storage destination.
73+
- **Storage Destination Sync Skipped**: Segment skipped a scheduled sync to your storage destination. This might happen if there is no new data for Segment to sync with your storage destination.
74+
75+
76+
## Protocol alerts
77+
- **Source Connected To Tracking Plan**: A user in your workspace connected a source to one of your Tracking Plans.
78+
- **Source Disconnected From Tracking Plan**: A user in your workspace disconnected a source from one of your Tracking Plans.
79+
- **Tracking Plan Created**: A user in your workspace created a new Tracking Plan.
80+
- **Tracking Plan Deleted**: A user in your workspace deleted a Tracking Plan.
81+
- **Tracking Plan Inferred**: Segment inferred the data type for an event.
82+
- **Tracking Plan Modified**: A user in your workspace modified a Tracking Plan.
83+
- **Tracking Plan New Event Allowed**: An unplanned event was allowed by your [Schema Controls](/docs/protocols/enforce/schema-configuration/).
84+
- **Tracking Plan New Event Blocked**: An unplanned event was allowed by your [Schema Controls](/docs/protocols/enforce/schema-configuration/).
85+
- **Tracking Plan New Group Trait Omitted**: A new trait attached to a Group call was was omitted from an event.
86+
- **Tracking Plan New Identify Trait Omitted**: A new trait attached to a [Identify call was was omitted from an event](/docs/protocols/enforce/schema-configuration/#identify-calls---unplanned-traits).
87+
- **Tracking Plan New Track Property Omitted**: A new trait attached to a [Track call was was omitted from an event](/docs/protocols/enforce/schema-configuration/#track-calls---unplanned-properties).
88+
- **Violations Detected**: Segment detected [data that does not confirm to your Tracking Plan](/docs/protocols/validate/forward-violations/).
89+
90+
## Unify alerts
91+
- **Computed Trait CSV Downloaded**: A user in your workspace [downloaded a CSV file of all users that have a Computed Trait](/docs/unify/Traits/computed-traits/#downloading-your-computed-trait-as-a-csv-file).
92+
- **Computed Trait Created**: A user in your workspace created a new [Computed Trait](/docs/unify/Traits/computed-traits/#types-of-computed-traits).
93+
- **Computed Trait Deleted**: A user in your workspace deleted an existing [Computed Trait](/docs/unify/Traits/computed-traits/#types-of-computed-traits).
94+
- **Computed Trait Destination Sync Failed**: Segment failed to sync [Computed Trait generated events](/docs/engage/using-engage-data/#computed-trait-generated-events) with your downstream destination.
95+
- **Computed Trait Modified**: A user in your workspace made changes to an existing Computed Trait.
96+
- **Computed Trait Run Failed**: Segment was unable to compute your trait. To resolve this error, please [contact Segment support](https://segment.com/help/contact/){:target="_blank”}.
97+
- **Profiles Sync Historical Backfill Completed**: Segment completed [backfilling profile data from your data warehouse](/docs/unify/profiles-sync/profiles-sync-setup/#using-historical-backfill).
98+
- **Profiles Sync Warehouse Created**: A user in your workspace [connected a data warehouse to Profiles Sync](/docs/unify/profiles-sync/profiles-sync-setup/#step-2-connect-the-warehouse-and-enable-profiles-sync).
99+
- **Profiles Sync Warehouse Deleted**: A user in your workspace [deleted the data warehouse connected to Profiles Sync](/docs/unify/profiles-sync/profiles-sync-setup/#disable-or-delete-a-warehouse).
100+
- **Profiles Sync Warehouse Disabled**: A user in your workspace [disabled the data warehouse connected to Profiles Sync](/docs/unify/profiles-sync/profiles-sync-setup/#disable-or-delete-a-warehouse).
101+
- **Profiles Sync Warehouse Modified**: A user in your workspace [modified the data warehouse connected to Profiles Sync](/docs/unify/profiles-sync/profiles-sync-setup/#settings-and-maintenance).
102+
- **Profiles Sync Warehouse Sync Failed**: Segment failed to sync any of
103+
your identity-resolved profiles to your data warehouse.
104+
- **Source Connected To Space**: A user in your workspace connected a source to your Unify space.
105+
- **Source Disconnected From Space**: A user in your workspace disconnected a source from your Unify space.
106+
107+
## Engage alerts
108+
- **Audience CSV Downloaded**: A user in your workspace [downloaded an Audience as a CSV file](/docs/engage/audiences/#download-your-audience-as-a-csv-file).
109+
- **Audience Created**: A user in your workspace [created a new Audience](/docs/engage/audiences/#building-an-audience).
110+
- **Audience Deleted**: A user in your workspace deleted an Audience.
111+
- **Audience Destination Sync Failed**: Segment was unable to sync your Audience with a connected destination.
112+
- **Audience Modified**: A user in your workspace modified an Audience.
113+
- **Audience Run Failed**: Segment was unable to compute your Audience. To resolve this error, please [contact Segment support](https://segment.com/help/contact/){:target="_blank”}.
114+
115+
> info "Custom Engage alerts"
116+
> During the Monitor public beta, you can configure custom [Activation event health spikes or drops](/docs/engage/audiences/#activation-event-health-spikes-or-drops) alerts, but these alerts won't appear in the Monitor tab.
117+
118+
## Functions alerts
119+
- **Destination Filter Created**: A user in your workspace created a [destination filter](/docs/connections/destinations/destination-filters/).
120+
- **Destination Filter Deleted**: A user in your workspace deleted a [destination filter](/docs/connections/destinations/destination-filters/).
121+
- **Destination Filter Modified**: A user in your workspace modified a [destination filter](/docs/connections/destinations/destination-filters/).
122+
- **Source Function Created**: A user in your workspace created a [source function](/docs/connections/functions/source-functions/).
123+
- **Source Function Deleted**: A user in your workspace deleted a [source function](/docs/connections/functions/source-functions/).
124+
- **Source Function Modified**: A user in your workspace modified a [source function](/docs/connections/functions/source-functions/).
125+
126+
## Reverse ETL alerts
127+
- **Reverse ETL Sync Failed**: Segment failed to sync any of your records from your warehouse to your downstream destination.
128+
- **Reverse ETL Sync Partial Success**: Segment was able to sync some, but not all, of your records from your data warehouse with your downstream destination.
129+
130+
> info "Custom Reverse ETL alerts"
131+
> During the Monitor public beta, you can configure custom Reverse ETL alerts for [failed or partially successful syncs](/docs/connections/reverse-etl/manage-retl/#failed-or-partially-successful-syncs) and [mapping-level successful delivery rate fluctuations](/docs/connections/reverse-etl/manage-retl/#mapping-level-successful-delivery-rate-fluctuations), but these alerts won't appear in the Monitor tab.
132+
133+
## Data Graph alerts
134+
- **Data Graph Breaking Change**: A change in your warehouse broke components of your Data Graph. For more information about breaking changes, see the [Data Graph docs](/docs/unify/data-graph/#detect-warehouse-breaking-changes).

‎src/monitor/alerts/index.md

Lines changed: 16 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,19 @@
11
---
22
title: Alerts
33
---
4-
Connections Alerting allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection.
5-
6-
To access Connections Alerting, select an event-streaming connection (like a web library source or cloud mode destination) and click the **Alerts** tab.
7-
8-
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.
9-
10-
## Source volume alerts
11-
12-
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% 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.
13-
14-
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.
15-
16-
<img src="images/alerting-source-alert.png" alt="A screenshot of the Source Volume alert creation sidesheet." width="470px" height="540px">
17-
18-
To create a source volume alert:
19-
1. In your workspace, navigate to Connections, select Sources, and select the Event streams tab.
20-
2. Select the [event streams source](/docs/connections/sources/#event-streams-sources) you'd like to configure alerts for.
21-
2. Select the Alerts tab and click **Create alert**.
22-
3. On the Create alert sidesheet, enter a percentage of source volume change that you'd like to be notified for.
23-
4. Select one or more of the following alert channels:
24-
- **Email**: Select this to receive notifications at the provided email address.
25-
- **Slack**: Select this to send alerts to one or more channels in your workspace.
26-
- **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.
27-
5. Click **Save**.
28-
29-
To make changes to a source volume alert, select the icon in the Actions column for the alert and click **Edit**.
30-
31-
To delete a source volume alert, select the icon in the Actions column for the alert and click **Delete**.
32-
33-
> info "Deleting alerts created by other users requires Workspace Owner permissions"
34-
> All users can delete source volume alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
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, select the icon in the Actions column for the alert and click **Edit**.
53-
54-
To delete a successful delivery rate alert, select the icon in the Actions column for the alert and click **Delete**.
55-
56-
> info "Deleting alerts created by other users requires Workspace Owner permissions"
57-
> All users can delete successful delivery alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
58-
59-
Segment generates delivery alerts for failed deliveries and successful deliveries, which are the last two stages of the delivery pipeline. As a result, alerts are based on Segment's attempts to send qualified events to your destination, excluding those filtered out by business rules (like protocols, destination filters, or mappings).
4+
Segment's alerting features allow you to receive in-app, email, and Slack notifications related to the status, performance, and throughput of your Segment integrations.
5+
6+
> info "Public beta"
7+
> The Monitor hub is in Public Beta. Some functionality may change before it becomes generally available. During the public beta, only default alerts are located in the Monitor tab.
8+
9+
Segment has two kinds of alerts:
10+
- **Default alerts**: Alerts that have a preset threshold to trigger and are often used to detect changes users make to the integrations in your workspace. For example, the
11+
- **Custom alerts**: Alerts that allow you to customize the sensitivity of the trigger that activates an alert so you can more accurately detect event volume fluctuations in your sources and destinations. For example,
12+
13+
{% include components/reference-button.html
14+
href="/monitor/alerts/default-alerts"
15+
variant="related"
16+
icon="monitor.svg"
17+
title="Default alerts"
18+
description="Learn more about Segment's default alerts."
19+
%}

‎src/monitor/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ Select a product below to learn about its capabilities, supported destinations,
1313
<div class="double">
1414
{% include components/reference-button.html
1515
href="/docs/monitor/alerts"
16-
icon="read-more.svg"
16+
icon="megaphone.svg"
1717
title="Alerts"
18-
description="Receive in-app, email, or Slack notifications related to the performance and throughput of a Segment connection."
18+
description="Receive notifications related to the performance and throughput of a Segment connection."
1919
%}
2020

2121
{% include components/reference-button.html
2222
href="/docs/monitor/audit-trail"
23-
icon="connections.svg"
23+
icon="glossary.svg"
2424
title="Audit Trail"
2525
description="View, filter, and export the last 90 days of user and system activity."
2626
%}

0 commit comments

Comments
 (0)
Please sign in to comment.