From 69d6784750d97e467163c2b5e85ee7be198482fc Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Fri, 16 Aug 2024 18:38:24 -0400 Subject: [PATCH 1/6] Delivery Overview for Linked --- src/connections/delivery-overview.md | 19 +++++++++++++++++-- src/engage/audiences/linked-audiences.md | 2 ++ 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/src/connections/delivery-overview.md b/src/connections/delivery-overview.md index 8bfde19626..05f179f0a9 100644 --- a/src/connections/delivery-overview.md +++ b/src/connections/delivery-overview.md @@ -21,7 +21,13 @@ Delivery Overview has three core features: 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. +The pipeline view provides insights into each step that your data takes enroute to the destination, with additional information available for each 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 (for example, Failed on ingest, Filtered at source, Filtered at destination, and 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. + +Each of the following integrations has a slightly different pipeline view to account for differences in the data processing journey (process?): +- [Classic destinations](#classic-destinations): Destinations built with Segment's classic framework. Examples include ABC, DEF, and XYZ. +- [Actions destinations](#actions-destinations): Destinations built with Segment's new Destination Actions framework. Examples include ABC, DEF, and XYZ. +- [Storage destinations](#storage-destinations): Warehouse and blob storage destinations. Examples include ABC, DEF, LMNOP. +- [Linked Audiences](#linked-audiences): Any #### Classic destinations The pipeline view for classic destinations includes the following steps: @@ -54,13 +60,22 @@ The pipeline view for storage destination includes the following steps: - **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 +- **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 common warehouse errors and associated troubleshooting information, see the [Warehouse errors](/docs/connections/storage/warehouses/warehouse-errors/) documentation. - **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) +#### Linked Audiences +Delivery Overview for Linked Audiences includes a toggle view above the data pipeline so you can narrow the results to one Linked Audience and one or more [activations](/docs/engage/audiences/linked-audiences/#step-2c-define-how-and-when-to-trigger-an-event-to-your-destination). + +The pipeline view for Linked Audiences includes the following steps: +- **Events from Audience**: Audience events Segment received from a connected source. +- **Filtered at destination**: Events that Segment 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 are 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**: The events that Segment rejected due to a destination error or internal validation. +- **Successful delivery**: Events that Segment successfully delivered to the connected destination. + ### Breakdown table The breakdown table provides you with greater detail about the selected events. diff --git a/src/engage/audiences/linked-audiences.md b/src/engage/audiences/linked-audiences.md index 2936dc5c02..ed479e6ac5 100644 --- a/src/engage/audiences/linked-audiences.md +++ b/src/engage/audiences/linked-audiences.md @@ -149,6 +149,8 @@ To activate your Linked Audience: 4. Select a destination from the catalog. 5. Click **Configure data to send to destination**. +To learn more about observability for destinations connected to Linked Audiences, see the [Delivery Overview](/docs/connections/delivery-overview/) topic. + ### Step 2b: Select your Destination Actions The [Destination Actions](/docs/connections/destinations/actions/) framework allows you to see and control how Segment sends the event data it receives from your sources to actions-based destinations. Each Action in a destination lists the event data it requires and the event data that is optional. Segment displays available Actions based on the destination you've connected to your Linked Audience. You can see details of each option and how to use it in the [Actions Destinations Catalog](/docs/connections/destinations/catalog/) documentation. From bf872199bec95a7e97a238906e22791088dad195 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Fri, 16 Aug 2024 18:44:26 -0400 Subject: [PATCH 2/6] rmv examples --- src/connections/delivery-overview.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/connections/delivery-overview.md b/src/connections/delivery-overview.md index 05f179f0a9..8174bb67f4 100644 --- a/src/connections/delivery-overview.md +++ b/src/connections/delivery-overview.md @@ -24,10 +24,10 @@ You can refine these tables using the time picker and the metric toggle, located The pipeline view provides insights into each step that your data takes enroute to the destination, with additional information available for each 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 (for example, Failed on ingest, Filtered at source, Filtered at destination, and 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. Each of the following integrations has a slightly different pipeline view to account for differences in the data processing journey (process?): -- [Classic destinations](#classic-destinations): Destinations built with Segment's classic framework. Examples include ABC, DEF, and XYZ. -- [Actions destinations](#actions-destinations): Destinations built with Segment's new Destination Actions framework. Examples include ABC, DEF, and XYZ. -- [Storage destinations](#storage-destinations): Warehouse and blob storage destinations. Examples include ABC, DEF, LMNOP. -- [Linked Audiences](#linked-audiences): Any +- [Classic destinations](#classic-destinations): Destinations built with Segment's classic framework. +- [Actions destinations](#actions-destinations): Destinations built with Segment's new Destination Actions framework. +- [Storage destinations](#storage-destinations): Warehouse and blob storage destinations. +- [Linked Audiences](#linked-audiences): Any destinations connected to a Linked Audience. #### Classic destinations The pipeline view for classic destinations includes the following steps: From 0b8c50abc6ea04872e56dc24764f60be9bfd7842 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 20 Aug 2024 14:37:26 -0400 Subject: [PATCH 3/6] Update src/connections/delivery-overview.md Co-authored-by: pwseg <86626706+pwseg@users.noreply.github.com> --- src/connections/delivery-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/delivery-overview.md b/src/connections/delivery-overview.md index 8174bb67f4..9982076b3a 100644 --- a/src/connections/delivery-overview.md +++ b/src/connections/delivery-overview.md @@ -21,7 +21,7 @@ Delivery Overview has three core features: 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 that your data takes enroute to the destination, with additional information available for each 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 (for example, Failed on ingest, Filtered at source, Filtered at destination, and 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. +The pipeline view provides insights into each step that your data takes en route to the destination, with additional information available for each 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 (for example, Failed on ingest, Filtered at source, Filtered at destination, and 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. Each of the following integrations has a slightly different pipeline view to account for differences in the data processing journey (process?): - [Classic destinations](#classic-destinations): Destinations built with Segment's classic framework. From 9ff452d92fa9a8ca2563db515d88ba7f868cad65 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 20 Aug 2024 15:14:32 -0400 Subject: [PATCH 4/6] Update delivery-overview.md --- src/connections/delivery-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/connections/delivery-overview.md b/src/connections/delivery-overview.md index 9982076b3a..e2f18bc7e2 100644 --- a/src/connections/delivery-overview.md +++ b/src/connections/delivery-overview.md @@ -23,9 +23,9 @@ You can refine these tables using the time picker and the metric toggle, located ### Pipeline view The pipeline view provides insights into each step that your data takes en route to the destination, with additional information available for each 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 (for example, Failed on ingest, Filtered at source, Filtered at destination, and 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. -Each of the following integrations has a slightly different pipeline view to account for differences in the data processing journey (process?): +Each of the following integrations has a slightly different pipeline view to account for differences in the data processing journey: - [Classic destinations](#classic-destinations): Destinations built with Segment's classic framework. -- [Actions destinations](#actions-destinations): Destinations built with Segment's new Destination Actions framework. +- [Actions destinations](#actions-destinations): Destinations built with Segment's Destination Actions framework. - [Storage destinations](#storage-destinations): Warehouse and blob storage destinations. - [Linked Audiences](#linked-audiences): Any destinations connected to a Linked Audience. From 2398e794937336163bf794ae6e6786e981d497a6 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 20 Aug 2024 15:15:07 -0400 Subject: [PATCH 5/6] [netlify-build] --- src/connections/delivery-overview.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/connections/delivery-overview.md b/src/connections/delivery-overview.md index e2f18bc7e2..71bc20bee9 100644 --- a/src/connections/delivery-overview.md +++ b/src/connections/delivery-overview.md @@ -156,4 +156,5 @@ The Delivery Overview pipeline steps Failed on Ingest, Filtered at Source, Filte This table provides a list of all possible discard reasons available at each pipeline step. {% include content/delivery-overview-discards.html %} + \ No newline at end of file From 4e182c539d4f92c94bfea4ab56788d3024ba101a Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 20 Aug 2024 17:01:59 -0400 Subject: [PATCH 6/6] xpollinate docs links [netlify-build] --- src/connections/delivery-overview.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/src/connections/delivery-overview.md b/src/connections/delivery-overview.md index 71bc20bee9..8210ba6229 100644 --- a/src/connections/delivery-overview.md +++ b/src/connections/delivery-overview.md @@ -30,7 +30,7 @@ Each of the following integrations has a slightly different pipeline view to acc - [Linked Audiences](#linked-audiences): Any destinations connected to a Linked Audience. #### Classic destinations -The pipeline view for classic destinations includes the following steps: +The pipeline view for [classic destinations](/docs/connections/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. @@ -39,7 +39,7 @@ The pipeline view for classic destinations includes the following steps: - **Successful delivery**: Events that were successfully delivered to the destination. #### Actions destinations -The pipeline view for Actions destination includes the following steps: +The pipeline view for [Actions destinations](/docs/connections/destinations/#destination-actions) 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. @@ -54,7 +54,7 @@ The following image shows an Actions destination filtered to include only Track ![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: +The pipeline view for [storage destinations](/docs/connections/storage/) 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. @@ -68,7 +68,7 @@ The following image shows a storage destination with 23 partially successful syn ![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) #### Linked Audiences -Delivery Overview for Linked Audiences includes a toggle view above the data pipeline so you can narrow the results to one Linked Audience and one or more [activations](/docs/engage/audiences/linked-audiences/#step-2c-define-how-and-when-to-trigger-an-event-to-your-destination). +Delivery Overview for [Linked Audiences](/docs/engage/audiences/linked-audiences/) includes a toggle view above the data pipeline so you can narrow the results to one Linked Audience and one or more [activations](/docs/engage/audiences/linked-audiences/#step-2c-define-how-and-when-to-trigger-an-event-to-your-destination). The pipeline view for Linked Audiences includes the following steps: - **Events from Audience**: Audience events Segment received from a connected source. @@ -156,5 +156,4 @@ The Delivery Overview pipeline steps Failed on Ingest, Filtered at Source, Filte This table provides a list of all possible discard reasons available at each pipeline step. {% include content/delivery-overview-discards.html %} - \ No newline at end of file