diff --git a/src/_data/sidenav/main.yml b/src/_data/sidenav/main.yml index fa6d41dfc7..dfc964e0a6 100644 --- a/src/_data/sidenav/main.yml +++ b/src/_data/sidenav/main.yml @@ -311,6 +311,36 @@ sections: title: OAuth 2.0 - path: /connections/aws-privatelink title: AWS PrivateLink Integration + +- section_title: Monitor + section: + - path: /monitor + title: Monitor Overview + - path: /monitor/audit-trail + title: Audit Trail + - section_title: Alerting + section: + - path: /monitor/alerting + title: Alerting Overview + - path: /monitor/alerting/audience-alerting + title: Audience Alerting + - path: /monitor/alerting/connections-alerting + title: Connections Alerting + - path: /monitor/alerting/retl-alerting + title: Reverse ETL Alerting + - section_title: Delivery Overview + section: + - path: /monitor/delivery-overview + title: Delivery Overview + - path: /monitor/delivery-overview/delivery-overview-classic-destinations + title: Delivery Overview for Classic Destinations + - path: /monitor/delivery-overview/delivery-overview-actions-destinations + title: Delivery Overview for Actions Destinations + - path: /monitor/delivery-overview/delivery-overview-for-storage + title: Delivery Overview for Storage Destinations + - path: /monitor/delivery-overview/delivery-overview-audiences + title: Delivery Overview for Audiences + - section_title: Unify section: - path: /unify diff --git a/src/_includes/icons/monitor.svg b/src/_includes/icons/monitor.svg new file mode 100644 index 0000000000..b7b56d5cf4 --- /dev/null +++ b/src/_includes/icons/monitor.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/src/connections/delivery-overview.md b/src/connections/delivery-overview.md deleted file mode 100644 index e36d513d90..0000000000 --- a/src/connections/delivery-overview.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: Delivery Overview ---- - -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. - -> info "Delivery Overview for RETL destinations and Engage Audience Syncs currently in development" -> This means that Segment is actively developing Delivery Overview features for RETL destinations and Engage Audience syncs. Some functionality may change before Delivery Overview for these integrations becomes generally available. -> -> Delivery Overview is generally available for streaming connections (cloud-streaming sources and cloud-streaming destinations) and in public beta for storage destinations. Some metrics specific to storage destinations, like selective syncs, failed row counts, and total rows seen, are not yet available. -> All users of Delivery Overview have access to the Event Delivery tab, and can configure delivery alerts for their destinations. - - -## Key features - -Delivery Overview has three core features: -- [Pipeline view](#pipeline-view): a visual overview of each step your data takes during the delivery process -- [Breakdown table](#breakdown-table): contains more detail about the events that were processed at each pipeline step -- [Discard table](#discard-table): contains details about the events that failed or were filtered out of your process and allows you to inspect samples of them - -You can refine these tables using the time picker and the metric toggle, located under the destination header. With the time picker, you can specify a time period (last 10 minutes, 1 hour, 24 hours, 7 days, 2 weeks, or a custom date range over the last two weeks) for which you'd like to see data. With the metric toggle, you can switch between seeing metrics represented as percentages (for example, *85% of events* or *a 133% increase in events*) or as counts (*13 events* or *an increase of 145 events*.) Delivery Overview shows percentages by default. - -### Pipeline view - -The pipeline view provides insights into each step your data is processed by enroute to the destination, with an emphasis on the steps where data can be discarded due to errors or your filter preferences. Each step provides details into counts, change rates, and event details (like the associated Event Type or Event Names), and the discard steps (Failed on ingest, Filtered at source, Filtered at destination, & Failed delivery) provide you with the reasons events were dropped before reaching the destination. Discard steps also include how to control or alter that outcome, when possible. The pipeline view also includes a label between the Filtered at destination and Failed delivery steps indicating how many events are currently pending retry. - -> info "Lookback window" -> Delivery Overview applies a 5-minute lookback period to provide stable, accurate metrics across all pipeline steps. This interval accounts for processing delays and ensures the data Segment displays reflects a reliable snapshot of recent events. - -#### Classic destinations -The pipeline view for classic destinations includes the following steps: -- **Successfully received**: Events that Segment ingested from your source. -- **Failed on ingest**: Events that Segment received, but were dropped due to internal data validation rules. -- **Filtered at source**: Events that were discarded due to schema settings or [Protocols](/docs/protocols/) Tracking Plans. -- **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. -- **Failed delivery**: Events that have been discarded due to errors or unmet destination requirements. -- **Successful delivery**: Events that were successfully delivered to the destination. - -#### Actions destinations -The pipeline view for Actions destination includes the following steps: -- **Successfully received**: Events that Segment ingested from your source. You can filter these events by event type, event name, app version, and [enrichment status](/docs/unify/data-graph/linked-events/). -- **Failed on ingest**: Events that Segment received, but were dropped due to internal data validation rules. -- **Filtered at source**: Events that were discarded due to schema settings or [Protocols](/docs/protocols/) Tracking Plans. -- **Mapping dropdown**: Select a [mapping](/docs/connections/destinations/actions/#customize-mappings) to filter the events in the Filtered at destination, Failed delivery and Successful delivery pipeline steps. -- **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. -- **Retry count**: The number of events currently pending retry. -- **Failed delivery**: Events that have been discarded due to errors or unmet destination requirements. -- **Successful delivery**: Events that were successfully delivered to the destination. - -![A screenshot of the Delivery Overview tab for an Actions destination, with the Track Page View mapping selected.](images/delivery-overview-actions-destination.jpeg) - -#### Storage destinations -The pipeline view for storage destination includes the following steps: -- **Successfully received**: Events that Segment ingested from your source. -- **Failed on ingest**: Events that Segment received, but were dropped due to internal data validation rules. -- **Filtered at source**: Events that were discarded due to schema settings or [Protocols](/docs/protocols/) Tracking Plans. -- **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. -- **Events to warehouse rows**: A read-only box that shows the point in the delivery process where Segment converts events into warehouse rows. -- **Failed to sync**: Syncs that either failed to sync or were partially successful. Selecting this step takes you to a table of all syncs with one or more failed collections. Select a sync from the table to view the discard reason, any collections that failed, the status, and the number of rows that synced for each collection. For information about common errors, see Ware -- **Successfully synced**: A record of all successful or partially successful syncs made with your destination. To view the reason a partially successfully sync was not fully successful, see the Failed to sync step. - -The following image shows a storage destination with 23 partially successful syncs: - -![A screenshot of the Delivery Overview tab for a Storage destination, with the Failed to sync step selected and a table of partially successful syncs.](images/delivery-overview-storage-destinations.png) - -### Breakdown table -The breakdown table provides you with greater detail about the selected events. - -To open the breakdown table, select either the first step in the pipeline view, the last step in the pipeline view, or select a discard step and then click on a discard reason. - -The breakdown table displays the following details: -- **Event type**: The Segment spec event type (Track call vs. Identify call, for example) -- **Event name**: The event name, provided by you or the source (*not available for inspection at all steps*) -- **App version**: The app/release version, provided by you or the source (*not available for inspection at all steps*) -- **Event count**: How many of each event either successfully made it through this pipeline step (in the case of the first or last steps in the pipeline view) or were filtered out (if you access it from a discard table) -- **% Change**: Insight into how the event counts differ from the last comparable time range as a percentage1 - -1: *Segment calculates the related change percentage by subtracting the percent of events impacted in the previous time period from the percent of impacted events in the current time period. For example, if last week 15% of your events were filtered at a source, but this week, 22% of your events were filtered at a source, you would have a related change percentage of 7%.* - -### Discard table -The discard table provides you with greater detail about the events that failed to deliver or were filtered out of your sources and destinations. - -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. - -The discard table displays the following details: - -- **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. -- **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*) -- **Event count**: How many of each event were discarded in this pipeline step -- **% Change**: Insight into how the event counts differ from the last comparable time range as a percentage1 - -1: *Segment calculates the related change percentage by subtracting the percent of events impacted in the previous time period from the percent of impacted events in the current time period. For example, if last week 15% of your events were filtered at a source, but this week, 22% of your events were filtered at a source, you would have a related change percentage of 7%.* - -## When should I use Delivery Overview? -Delivery Overview is useful to diagnose delivery errors in the following scenarios: -- **When setting up a destination, tracking plan, or filter for the first time**: With Delivery Overview, you can verify that the data you're sending to a new destination, a new tracking plan, or a new filter arrives in your destination as expected. -- **When data is missing from your destination**: The pipeline view can help you see where your data is getting "stuck" on the way to your destination, which can help you quickly diagnose and address problems in your data pipeline. -- **When emission or delivery volume fluctuates out of expected norms**: Delivery Overview will highlight where the largest rate change(s) occurred and what events were associated with the change. - -> info "Delivery Overview in Engage Destinations" -> Because Engage uses sources for multiple purposes, you can expect to see `filtered at destination` events with the integrations object in destinations linked to Engage. Engage uses the integrations object to route events to destinations you've added to your audiences, traits, and journey steps. As a result, some events aren't meant to be delivered by the destination, so the integrations object filters them. - -## Where do I find Delivery Overview? -To view the Delivery Overview page: -1. Sign into Segment. -2. From the homepage, navigate to **Connection** > **Destinations** and click on the destination you'd like to investigate. -3. Select the **Delivery Overview** tab from the destination header. - -## How do I use Delivery Overview? -To use Delivery Overview: - -1. Navigate to the destination you'd like to review, and select **Delivery Overview** from the destination header. -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.
___Optional___: *Turn the metric toggle off if you'd like to see the quantity of events as counts instead of percentages. Delivery Overview shows percentages by default.* -3. Select a success or discard step to view additional context about the events that passed through that step. - -## How does Delivery Overview differ from other Segment monitoring and observability tools? -With Source Debugger or Event Delivery, you can only verify that events are successfully making it from your source or to your destination. If events fail, you have to troubleshoot to see where in the pipeline your events are getting stuck. With Event Tester, you can verify that your event makes it from your source to your destination, but if the results aren't what you expected, you're stuck troubleshooting your source, filters, tracking plans, and destinations. - -With Delivery Overview, you can verify that your source receives your events, that any filters and tracking plans work as expected, and that events successfully make it to your destination. Any errors or unexpected behavior can be identified using the pipeline view, leading to quicker resolution. - -## How can I configure alerts? - -You can use the Event Delivery alerting features (Delivery Alerts) by selecting the **Alerts** tab in the destination header. Once you enable alerts, if the successful delivery rate of all events is less than the threshold percentage in the last 24 hours, you'll be notified through in-app notification and/or workspace email. - -Note that this is dependent on your [notification settings](/docs/segment-app/#segment-settings). For example, if the threshold is set to 99%, then you'll be notified each time less than 100% of events fail. - -You can also use [Connections Alerting](/docs/connections/alerting), a feature that allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection. - -Connections Alerting allows you to create two different alerts: -- **Source volume alerts**: These alerts notify you if your source ingests an abnormally small or large amount of data. For example, if you set a change percentage of 4%, you would be notified when your source ingests less than 96% or more than 104% of the typical event volume. -- **Successful delivery rate alerts**: These alerts notify you if your destination's successful delivery rate falls outside of a percentage that you set. For example, if you set a percentage of 99%, you would be notified if you destination had a successful delivery rate of 98% or below. - -## How "fresh" is the data in Delivery Overview? -The data in Delivery Overview has an expected latency of approximately 30 seconds after event ingestion, but this may vary, depending on the features you’ve enabled in your workspace and spikes in volume. Segment delays the data visible in the Delivery Overview UI by 5 minutes to allow for more precise metric correlation. Segment does not impose the 5 minute delay if you access data using the Public API. - -## Why is the Delivery Overview page only available for cloud-mode destinations? -Similar to Segment's [Event Delivery](/docs/connections/event-delivery/) feature, the Delivery Overview page is only available for server-side integrations (also known as cloud-mode destinations). You won't be able to use the Delivery Overview page for client side integrations (also known as device-mode destinations) because device-mode data is sent directly to the destination tool's API. In order to report on deliverability, data must be sent to destinations using a server-side connection. - -## Troubleshooting - -The Delivery Overview pipeline steps Failed on Ingest, Filtered at Source, Filtered at Destination, and Failed Delivery display a [discard table](#discard-table) with information about why your events failed or were discarded. - -This table provides a list of all possible discard reasons available at each pipeline step. - -{% include content/delivery-overview-discards.html %} - diff --git a/src/monitor/alerting/audience-alerting.md b/src/monitor/alerting/audience-alerting.md new file mode 100644 index 0000000000..d575a656d4 --- /dev/null +++ b/src/monitor/alerting/audience-alerting.md @@ -0,0 +1,36 @@ +--- +title: Audience Alerting +--- + +Create alerts related to the performance and throughput of Audience syncs and receive in-app, email, and Slack notifications when event volume fluctuations occur. + +To access Audience alerting, navigate to **Engage > Audiences**, select an Audience, and click the Alerts tab. + +On the Alerts tab, you can create new alerts and view all active alerts for this connection. You can only edit or delete the alerts that you create, unless you have the [Workspace Owner role](/docs/segment-app/iam/roles/). + +> info "Generate a Slack webhook to receive Slack notifications" +> To receive an alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see Slack's [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation. + +To access Audience alerting, navigate to **Engage \> Audiences**, select an Audience, and click the Alerts tab. + +On the Alerts tab, you can create new alerts and view all active alerts for this connection. You can only edit or delete the alerts that you create, unless you have the [Workspace Owner role](/docs/segment-app/iam/roles/). + +## Activation event health spikes or drops + +You can create an Activation event health spikes or drops alert that notifies you when events sent from your audience to a downstream destination have failures to a destination above a certain threshold. For example, if you set a change percentage of 4% and your destination received 100 events from your Audience over the first 24 hours, Segment would notify you the following day if your destination ingested fewer than 96 or more than 104 events. + +To create an Activation event health spikes or drops alert: + +1. From your Segment workspace's home page, navigate to **Engage \> Audiences**. +2. Select the Audience you want to create an alert for, select the Alerts tab, and click **Create alert**. +3. On the Create alert sidesheet, select the destination for which you'd like to monitor event health. +4. Enter a percentage of activation event health that you'd like to be notified for. +5. 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. +6. Click **Save**. + +To make changes to an Activation Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Edit**. + +To delete an Activation Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Delete**. \ No newline at end of file diff --git a/src/connections/alerting.md b/src/monitor/alerting/connections-alerting.md similarity index 90% rename from src/connections/alerting.md rename to src/monitor/alerting/connections-alerting.md index c838645131..59b73ae0d6 100644 --- a/src/connections/alerting.md +++ b/src/monitor/alerting/connections-alerting.md @@ -1,14 +1,16 @@ --- 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. +Connections Alerting allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of a Segment connection. -To access Connections Alerting, select an event-streaming connection (like a web library source or cloud mode destination) and click the **Alerts** tab. +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. +> info "Deleting alerts created by other users requires Workspace Owner role" +> All users can delete alerts that they created, but only those with [Workspace Owner role](/docs/segment-app/iam/roles/) can delete alerts created by other users. + ## 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. @@ -32,9 +34,6 @@ To make changes to a source volume alert, select the icon in the Actions column 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. @@ -55,7 +54,4 @@ To make changes to a successful delivery rate alert, select the icon in the Acti 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/connections/images/alerting-source-alert.png b/src/monitor/alerting/images/alerting-source-alert.png similarity index 100% rename from src/connections/images/alerting-source-alert.png rename to src/monitor/alerting/images/alerting-source-alert.png diff --git a/src/monitor/alerting/index.md b/src/monitor/alerting/index.md new file mode 100644 index 0000000000..f6d1c3a051 --- /dev/null +++ b/src/monitor/alerting/index.md @@ -0,0 +1,36 @@ +--- +title: Alerting +beta: true +--- + +Segment’s alerting capabilities allow you to receive in-app, email, or Slack notifications related to the performance and throughput of a Segment connection. The notification channels that you select for one alert will apply to all alerts in your workspace. + +> info "Deleting alerts created by other users requires Workspace Owner role" +> All users can delete alerts that they created, but only those with [Workspace Owner role](/docs/segment-app/iam/roles/) can delete alerts created by other users. + +
Segment currently supports the following alerting products: +
+
+ {% include components/reference-button.html + href="/docs/connections/reverse-etl/system" + title="Connections Alerting" + description="Monitor fluctuations in the quantity of events Segment ingests into your Sources and verify that Segment is sending an expected volume of events to your Destinations" + %} +
+ +
+ {% include components/reference-button.html + href="/docs/connections/reverse-etl/reverse-etl-catalog" + title="Reverse ETL Alerting" + description="Receive notifications for failed or partially successful syncs and verify your mappings are producing an expected level of events" + %} +
+ +
+ {% include components/reference-button.html + href="/docs/connections/reverse-etl/faq" + title="Audience Alerting" + description="Monitor fluctuations in event volume sent from your Audiences downstream to your destinations" + %} +
+
\ No newline at end of file diff --git a/src/monitor/alerting/retl-alerting.md b/src/monitor/alerting/retl-alerting.md new file mode 100644 index 0000000000..3666b49004 --- /dev/null +++ b/src/monitor/alerting/retl-alerting.md @@ -0,0 +1,47 @@ +--- +title: Reverse ETL Alerting +--- + +You can opt in to receive email, Slack, and in-app alerts about Reverse ETL sync failures and fluctuations in the volume of events successfully delivered to your mapping. + +The notification channels that you select for one alert will apply to all alerts in your workspace. + +> info "Deleting alerts created by other users requires Workspace Owner role" +> All users can delete alerts that they created, but only those with [Workspace Owner role](/docs/segment-app/iam/roles/) can delete alerts created by other users. + +### Failed or partially successful syncs + +To subscribe to alerts for a failed or partially successful sync: + +1. Navigate to **Settings > User Preferences**. +2. Select **Reverse ETL** in the **Activity Notifications** section. +3. Click the Reverse ETL sync status that you'd like to receive notifications for. You can select one or more of the following sync statuses: + - **Reverse ETL sync failed**: Receive a notification when your Reverse ETL sync fails. + - **Reverse ETL sync partial success**: Receive a notification when your Reverse ETL sync is partially successful. +4. Select one or more of the following alert options: + - **Enable email notifications**: Enter an email address or alias that should receive alerts. + - **Enable Slack notifications**: Enter a webhook URL and Slack channel name. + - **Enable in-app notifications**: Select this option to see an in-app notification. +5. Click **Create alert**. + +> success "" +> If you opted to receive notifications by email, you can click **View active email addresses** to see the email addresses that are currently signed up to receive notifications. + +### Mapping-level successful delivery rate fluctuations + +You can create an alert that notifies you when the volume of events successfully received by your mapping 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 fluctuation alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see Slack's [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation. + +To subscribe to alerts for successful delivery fluctuations at the mapping level: + +1. Navigate to your intended mapping and select the **Alerts** tab. +2. Click **Create alert**. +3. Set an *alert threshold*, or the percentage of successfully delivered events that would prompt an alert. +4. Select one or more of the following notification channels: + - **Email**: Enter an email address or alias that should receive alerts. + - **Slack notification**: Enter a Webhook URL and a Slack channel name to receive alerts in a Slack channel. + - **In-app notifications**: 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. Toggle the **Enable alert** setting on and click **Create**. + +To edit or disable your alert, navigate to your mapping's Alerts tab and select the Actions menu for the alert you'd like to edit. \ No newline at end of file diff --git a/src/segment-app/iam/audit-trail.md b/src/monitor/audit-trail.md similarity index 95% rename from src/segment-app/iam/audit-trail.md rename to src/monitor/audit-trail.md index 15711ed862..754c245aae 100644 --- a/src/segment-app/iam/audit-trail.md +++ b/src/monitor/audit-trail.md @@ -15,6 +15,9 @@ To view the Audit Trail: 1. From the Segment app, select **Settings**. 2. From the Settings tab, select **Admin**. +> success "" +> HIPAA-eligible workspaces have additional audit information available upon request. For more information, see the [HIPAA Eligible Segment](/docs/privacy/hipaa-eligible-segment/#hipaa-auditing) documentation. + ## Audit Trail events The Audit Trail returns information about the following Segment product areas: diff --git a/src/monitor/delivery-overview/delivery-overview-actions-destinations.md b/src/monitor/delivery-overview/delivery-overview-actions-destinations.md new file mode 100644 index 0000000000..6acd72da4d --- /dev/null +++ b/src/monitor/delivery-overview/delivery-overview-actions-destinations.md @@ -0,0 +1,28 @@ +--- +title: Delivery Overview for Actions Destinations +--- + +Delivery Overview is a visual observability tool designed to help Segment users diagnose event delivery issues for any [Actions destinations](/docs/connections/destinations/actions/) receiving events from cloud-streaming sources. + +Delivery Overview has three core features: + +- [Pipeline view](#pipeline-view): A visual overview of each step your data takes during the delivery process \- from when your source receives audience events to when events are successfully delivered to your connected destination. +- [Breakdown table](/docs/monitoring/delivery-overview): If you select a step in the pipeline view, you can see more detail about the events that were processed at each pipeline step. +- [Discard table](/docs/monitoring/delivery-overview): If you select an event in a breakdown table, you can see more details about the events that failed or were filtered out of your process and allows you to inspect samples of them. + +For more information about the breakdown and discard tables, see the [Delivery Overview](/docs/monitoring/delivery-overview) documentation. + +## Pipeline view + +The pipeline view for Actions destination includes the following steps: + +![A screenshot of the pipeline view for an Actions destination, with 1.17 million events successfully received by a source, and 3.03 million events successfully synced to a destination](/docs/monitor/delivery-overview/images/delivery-overview-storage-destinations.jpeg) + +- **Successfully received**: Events that Segment ingested from your source. You can filter these events by event type, event name, app version, and [enrichment status](/docs/unify/data-graph/linked-events/). +- **Failed on ingest**: Events that Segment received, but were dropped due to internal data validation rules. +- **Filtered at source**: Events that were discarded due to schema settings or [Protocols](/docs/protocols/) Tracking Plans. +- **Mapping dropdown**: Select a [mapping](/docs/connections/destinations/actions/#customize-mappings) to filter the events in the Filtered at destination, Failed delivery and Successful delivery pipeline steps. +- **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). 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. +- **Retry count**: The number of events currently pending retry. +- **Failed delivery**: Events that have been discarded due to errors or unmet destination requirements. +- **Successful delivery**: Events that were successfully delivered to the destination. \ No newline at end of file diff --git a/src/monitor/delivery-overview/delivery-overview-audiences.md b/src/monitor/delivery-overview/delivery-overview-audiences.md new file mode 100644 index 0000000000..d1eab4a8c2 --- /dev/null +++ b/src/monitor/delivery-overview/delivery-overview-audiences.md @@ -0,0 +1,38 @@ +--- +title: Delivery Overview for Audiences +--- + +Delivery Overview is a visual observability tool designed to help Segment users diagnose event delivery issues for any event-streaming destination receiving events from Engage Audiences. + +Delivery Overview has three core features: + +- [Pipeline view](#pipeline-view): A visual overview of each step your data takes during the delivery process \- from when your source receives audience events to when events are successfully delivered to your connected destination. +- [Breakdown table](/docs/monitoring/delivery-overview#breakdown-table): If you select a step in the pipeline view, you can see more detail about the events that were processed at each pipeline step. +- [Discard table](/docs/monitoring/delivery-overview#breakdown-table): If you select an event in a breakdown table, you can see more details about the events that failed or were filtered out of your process and allows you to inspect samples of them. + +For more information about the breakdown and discard tables, see the [Delivery Overview](/docs/monitoring/delivery-overview) documentation. + +To view Delivery Overview for an Audience: +1. From your Segment workspace's home page, navigate to **Engage > Audiences**. +2. Find an Audience, click the **(...)** menu, and select Delivery Overview. +3. On the Delivery Overview page, select the Audience dropdown to filter by a specific Audience, select the Date range dropdown to filter by a specific time period, or toggle the Show metrics as percentages toggle on to view your metrics as percentages. + +By default, Segment displays Delivery Overview information for all Audiences connected to your destination. You can filter your Delivery Overview pipeline view by an individual Audience for more granular data. + +You can also further refine the data displayed on the pipeline view using the time picker and the metric toggle, located under the destination header. With the time picker, you can specify a time period (last 10 minutes, 1 hour, 24 hours, 7 days, 2 weeks, or a custom date range over the last two weeks) for which you’d like to see data. With the metric toggle, you can switch between seeing metrics represented as percentages (for example, *85% of events* or *an 133% increase in events*) or as counts (*13 events* or *an increase of 145 events*.) Delivery Overview shows percentages by default. + +> info "Linked Audiences have additional filtering functionality" +> Linked Audiences users can filter the Delivery Overview event pipeline by [Linked Audience events](/docs/engage/audiences/linked-audiences/#step-2c-define-how-and-when-to-trigger-an-event-to-your-destination). For more information, see the [Linked Audiences](/docs/engage/audiences/linked-audiences/#delivery-overview-for-linked-audiences) documentation. + +## Pipeline view + +Audiences have the following steps in the pipeline view: + +- **Events from audience***: Events that Segment created for your activation. The number of events for each compute depends on the changes detected in your audience membership. +- **Filtered at source**: Events discarded by Protocols: either by the [schema settings](/docs/protocols/enforce/schema-configuration/) or [Tracking Plans](/docs/protocols/tracking-plan/create/). +- **Filtered at destination**: If any events aren’t eligible to be sent (for example, due to destination filters, insert function logic, and so on), Segment displays them at this step. +- **Events pending retry**: A step that reveals the number of events that are awaiting retry. Unlike the other steps, you cannot click into this step to view the breakdown table. +- **Failed delivery**: Events that Segment *attempted* to deliver to your destination, but that ultimately *failed* to be delivered. Failed delivery might indicate an issue with the destination, like invalid credentials, rate limits, or other error statuses received during delivery. +- **Successful delivery**: Events that Segment successfully delivered to your destination. You’ll see these events in your downstream integrations. + +*_The "Events from audience" step is currently only available for Linked Audiences._ \ No newline at end of file diff --git a/src/monitor/delivery-overview/delivery-overview-classic-destinations.md b/src/monitor/delivery-overview/delivery-overview-classic-destinations.md new file mode 100644 index 0000000000..1142291c3a --- /dev/null +++ b/src/monitor/delivery-overview/delivery-overview-classic-destinations.md @@ -0,0 +1,24 @@ +--- +title: Delivery Overview for Classic Destinations +--- + +Delivery Overview is a visual observability tool designed to help Segment users diagnose event delivery issues for any classic destination receiving events from cloud-streaming sources. + +Delivery Overview has three core features: + +- [Pipeline view](#pipeline-view): A visual overview of each step your data takes during the delivery process - from when your source receives audience events to when events are successfully delivered to your connected destination. +- [Breakdown table](/docs/monitoring/delivery-overview#breakdown-table): If you select a step in the pipeline view, you can see more detail about the events that were processed at each pipeline step. +- [Discard table](/docs/monitoring/delivery-overview#discard-table): If you select an event in a breakdown table, you can see more details about the events that failed or were filtered out of your process and allows you to inspect samples of them. + +For more information about the breakdown and discard tables, see the [Delivery Overview](/docs/monitoring/delivery-overview/) documentation. + +## Pipeline view + +The pipeline view for classic destinations includes the following steps: + +- **Successfully received**: Events that Segment ingested from your source. +- **Failed on ingest**: Events that Segment received, but were dropped due to internal data validation rules. +- **Filtered at source**: Events that were discarded due to schema settings or [Protocols](/docs/protocols/) Tracking Plans. +- **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). [Consent Management](/docs/privacy/consent-management/) users also see events discarded due to consent preferences. +- **Failed delivery**: Events that have been discarded due to errors or unmet destination requirements. +- **Successful delivery**: Events that were successfully delivered to the destination. \ No newline at end of file diff --git a/src/monitor/delivery-overview/delivery-overview-for-storage.md b/src/monitor/delivery-overview/delivery-overview-for-storage.md new file mode 100644 index 0000000000..bad5b7e406 --- /dev/null +++ b/src/monitor/delivery-overview/delivery-overview-for-storage.md @@ -0,0 +1,27 @@ +--- +title: Delivery Overview for Storage Destinations +--- + +Delivery Overview is a visual observability tool designed to help Segment users diagnose event delivery issues for any storage destination receiving events from cloud-streaming sources. + +Delivery Overview has three core features: + +- [Pipeline view](#pipeline-view): A visual overview of each step your data takes during the delivery process \- from when your source receives audience events to when events are successfully delivered to your connected destination. +- [Breakdown table](/docs/monitoring/delivery-overview#breakdown-table): If you select a step in the pipeline view, you can see more detail about the events that were processed at each pipeline step. +- [Discard table](/docs/monitoring/delivery-overview#discard-table): If you select an event in a breakdown table, you can see more details about the events that failed or were filtered out of your process and allows you to inspect samples of them. + +For more information about the breakdown and discard tables, see the [Delivery Overview](/docs/monitoring/delivery-overview) documentation. + +## Pipeline view + +The pipeline view for storage destinations includes the following steps: + +![A screenshot of the pipeline view for an storage destination, with 734,000 events successfully received by a source, and 217,000 events successfully delivered to a destination](/docs/monitor/delivery-overview/images/delivery-overview-actions-destination.jpeg) + +- **Successfully received**: Events that Segment ingested from your source. +- **Failed on ingest**: Events that Segment received, but were dropped due to internal data validation rules. +- **Filtered at source**: Events that were discarded due to schema settings or [Protocols](/docs/protocols/) Tracking Plans. +- **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). [Consent Management](/docs/privacy/consent-management/) users also see events discarded due to consent preferences. +- **Events to warehouse rows**: A read-only box that shows the point in the delivery process where Segment converts events into warehouse rows. +- **Failed to sync**: Syncs that either failed to sync or were partially successful. Selecting this step takes you to a table of all syncs with one or more failed collections. Select a sync from the table to view the discard reason, any collections that failed, the status, and the number of rows that synced for each collection. For information about common errors, see Ware +- **Successfully synced**: A record of all successful or partially successful syncs made with your destination. To view the reason a partially successfully sync was not fully successful, see the Failed to sync step. \ No newline at end of file diff --git a/src/connections/images/delivery-overview-actions-destination.jpeg b/src/monitor/delivery-overview/images/delivery-overview-actions-destination.jpeg similarity index 100% rename from src/connections/images/delivery-overview-actions-destination.jpeg rename to src/monitor/delivery-overview/images/delivery-overview-actions-destination.jpeg diff --git a/src/connections/images/delivery-overview-storage-destinations.png b/src/monitor/delivery-overview/images/delivery-overview-storage-destinations.png similarity index 100% rename from src/connections/images/delivery-overview-storage-destinations.png rename to src/monitor/delivery-overview/images/delivery-overview-storage-destinations.png diff --git a/src/monitor/delivery-overview/index.md b/src/monitor/delivery-overview/index.md new file mode 100644 index 0000000000..78b19d86b6 --- /dev/null +++ b/src/monitor/delivery-overview/index.md @@ -0,0 +1,108 @@ +--- +title: Delivery Overview +--- + +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. + +Use Delivery Overview to diagnose delivery errors in the following scenarios: + +- **When setting up a destination, tracking plan, or filter for the first time**: With Delivery Overview, you can verify that the data you're sending to a new destination, a new tracking plan, or a new filter arrives in your destination as expected. +- **When data is missing from your destination**: The pipeline view can help you see where your data is getting "stuck" on the way to your destination, which can help you quickly diagnose and address problems in your data pipeline. +- **When emission or delivery volume fluctuates out of expected norms**: Delivery Overview will highlight where the largest rate change(s) occurred and what events were associated with the change. + +> info "Delivery Overview in Engage Destinations" +> Because Engage uses sources for multiple purposes, you can expect to see `filtered at destination` events with the integrations object in destinations linked to Engage. Engage uses the integrations object to route events to destinations you've added to your audiences, traits, and journey steps. As a result, some events aren't meant to be delivered by the destination, so the integrations object filters them. + + +Delivery Overview supports the following Segment products: + +* [Classic Destinations](/monitor/delivery-overview/delivery-overview-classic-destinations) +* [Actions Destinations](/monitor/delivery-overview/delivery-overview-actions-destinations) +* [Storage Destinations](/monitor/delivery-overview/delivery-overview-for-storage) +* [Audiences Destinations](/monitor/delivery-overview/delivery-overview-audiences) + +## Key features + +Delivery Overview has three core features: + +- [Pipeline view](#pipeline-view): a visual overview of each step your data takes during the delivery process. These steps vary by destination type, as different Segment destinations have different delivery processeses. +- [Breakdown table](#breakdown-table): contains more detail about the events that were processed at each pipeline step +- [Discard table](#discard-table): contains details about the events that failed or were filtered out of your process and allows you to inspect samples of them + +You can refine these tables using the time picker and the metric toggle, located under the destination header. With the time picker, you can specify a time period (last 10 minutes, 1 hour, 24 hours, 7 days, 2 weeks, or a custom date range over the last two weeks) for which you'd like to see data. With the metric toggle, you can switch between seeing metrics represented as percentages (for example, *85% of events* or *a 133% increase in events*) or as counts (*13 events* or *an increase of 145 events*.) Delivery Overview shows percentages by default. + +### Pipeline view + +The pipeline view provides insights into each step your data is processed by enroute to the destination, with an emphasis on the steps where data can be discarded due to errors or your filter preferences. Each step provides details into counts, change rates, and event details (like the associated Event Type or Event Names), and the discard steps (Failed on ingest, Filtered at source, Filtered at destination, & Failed delivery) provide you with the reasons events were dropped before reaching the destination. Discard steps also include how to control or alter that outcome, when possible. The pipeline view also includes a label between the Filtered at destination and Failed delivery steps indicating how many events are currently pending retry. + +> info "Lookback window" +> Delivery Overview applies a 5-minute lookback period to provide stable, accurate metrics across all pipeline steps. This interval accounts for processing delays and ensures the data Segment displays reflects a reliable snapshot of recent events. + +### Breakdown table + +The breakdown table provides you with greater detail about the selected events. + +To open the breakdown table, select either the first step in the pipeline view, the last step in the pipeline view, or select a discard step and then click on a discard reason. + +The breakdown table displays the following details: + +- **Event type**: The Segment spec event type (Track call vs. Identify call, for example) +- **Event name**: The event name, provided by you or the source (*not available for inspection at all steps*) +- **App version**: The app/release version, provided by you or the source (*not available for inspection at all steps*) +- **Event count**: How many of each event either successfully made it through this pipeline step (in the case of the first or last steps in the pipeline view) or were filtered out (if you access it from a discard table) +- **% Change**: Insight into how the event counts differ from the last comparable time range as a percentage1 + +1: *Segment calculates the related change percentage by subtracting the percent of events impacted in the previous time period from the percent of impacted events in the current time period. For example, if last week 15% of your events were filtered at a source, but this week, 22% of your events were filtered at a source, you would have a related change percentage of 7%.* + +### Discard table + +The discard table provides you with greater detail about the events that failed to deliver or were filtered out of your sources and destinations. + +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. + +The discard table displays the following details: + +- **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. +- **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*) +- **Event count**: How many of each event were discarded in this pipeline step +- **% Change**: Insight into how the event counts differ from the last comparable time range as a percentage1 + +1: *Segment calculates the related change percentage by subtracting the percent of events impacted in the previous time period from the percent of impacted events in the current time period. For example, if last week 15% of your events were filtered at a source, but this week, 22% of your events were filtered at a source, you would have a related change percentage of 7%.* + +## Frequently asked questions + +### How does Delivery Overview differ from other Segment monitoring and observability tools? + +With Source Debugger or Event Delivery, you can only verify that events are successfully making it from your source or to your destination. If events fail, you have to troubleshoot to see where in the pipeline your events are getting stuck. With Event Tester, you can verify that your event makes it from your source to your destination, but if the results aren't what you expected, you're stuck troubleshooting your source, filters, tracking plans, and destinations. + +With Delivery Overview, you can verify that your source receives your events, that any filters and tracking plans work as expected, and that events successfully make it to your destination. Any errors or unexpected behavior can be identified using the pipeline view, leading to quicker resolution. + +### How can I configure alerts? + +You can use the Event Delivery alerting features (Delivery Alerts) by selecting the **Alerts** tab in the destination header. Once you enable alerts, if the successful delivery rate of all events is less than the threshold percentage in the last 24 hours, you'll be notified through in-app notification and/or workspace email. + +Note that this is dependent on your [notification settings](/docs/segment-app/#segment-settings). For example, if the threshold is set to 99%, then you'll be notified each time less than 100% of events fail. + +You can also use [Connections Alerting](/docs/connections/alerting), a feature that allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection. + +Connections Alerting allows you to create two different alerts: + +- **Source volume alerts**: These alerts notify you if your source ingests an abnormally small or large amount of data. For example, if you set a change percentage of 4%, you would be notified when your source ingests less than 96% or more than 104% of the typical event volume. +- **Successful delivery rate alerts**: These alerts notify you if your destination's successful delivery rate falls outside of a percentage that you set. For example, if you set a percentage of 99%, you would be notified if you destination had a successful delivery rate of 98% or below. + +### How "fresh" is the data in Delivery Overview? + +The data in Delivery Overview has an expected latency of approximately 30 seconds after event ingestion, but this may vary, depending on the features you’ve enabled in your workspace and spikes in volume. Segment delays the data visible in the Delivery Overview UI by 5 minutes to allow for more precise metric correlation. Segment does not impose the 5 minute delay if you access data using the Public API. + +### Why is the Delivery Overview page only available for cloud-mode destinations? + +Similar to Segment's [Event Delivery](/docs/connections/event-delivery/) feature, the Delivery Overview page is only available for server-side integrations (also known as cloud-mode destinations). You won't be able to use the Delivery Overview page for client side integrations (also known as device-mode destinations) because device-mode data is sent directly to the destination tool's API. In order to report on deliverability, data must be sent to destinations using a server-side connection. + +## Troubleshooting + +The Delivery Overview pipeline steps Failed on Ingest, Filtered at Source, Filtered at Destination, and Failed Delivery display a [discard table](#discard-table) with information about why your events failed or were discarded. + +This table provides a list of all possible discard reasons available at each pipeline step. + +{% include content/delivery-overview-discards.html %} + diff --git a/src/monitor/index.md b/src/monitor/index.md new file mode 100644 index 0000000000..60928be345 --- /dev/null +++ b/src/monitor/index.md @@ -0,0 +1,39 @@ +--- +title: Monitor +--- + +With Segment’s observability, 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. + +Use [Delivery Overview](/docs/monitor/delivery-overview/), Segment’s observability framework, to verify events and profiles are flowing as expected to your downstream destinations and diagnose issues that might be present at each step of 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](/docs/monitor/alerting/). + +Segment’s [Audit Trail](/docs/monitor/audit-trail) provides a high-level view of all changes made in your workspace over the last 90 days. Use [Audit Forwarding](/docs/monitor/audit-trail#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/alerting" + title="Alerting" + 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/delivery-overview" + title="Delivery Overview" + description="Segment's observability framework and the accompanying visual pipeline view support cloud-streaming destinations." + %} +
+ +
+ {% include components/reference-button.html + href="/docs/monitor/audit-trail" + title="Audit Trail" + description="View, filter, and export the last 90 days of user and system activity." + %} +
+
\ No newline at end of file