From 11220de71c70e09a7752ecba84100d562a2ba07d Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 11 Mar 2025 17:02:03 -0400 Subject: [PATCH 01/11] init monitor tab --- src/_data/sidenav/main.yml | 11 ++++ src/_includes/icons/monitor.svg | 3 + .../alerts/connections-alerts.md} | 0 src/monitor/alerts/index.md | 59 +++++++++++++++++++ .../iam => monitor}/audit-trail.md | 1 + src/monitor/index.md | 28 +++++++++ 6 files changed, 102 insertions(+) create mode 100644 src/_includes/icons/monitor.svg rename src/{connections/alerting.md => monitor/alerts/connections-alerts.md} (100%) create mode 100644 src/monitor/alerts/index.md rename src/{segment-app/iam => monitor}/audit-trail.md (99%) create mode 100644 src/monitor/index.md diff --git a/src/_data/sidenav/main.yml b/src/_data/sidenav/main.yml index 836c62e999..ab6e4ee026 100644 --- a/src/_data/sidenav/main.yml +++ b/src/_data/sidenav/main.yml @@ -597,6 +597,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/connections-alerts + title: Connections Alerts + - path: /monitor/audit-trail + title: Audit Trail - section_title: Protocols section: - path: /protocols diff --git a/src/_includes/icons/monitor.svg b/src/_includes/icons/monitor.svg new file mode 100644 index 0000000000..3713825bb8 --- /dev/null +++ b/src/_includes/icons/monitor.svg @@ -0,0 +1,3 @@ + + + diff --git a/src/connections/alerting.md b/src/monitor/alerts/connections-alerts.md similarity index 100% rename from src/connections/alerting.md rename to src/monitor/alerts/connections-alerts.md diff --git a/src/monitor/alerts/index.md b/src/monitor/alerts/index.md new file mode 100644 index 0000000000..1630ed14ba --- /dev/null +++ b/src/monitor/alerts/index.md @@ -0,0 +1,59 @@ +--- +title: Alerts +--- +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% 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. + +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. + +A screenshot of the Source Volume alert creation sidesheet. + +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, select the icon in the Actions column for the alert and click **Edit**. + +To delete a source volume alert, select the icon in the Actions column for the alert and click **Delete**. + +> 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. + +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, select the icon in the Actions column for the alert and click **Edit**. + +To delete a successful delivery rate alert, select the icon in the Actions column for the alert and click **Delete**. + +> 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). \ No newline at end of file diff --git a/src/segment-app/iam/audit-trail.md b/src/monitor/audit-trail.md similarity index 99% rename from src/segment-app/iam/audit-trail.md rename to src/monitor/audit-trail.md index 15711ed862..137bafd369 100644 --- a/src/segment-app/iam/audit-trail.md +++ b/src/monitor/audit-trail.md @@ -1,6 +1,7 @@ --- title: Audit Trail plan: audit-trail +redirect_from: /docs/segment-app/iam/audit-trail/ --- diff --git a/src/monitor/index.md b/src/monitor/index.md new file mode 100644 index 0000000000..d9ec6ab878 --- /dev/null +++ b/src/monitor/index.md @@ -0,0 +1,28 @@ +--- +title: Monitor Overview +--- +With Segment’s auditing and alerting capabilities, you can monitor the health of your integrations, 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="read-more.svg" + title="Alerts" + description="Receive in-app, email, or Slack notifications related to the performance and throughput of a Segment connection." + %} + + {% include components/reference-button.html + href="/docs/monitor/audit-trail" + icon="connections.svg" + title="Audit Trail" + description="View, filter, and export the last 90 days of user and system activity." + %} +
+ From 452ec33ffa1cd1154eb1e3e3fbfecc79b676c62d Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 11 Mar 2025 17:02:42 -0400 Subject: [PATCH 02/11] Update main.yml --- src/_data/sidenav/main.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/_data/sidenav/main.yml b/src/_data/sidenav/main.yml index ab6e4ee026..a307c43bb3 100644 --- a/src/_data/sidenav/main.yml +++ b/src/_data/sidenav/main.yml @@ -605,7 +605,11 @@ sections: slug: /monitor/alerts section: - path: /monitor/alerts/connections-alerts - title: Connections Alerts + title: Connections Alerting + - path: /monitor/alerts/reverse-etl-alerts + title: Reverse ETL Alerting + - path: /monitor/alerts/connections/alerts + title: Audience Alerting - path: /monitor/audit-trail title: Audit Trail - section_title: Protocols From 69cc140c1b70928e94d7a2a2f1293730c2c69a68 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 19 Mar 2025 15:00:11 -0400 Subject: [PATCH 03/11] arrrrrgggghhhhhh --- src/_data/sidenav/main.yml | 10 +- src/_includes/icons/monitor.svg | 2 +- src/monitor/alerts/connections-alerts.md | 61 ----------- src/monitor/alerts/default-alerts.md | 134 +++++++++++++++++++++++ src/monitor/alerts/index.md | 72 +++--------- src/monitor/index.md | 6 +- 6 files changed, 158 insertions(+), 127 deletions(-) delete mode 100644 src/monitor/alerts/connections-alerts.md create mode 100644 src/monitor/alerts/default-alerts.md diff --git a/src/_data/sidenav/main.yml b/src/_data/sidenav/main.yml index a307c43bb3..a5a2ed4e52 100644 --- a/src/_data/sidenav/main.yml +++ b/src/_data/sidenav/main.yml @@ -604,12 +604,10 @@ sections: - section_title: Alerts slug: /monitor/alerts section: - - path: /monitor/alerts/connections-alerts - title: Connections Alerting - - path: /monitor/alerts/reverse-etl-alerts - title: Reverse ETL Alerting - - path: /monitor/alerts/connections/alerts - title: Audience Alerting + - path: /monitor/alerts + title: Alerts Overview + - path: /monitor/alerts/default-alerts + title: Default Alerts - path: /monitor/audit-trail title: Audit Trail - section_title: Protocols diff --git a/src/_includes/icons/monitor.svg b/src/_includes/icons/monitor.svg index 3713825bb8..9df585d496 100644 --- a/src/_includes/icons/monitor.svg +++ b/src/_includes/icons/monitor.svg @@ -1,3 +1,3 @@ - + diff --git a/src/monitor/alerts/connections-alerts.md b/src/monitor/alerts/connections-alerts.md deleted file mode 100644 index c838645131..0000000000 --- a/src/monitor/alerts/connections-alerts.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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% 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. - -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. - -A screenshot of the Source Volume alert creation sidesheet. - -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, select the icon in the Actions column for the alert and click **Edit**. - -To delete a source volume alert, select the icon in the Actions column for the alert and click **Delete**. - -> 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. - -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, select the icon in the Actions column for the alert and click **Edit**. - -To delete a successful delivery rate alert, select the icon in the Actions column for the alert and click **Delete**. - -> 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). diff --git a/src/monitor/alerts/default-alerts.md b/src/monitor/alerts/default-alerts.md new file mode 100644 index 0000000000..bc808848b9 --- /dev/null +++ b/src/monitor/alerts/default-alerts.md @@ -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. + +In 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](#protocol-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**: +- **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 there is no new data for Segment to sync with your storage destination. + + +## Protocol 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). \ No newline at end of file diff --git a/src/monitor/alerts/index.md b/src/monitor/alerts/index.md index 1630ed14ba..4956a5aaa9 100644 --- a/src/monitor/alerts/index.md +++ b/src/monitor/alerts/index.md @@ -1,59 +1,19 @@ --- title: Alerts --- -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% 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. - -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. - -A screenshot of the Source Volume alert creation sidesheet. - -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, select the icon in the Actions column for the alert and click **Edit**. - -To delete a source volume alert, select the icon in the Actions column for the alert and click **Delete**. - -> 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. - -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, select the icon in the Actions column for the alert and click **Edit**. - -To delete a successful delivery rate alert, select the icon in the Actions column for the alert and click **Delete**. - -> 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). \ No newline at end of file +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 to trigger and are often used to detect changes users make to the integrations in your workspace. For example, the +- **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, + +{% 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." +%} \ No newline at end of file diff --git a/src/monitor/index.md b/src/monitor/index.md index d9ec6ab878..ed8b79e312 100644 --- a/src/monitor/index.md +++ b/src/monitor/index.md @@ -13,14 +13,14 @@ Select a product below to learn about its capabilities, supported destinations,
{% include components/reference-button.html href="/docs/monitor/alerts" - icon="read-more.svg" + icon="megaphone.svg" title="Alerts" - description="Receive in-app, email, or Slack notifications related to the performance and throughput of a Segment connection." + description="Receive notifications related to the performance and throughput of a Segment connection." %} {% include components/reference-button.html href="/docs/monitor/audit-trail" - icon="connections.svg" + icon="glossary.svg" title="Audit Trail" description="View, filter, and export the last 90 days of user and system activity." %} From 845ffd397f55d3e3acd4995b09371f3091b38dbb Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 19 Mar 2025 15:02:54 -0400 Subject: [PATCH 04/11] [netlify-build] --- src/monitor/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/src/monitor/index.md b/src/monitor/index.md index ed8b79e312..64bb43b2d1 100644 --- a/src/monitor/index.md +++ b/src/monitor/index.md @@ -25,4 +25,3 @@ Select a product below to learn about its capabilities, supported destinations, description="View, filter, and export the last 90 days of user and system activity." %}
- From d1a4e0a8550cfe0f19b95d58c4a67d9b4580820c Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 19 Mar 2025 15:11:25 -0400 Subject: [PATCH 05/11] [netlify-build] --- src/monitor/alerts/default-alerts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/monitor/alerts/default-alerts.md b/src/monitor/alerts/default-alerts.md index bc808848b9..ec506f739d 100644 --- a/src/monitor/alerts/default-alerts.md +++ b/src/monitor/alerts/default-alerts.md @@ -70,7 +70,7 @@ View a brief description of each alert type.  - **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 there is no new data for Segment to sync with 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. ## Protocol alerts From 5bdf98aa17dea85cdd9267b9af06dbb1c52b3b71 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 19 Mar 2025 19:51:39 -0400 Subject: [PATCH 06/11] [netlify-build] changes requested by Peter --- src/_data/sidenav/main.yml | 2 -- src/monitor/alerts/index.md | 4 ++-- src/monitor/index.md | 16 +++------------- src/{monitor => segment-app/iam}/audit-trail.md | 1 - 4 files changed, 5 insertions(+), 18 deletions(-) rename src/{monitor => segment-app/iam}/audit-trail.md (99%) diff --git a/src/_data/sidenav/main.yml b/src/_data/sidenav/main.yml index af223b1a26..0ed1d80825 100644 --- a/src/_data/sidenav/main.yml +++ b/src/_data/sidenav/main.yml @@ -610,8 +610,6 @@ sections: title: Alerts Overview - path: /monitor/alerts/default-alerts title: Default Alerts - - path: /monitor/audit-trail - title: Audit Trail - section_title: Protocols section: - path: /protocols diff --git a/src/monitor/alerts/index.md b/src/monitor/alerts/index.md index 4956a5aaa9..b4f91288b8 100644 --- a/src/monitor/alerts/index.md +++ b/src/monitor/alerts/index.md @@ -7,8 +7,8 @@ Segment's alerting features allow you to receive in-app, email, and Slack notifi > 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 to trigger and are often used to detect changes users make to the integrations in your workspace. For example, the -- **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, +- **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" diff --git a/src/monitor/index.md b/src/monitor/index.md index 64bb43b2d1..08c40fccea 100644 --- a/src/monitor/index.md +++ b/src/monitor/index.md @@ -1,27 +1,17 @@ --- title: Monitor Overview --- -With Segment’s auditing and alerting capabilities, you can monitor the health of your integrations, 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. +With Segment’s alerting capabilities, you can monitor the health of your integrations and diagnose issues that might be present in your data pipeline. 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. + - -
{% 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." %} - - {% include components/reference-button.html - href="/docs/monitor/audit-trail" - icon="glossary.svg" - title="Audit Trail" - description="View, filter, and export the last 90 days of user and system activity." - %} -
diff --git a/src/monitor/audit-trail.md b/src/segment-app/iam/audit-trail.md similarity index 99% rename from src/monitor/audit-trail.md rename to src/segment-app/iam/audit-trail.md index 137bafd369..15711ed862 100644 --- a/src/monitor/audit-trail.md +++ b/src/segment-app/iam/audit-trail.md @@ -1,7 +1,6 @@ --- title: Audit Trail plan: audit-trail -redirect_from: /docs/segment-app/iam/audit-trail/ --- From 4fcb0630a53f56cf125ac000582b1c2319b22931 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 19 Mar 2025 19:52:03 -0400 Subject: [PATCH 07/11] Update src/monitor/alerts/default-alerts.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- src/monitor/alerts/default-alerts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/monitor/alerts/default-alerts.md b/src/monitor/alerts/default-alerts.md index ec506f739d..f37cee07ff 100644 --- a/src/monitor/alerts/default-alerts.md +++ b/src/monitor/alerts/default-alerts.md @@ -4,7 +4,7 @@ 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. -In the Monitor tab, you can see all of your alerts, separated by product area, in a tabular format. +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. From 611413d4ebf5114ebd57aa5802554417f6266f95 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 19 Mar 2025 19:54:05 -0400 Subject: [PATCH 08/11] [netlify-build] --- src/connections/alerting.md | 59 +++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 src/connections/alerting.md diff --git a/src/connections/alerting.md b/src/connections/alerting.md new file mode 100644 index 0000000000..690fe781ec --- /dev/null +++ b/src/connections/alerting.md @@ -0,0 +1,59 @@ +--- +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% 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. + +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. + +A screenshot of the Source Volume alert creation sidesheet. + +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, select the icon in the Actions column for the alert and click **Edit**. + +To delete a source volume alert, select the icon in the Actions column for the alert and click **Delete**. + +> 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. + +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, select the icon in the Actions column for the alert and click **Edit**. + +To delete a successful delivery rate alert, select the icon in the Actions column for the alert and click **Delete**. + +> 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). \ No newline at end of file From f401cae17e72a1a3f77180625243ae1c28e39b2e Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Fri, 21 Mar 2025 11:27:23 -0400 Subject: [PATCH 09/11] [netlify-build] --- src/monitor/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/monitor/index.md b/src/monitor/index.md index 08c40fccea..27b01e676d 100644 --- a/src/monitor/index.md +++ b/src/monitor/index.md @@ -15,3 +15,4 @@ Select a product below to learn about its capabilities, supported destinations, title="Alerts" description="Receive notifications related to the performance and throughput of a Segment connection." %} + From 815409cced1010a5990967ea362a4a5e222c5546 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Fri, 21 Mar 2025 11:44:43 -0400 Subject: [PATCH 10/11] [netlify-build] --- src/monitor/alerts/default-alerts.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/monitor/alerts/default-alerts.md b/src/monitor/alerts/default-alerts.md index f37cee07ff..5e71b5daa9 100644 --- a/src/monitor/alerts/default-alerts.md +++ b/src/monitor/alerts/default-alerts.md @@ -40,7 +40,7 @@ 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**: +- **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. @@ -73,7 +73,7 @@ View a brief description of each alert type.  - **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. -## Protocol alerts +## 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. From 7415bb543cf989196a865338336f506643598275 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Mon, 24 Mar 2025 14:18:47 -0400 Subject: [PATCH 11/11] [netlify-build] --- src/monitor/alerts/default-alerts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/monitor/alerts/default-alerts.md b/src/monitor/alerts/default-alerts.md index 5e71b5daa9..bd20b502e8 100644 --- a/src/monitor/alerts/default-alerts.md +++ b/src/monitor/alerts/default-alerts.md @@ -13,7 +13,7 @@ You can create alerts for the following product areas: - [Sources](#source-alerts) - [Destinations](#destination-alerts) - [Storage Destinations](#storage-destination-alerts) -- [Protocols](#protocol-alerts) +- [Protocols](#protocols-alerts) - [Unify](#unify-alerts) - [Engage](#engage-alerts) - [Functions](#functions-alerts)