Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proof of concept: Monitor tab #7378

Draft
wants to merge 5 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions src/_data/sidenav/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions src/_includes/icons/monitor.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
146 changes: 0 additions & 146 deletions src/connections/delivery-overview.md

This file was deleted.

36 changes: 36 additions & 0 deletions src/monitor/alerting/audience-alerting.md
Original file line number Diff line number Diff line change
@@ -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**.
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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.
Expand All @@ -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).
36 changes: 36 additions & 0 deletions src/monitor/alerting/index.md
Original file line number Diff line number Diff line change
@@ -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.

<br>Segment currently supports the following alerting products:
<div class="flex flex--wrap gutter gutter--large">
<div class="flex__column flex__column--12 flex__column--4@medium">
{% 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"
%}
</div>

<div class="flex__column flex__column--12 flex__column--4@medium">
{% 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"
%}
</div>

<div class="flex__column flex__column--12 flex__column--4@medium">
{% 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"
%}
</div>
</div>
47 changes: 47 additions & 0 deletions src/monitor/alerting/retl-alerting.md
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Loading