Skip to content

Commit e1b91d9

Browse files
forstisabellaforstisabella
committed
first pass
1 parent 20606d6 commit e1b91d9

14 files changed

+401
-149
lines changed

‎src/_data/sidenav/main.yml

+30
Original file line numberDiff line numberDiff line change
@@ -311,6 +311,36 @@ sections:
311311
title: OAuth 2.0
312312
- path: /connections/aws-privatelink
313313
title: AWS PrivateLink Integration
314+
315+
- section_title: Monitor
316+
section:
317+
- path: /monitor
318+
title: Monitor Overview
319+
- path: /monitor/audit-trail
320+
title: Audit Trail
321+
- section_title: Alerting
322+
section:
323+
- path: /monitor/alerting
324+
title: Alerting Overview
325+
- path: /monitor/alerting/audience-alerting
326+
title: Audience Alerting
327+
- path: /monitor/alerting/connections-alerting
328+
title: Connections Alerting
329+
- path: /monitor/alerting/retl-alerting
330+
title: Reverse ETL Alerting
331+
- section_title: Delivery Overview
332+
section:
333+
- path: /monitor/delivery-overview
334+
title: Delivery Overview
335+
- path: /monitor/delivery-overview/delivery-overview-classic-destinations
336+
title: Delivery Overview for Classic Destinations
337+
- path: /monitor/delivery-overview/delivery-overview-actions-destinations
338+
title: Delivery Overview for Actions Destinations
339+
- path: /monitor/delivery-overview/delivery-overview-for-storage
340+
title: Delivery Overview for Storage Destinations
341+
- path: /monitor/delivery-overview/delivery-overview-audiences
342+
title: Delivery Overview for Audiences
343+
314344
- section_title: Unify
315345
section:
316346
- path: /unify

‎src/_includes/icons/monitor.svg

+3
Loading

‎src/connections/delivery-overview.md

-146
This file was deleted.

‎src/monitor/alerting/audience-alerting.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Audience Alerting
3+
---
4+
5+
Create alerts related to the performance and throughput of Audience syncs and receive in-app, email, and Slack notifications when event volume fluctuations occur.
6+
7+
To access Audience alerting, navigate to **Engage > Audiences**, select an Audience, and click the Alerts tab.
8+
9+
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/).
10+
11+
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.
12+
13+
To access Audience alerting, navigate to **Engage \> Audiences**, select an Audience, and click the Alerts tab.
14+
15+
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/).
16+
17+
## Activation event health spikes or drops
18+
19+
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.
20+
21+
To create an Activation event health spikes or drops alert:
22+
23+
1. From your Segment workspace's home page, navigate to **Engage \> Audiences**.
24+
2. Select the Audience you want to create an alert for, select the Alerts tab, and click **Create alert**.
25+
3. On the Create alert sidesheet, select the destination for which you'd like to monitor event health.
26+
4. Enter a percentage of activation event health that you'd like to be notified for.
27+
5. Select one or more of the following alert channels:
28+
- **Email**: Select this to receive notifications at the provided email address.
29+
- **Slack**: Select this to send alerts to one or more channels in your workspace.
30+
- **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.
31+
6. Click **Save**.
32+
33+
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**.
34+
35+
To delete an Activation Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Delete**.

‎src/connections/alerting.md renamed to ‎src/monitor/alerting/connections-alerting.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
---
22
title: Connections Alerting
3-
beta: true
43
---
54

6-
Connections Alerting allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection.
5+
Connections Alerting allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of a Segment connection.
76

8-
To access Connections Alerting, select an event-streaming connection (like a web library source or cloud mode destination) and click the **Alerts** tab.
7+
To access Connections Alerting, select an event-streaming connection (like a web library source or cloud mode destination) and click the **Alerts** tab.
98

109
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.
1110

11+
> info "Deleting alerts created by other users requires Workspace Owner role"
12+
> All users can delete alerts that they created, but only those with [Workspace Owner role](http:///docs/segment-app/iam/roles/) can delete alerts created by other users.
13+
1214
## Source volume alerts
1315

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

‎src/monitor/alerting/index.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Alerting
3+
beta: true
4+
---
5+
6+
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.
7+
8+
> info "Deleting alerts created by other users requires Workspace Owner role"
9+
> 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.
10+
11+
<br>Segment currently supports the following alerting products:
12+
<div class="flex flex--wrap gutter gutter--large">
13+
<div class="flex__column flex__column--12 flex__column--4@medium">
14+
{% include components/reference-button.html
15+
href="/docs/connections/reverse-etl/system"
16+
title="Connections Alerting"
17+
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"
18+
%}
19+
</div>
20+
21+
<div class="flex__column flex__column--12 flex__column--4@medium">
22+
{% include components/reference-button.html
23+
href="/docs/connections/reverse-etl/reverse-etl-catalog"
24+
title="Reverse ETL Alerting"
25+
description="Receive notifications for failed or partially successful syncs and verify your mappings are producing an expected level of events"
26+
%}
27+
</div>
28+
29+
<div class="flex__column flex__column--12 flex__column--4@medium">
30+
{% include components/reference-button.html
31+
href="/docs/connections/reverse-etl/faq"
32+
title="Audience Alerting"
33+
description="Monitor the fluctuations in event volume sent from your Audiences downstream to your destinations"
34+
%}
35+
</div>
36+
</div>

‎src/monitor/alerting/retl-alerting.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Reverse ETL Alerting
3+
---
4+
5+
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.
6+
7+
The notification channels that you select for one alert will apply to all alerts in your workspace.
8+
9+
> info "Deleting alerts created by other users requires Workspace Owner role"
10+
> All users can delete alerts that they created, but only those with [Workspace Owner role](http:///docs/segment-app/iam/roles/) can delete alerts created by other users.
11+
12+
### Failed or partially successful syncs
13+
14+
To subscribe to alerts for a failed or partially successful sync:
15+
16+
1. Navigate to **Settings \> User Preferences**.
17+
2. Select **Reverse ETL** in the **Activity Notifications** section.
18+
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:
19+
- **Reverse ETL sync failed**: Receive a notification when your Reverse ETL sync fails.
20+
- **Reverse ETL sync partial success**: Receive a notification when your Reverse ETL sync is partially successful.
21+
4. Select one or more of the following alert options:
22+
- **Enable email notifications**: Enter an email address or alias that should receive alerts.
23+
- **Enable Slack notifications**: Enter a webhook URL and Slack channel name.
24+
- **Enable in-app notifications**: Select this option to see an in-app notification.
25+
5. Click **Create alert**.
26+
27+
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.
28+
29+
### Mapping-level successful delivery rate fluctuations
30+
31+
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.
32+
33+
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.
34+
35+
To subscribe to alerts for successful delivery fluctuations at the mapping level:
36+
37+
1. Navigate to your intended mapping and select the **Alerts** tab.
38+
2. Click **Create alert**.
39+
3. Set an *alert threshold*, or the percentage of successfully delivered events that would prompt an alert.
40+
4. Select one or more of the following notification channels:
41+
- **Email**: Enter an email address or alias that should receive alerts.
42+
- **Slack notification**: Enter a Webhook URL and a Slack channel name to receive alerts in a Slack channel.
43+
- **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.
44+
5. Toggle the **Enable alert** setting on and click **Create**.
45+
46+
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.

‎src/segment-app/iam/audit-trail.md renamed to ‎src/monitor/audit-trail.md

File renamed without changes.

‎src/monitor/delivery-overview/delivery-overview-actions-destinations.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Delivery Overview for Actions Destinations
3+
---
4+
5+
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.
6+
7+
Delivery Overview has three core features:
8+
9+
- [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.
10+
- [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.
11+
- [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.
12+
13+
For more information about the breakdown and discard tables, see the [Delivery Overview](/docs/monitoring/delivery-overview) documentation.
14+
15+
## Pipeline view
16+
The pipeline view for Actions destination includes the following steps:
17+
- **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/).
18+
- **Failed on ingest**: Events that Segment received, but were dropped due to internal data validation rules.
19+
- **Filtered at source**: Events that were discarded due to schema settings or [Protocols](/docs/protocols/) Tracking Plans.
20+
- **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.
21+
- **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.
22+
- **Retry count**: The number of events currently pending retry.
23+
- **Failed delivery**: Events that have been discarded due to errors or unmet destination requirements.
24+
- **Successful delivery**: Events that were successfully delivered to the destination.

‎src/monitor/delivery-overview/delivery-overview-audiences.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Delivery Overview for Audiences
3+
---
4+
5+
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.
6+
7+
Delivery Overview has three core features:
8+
9+
- [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.
10+
- [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.
11+
- [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.
12+
13+
For more information about the breakdown and discard tables, see the [Delivery Overview](/docs/monitoring/delivery-overview) documentation.
14+
15+
To view Delivery Overview for an Audience:
16+
1. From your Segment workspace's home page, navigate to **Engage > Audiences**.
17+
2. Find an Audience, click the **(...)** menu, and select Delivery Overview.
18+
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.
19+
20+
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.
21+
22+
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.
23+
24+
> info "Linked Audiences have additional filtering functionality"
25+
> 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.
26+
27+
Audiences have the following steps in the pipeline view:
28+
29+
- **Events from audience**<sup>*</sup>: Events that Segment created for your activation. The number of events for each compute depends on the changes detected in your audience membership.
30+
- **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/).
31+
- **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.
32+
- **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.
33+
- **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.
34+
- **Successful delivery**: Events that Segment successfully delivered to your destination. You’ll see these events in your downstream integrations.
35+
36+
<sup>*</sup>_The "Events from audience" step is currently only available for Linked Audiences._

0 commit comments

Comments
 (0)