Skip to content

Commit

Permalink
[netlify-build]
Browse files Browse the repository at this point in the history
  • Loading branch information
forstisabella committed Jan 8, 2025
1 parent 9c894e3 commit 0e90c24
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 12 deletions.
11 changes: 3 additions & 8 deletions src/connections/delivery-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,6 @@ 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:
Expand Down Expand Up @@ -65,13 +58,15 @@ The following image shows a storage destination with 23 partially successful syn

#### Destinations connected to Audiences
Destinations connected to an Audience 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.
- **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.
- **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.

<sup>*</sup>_The "Events from audience" step is currently only available for Linked Audiences._

### Breakdown table
The breakdown table provides you with greater detail about the selected events.

Expand Down
11 changes: 7 additions & 4 deletions src/engage/audiences/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,8 +217,9 @@ Delivery Overview has three core features:
For more information about the breakdown and discard tables, see the [Delivery Overview](/docs/connections/delivery-overview/) documentation.

To view Delivery Overview for an Audience:
1. From your Segment workspace's home page, navigate to **Connections > Destinations**.
2. Select the Destination connected to your Audience and select the Delivery Overview tab.
To filter by events:
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.

#### Steps in the pipeline view
Expand All @@ -228,16 +229,18 @@ By default, Segment displays Delivery Overview information for all Audiences con
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 also filter the Delivery Overview event pipeline by [event emitters](/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.
> 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.
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.
- **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.
- **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.

<sup>*</sup>_The "Events from audience" step is currently only available for Linked Audiences._

### 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.
Expand Down

0 comments on commit 0e90c24

Please sign in to comment.