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

Monitor tab/Alerting hub [DOC-1059] #7504

Merged
merged 16 commits into from
Mar 24, 2025
Merged
Show file tree
Hide file tree
Changes from all 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
11 changes: 11 additions & 0 deletions src/_data/sidenav/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -599,6 +599,17 @@ sections:
title: HIPAA Eligible Segment
- path: /privacy/faq
title: Privacy FAQs
- section_title: Monitor
section:
- path: /monitor
title: Monitor Overview
- section_title: Alerts
slug: /monitor/alerts
section:
- path: /monitor/alerts
title: Alerts Overview
- path: /monitor/alerts/default-alerts
title: Default Alerts
- section_title: Protocols
section:
- path: /protocols
Expand Down
3 changes: 3 additions & 0 deletions src/_includes/icons/monitor.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 1 addition & 3 deletions src/connections/alerting.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ To delete a source volume alert, select the icon in the Actions column for the a

> info "Deleting alerts created by other users requires Workspace Owner permissions"
> All users can delete source volume alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.

## 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.
Expand All @@ -57,5 +56,4 @@ To delete a successful delivery rate alert, select the icon in the Actions colum

> info "Deleting alerts created by other users requires Workspace Owner permissions"
> All users can delete successful delivery alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.

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).
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).
134 changes: 134 additions & 0 deletions src/monitor/alerts/default-alerts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
---
title: Default Alerts
---

Segment's default alerts have a preset trigger and are often used to detect changes users make to the integrations in your workspace.

On the **Monitor** tab, you can see all of your alerts, separated by product area, in a tabular format.

> info "Only Workspace Owners can view and edit all alerts"
> 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.

You can create alerts for the following product areas:
- [Sources](#source-alerts)
- [Destinations](#destination-alerts)
- [Storage Destinations](#storage-destination-alerts)
- [Protocols](#protocols-alerts)
- [Unify](#unify-alerts)
- [Engage](#engage-alerts)
- [Functions](#functions-alerts)
- [Reverse ETL](#reverse-etl-alerts)
- [Data Graph](#data-graph-alerts)

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.
- **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, 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

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**.

## Alert descriptions

View a brief description of each alert type. 

### Source alerts
- **New Event Blocked**: Segment blocked an event not previously specified in your [Source Schema](/docs/connections/sources/schema/) from entering a downstream destination.
- **New Forbidden Event Property**: Segment blocked an event property that was not specified in your [Source Schema](/docs/connections/sources/schema/) from entering a downstream destination.
- **Source Created**: A user in your workspace created a new source.
- **Source Deleted**: A user in your workspace deleted a source.
- **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.
- **Source Run Failed**: After Segment fails to extract data from your source 3 consecutive times, you'll be notified.
- **Source Settings Modified**: A user in your workspace modified the settings for one of your sources.

> info "Custom Source alerts"
> 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.

## Destination alerts
- **Destination Disabled**: A user in your workspace disabled a destination.
- **Destination Enabled**: A user in your workspace enabled a destination.
- **Destination Filter Created**: A user in your workspace created a [destination filter](/docs/connections/destinations/destination-filters/).
- **Destination Filter Deleted**: A user in your workspace deleted a [destination filter](/docs/connections/destinations/destination-filters/).
- **Destination Filter Disabled**: A user in your workspace disabled a [destination filter](/docs/connections/destinations/destination-filters/).
- **Destination Filter Enabled**: A user in your workspace enabled a [destination filter](/docs/connections/destinations/destination-filters/).
- **Destination Filter Modified**: A user in your workspace modified a [destination filter](/docs/connections/destinations/destination-filters/).
- **Destination Modified**: A user in your workspace made changes to a destination.

> info "Custom Destination alerts"
> 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.

## Storage Destination alerts
- **Storage Destination Created**: A user in your workspace created a new instance of a storage destination.
- **Storage Destination Deleted**: A user in your workspace deleted a storage destination.
- **Storage Destination Disabled**: A user in your workspace disabled a storage destination.
- **Storage Destination Modified**: A user in your workspace modified an existing storage destination.
- **Storage Destination Sync Failed**: Segment failed to sync any rows of data from your source to your storage destination.
- **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.
- **Storage Destination Sync Skipped**: Segment skipped a scheduled sync to your storage destination. This might happen if the previous sync wasn't complete by the time the next sync was scheduled to begin.


## Protocols alerts
- **Source Connected To Tracking Plan**: A user in your workspace connected a source to one of your Tracking Plans.
- **Source Disconnected From Tracking Plan**: A user in your workspace disconnected a source from one of your Tracking Plans.
- **Tracking Plan Created**: A user in your workspace created a new Tracking Plan.
- **Tracking Plan Deleted**: A user in your workspace deleted a Tracking Plan.
- **Tracking Plan Inferred**: Segment inferred the data type for an event.
- **Tracking Plan Modified**: A user in your workspace modified a Tracking Plan.
- **Tracking Plan New Event Allowed**: An unplanned event was allowed by your [Schema Controls](/docs/protocols/enforce/schema-configuration/).
- **Tracking Plan New Event Blocked**: An unplanned event was allowed by your [Schema Controls](/docs/protocols/enforce/schema-configuration/).
- **Tracking Plan New Group Trait Omitted**: A new trait attached to a Group call was was omitted from an event.
- **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).
- **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).
- **Violations Detected**: Segment detected [data that does not confirm to your Tracking Plan](/docs/protocols/validate/forward-violations/).

## Unify alerts
- **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).
- **Computed Trait Created**: A user in your workspace created a new [Computed Trait](/docs/unify/Traits/computed-traits/#types-of-computed-traits).
- **Computed Trait Deleted**: A user in your workspace deleted an existing [Computed Trait](/docs/unify/Traits/computed-traits/#types-of-computed-traits).
- **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.
- **Computed Trait Modified**: A user in your workspace made changes to an existing Computed Trait.
- **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”}.
- **Profiles Sync Historical Backfill Completed**: Segment completed [backfilling profile data from your data warehouse](/docs/unify/profiles-sync/profiles-sync-setup/#using-historical-backfill).
- **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).
- **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).
- **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).
- **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).
- **Profiles Sync Warehouse Sync Failed**: Segment failed to sync any of
your identity-resolved profiles to your data warehouse.
- **Source Connected To Space**: A user in your workspace connected a source to your Unify space.
- **Source Disconnected From Space**: A user in your workspace disconnected a source from your Unify space.

## Engage alerts
- **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).
- **Audience Created**: A user in your workspace [created a new Audience](/docs/engage/audiences/#building-an-audience).
- **Audience Deleted**: A user in your workspace deleted an Audience.
- **Audience Destination Sync Failed**: Segment was unable to sync your Audience with a connected destination.
- **Audience Modified**: A user in your workspace modified an Audience.
- **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”}.

> info "Custom Engage alerts"
> 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.

## Functions alerts
- **Destination Filter Created**: A user in your workspace created a [destination filter](/docs/connections/destinations/destination-filters/).
- **Destination Filter Deleted**: A user in your workspace deleted a [destination filter](/docs/connections/destinations/destination-filters/).
- **Destination Filter Modified**: A user in your workspace modified a [destination filter](/docs/connections/destinations/destination-filters/).
- **Source Function Created**: A user in your workspace created a [source function](/docs/connections/functions/source-functions/).
- **Source Function Deleted**: A user in your workspace deleted a [source function](/docs/connections/functions/source-functions/).
- **Source Function Modified**: A user in your workspace modified a [source function](/docs/connections/functions/source-functions/).

## Reverse ETL alerts
- **Reverse ETL Sync Failed**: Segment failed to sync any of your records from your warehouse to your downstream destination.
- **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.

> info "Custom Reverse ETL alerts"
> 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.

## Data Graph alerts
- **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).
19 changes: 19 additions & 0 deletions src/monitor/alerts/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Alerts
---
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.

> info "Public beta"
> 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.

Segment has two kinds of alerts:
- **Default alerts**: Alerts that have a preset threshold and are often used to detect changes users make to the integrations in your workspace. For example, a _Source created_ alert is a default alert.
- **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, a _Source volume fluctuation_ alert would be a custom alert, as you could select a percentage of fluctuation that would work for your business needs.

{% include components/reference-button.html
href="/monitor/alerts/default-alerts"
variant="related"
icon="monitor.svg"
title="Default alerts"
description="Learn more about Segment's default alerts."
%}
18 changes: 18 additions & 0 deletions src/monitor/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Monitor Overview
---
With Segment’s alerting capabilities, you can monitor the health of your integrations and diagnose issues that might be present in your data pipeline. <!---, and view a record of all user and system activity that happened in Segment over the past 90 days. --->

Receive alerts for the performance and throughput of your Sources and Destinations, fluctuations in events delivered to your Reverse ETL mappings, and the performance and throughput of Audience syncs with Alerting.

<!---Segment’s Audit Trail provides a high-level view of all changes made in your workspace over the last 90 days. Use the Audit Trail and Audit Forwarding to quickly revert unintentional actions made in Segment to prevent downstream data loss.

Select a product below to learn about its capabilities, supported destinations, and more. --->

{% include components/reference-button.html
href="/docs/monitor/alerts"
icon="megaphone.svg"
title="Alerts"
description="Receive notifications related to the performance and throughput of a Segment connection."
%}