Skip to content

Release 23.21.1 #4778

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

Merged
merged 45 commits into from
May 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
928402b
init delivery overview page, sidenav
forstisabella Feb 9, 2023
8449169
sp
forstisabella Feb 9, 2023
404aeca
ROUGH draft of content
forstisabella Feb 17, 2023
e05f49c
Merge branch 'develop' into DOC-655-IG
forstisabella Feb 17, 2023
940a2ed
Update delivery-overview.md
forstisabella Feb 21, 2023
dcc9384
Merge branch 'develop' into DOC-655-IG
forstisabella Feb 22, 2023
5c1e5cf
more context about how to use/filter delivery overview
forstisabella Feb 23, 2023
15b2f12
Update delivery-overview.md
forstisabella Feb 23, 2023
d6912d8
ROUGH draft of DO docs, event tester fixes
forstisabella Feb 24, 2023
0d3b811
Merge branch 'develop' into DOC-655-IG
forstisabella Feb 24, 2023
6280942
editing pass/matching the terms in the ui
forstisabella Feb 24, 2023
8b97800
Source debugger/event tester fixes
forstisabella Feb 24, 2023
37936ef
Update delivery-overview.md
forstisabella Feb 24, 2023
643aaf2
[netlify-build]
forstisabella Feb 24, 2023
ebf3d52
Merge branch 'develop' into DOC-655-IG
forstisabella Feb 28, 2023
231635f
Making requested changes [netlify-build]
forstisabella Mar 3, 2023
ab3bc8e
Merge branch 'develop' into DOC-655-IG
forstisabella Mar 3, 2023
38ebbf0
changes requested by Peter, Eric
forstisabella Mar 20, 2023
6ad8fc4
Merge branch 'develop' into DOC-655-IG
forstisabella Mar 20, 2023
80a5f79
Add to beta callout about the incremental release
forstisabella Apr 17, 2023
08536f3
Merge branch 'develop' into DOC-655-IG
forstisabella Apr 17, 2023
27f0bfc
Merge branch 'develop' into DOC-655-IG
forstisabella Apr 17, 2023
564b1ce
[netlify-build]
forstisabella Apr 18, 2023
42ae275
Apply suggestions from code review
forstisabella Apr 18, 2023
404163d
Merge branch 'develop' into DOC-655-IG
forstisabella Apr 18, 2023
a93f8ba
removing "currently", date
forstisabella Apr 18, 2023
a24c56c
clarify how email is actually set
May 17, 2023
c4cd5d5
Updating Link to Google's Docs (Event Naming Rules)
senabon May 18, 2023
ecf56fd
Update src/connections/destinations/catalog/actions-google-analytics-…
rchinn1 May 18, 2023
60e3b42
Merge pull request #4761 from segmentio/senabon-patch-3
rchinn1 May 18, 2023
4c81cbe
Merge branch 'develop' into DOC-655-IG
forstisabella May 19, 2023
8703a7d
Update src/connections/destinations/catalog/criteo-app-web-events/ind…
tcgilbert May 22, 2023
c666fcc
new section on event naming conventions
May 22, 2023
803c53d
remove also
May 22, 2023
389699f
rephrase sentence
May 22, 2023
72d02f4
remove word
May 22, 2023
cf03863
Update headers and change "we" to "Segment"
rchinn1 May 22, 2023
7b04788
Merge pull request #4768 from segmentio/thomas/sources
rchinn1 May 22, 2023
2476983
Editing phased rollout language
forstisabella May 22, 2023
3c5c889
Update quickstart.md (#4762)
bcaudillo May 23, 2023
2ac27f8
feat: redesign react native documentation to match swift/kotlin [netl…
alanjcharles May 23, 2023
5fdb557
Merge pull request #4750 from segmentio/criteo
forstisabella May 23, 2023
ec8e54f
Update Transfer To Workspace section w/ limitation (#4611)
daldeano-segment May 23, 2023
5053193
Merge pull request #4594 from segmentio/DOC-655-IG
forstisabella May 23, 2023
45f7ca4
catalog update
May 23, 2023
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
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ CONTEXT=development
PLATFORM_API_TOKEN=generate a token from your Segment workspace
PAPI_TOKEN=generate a token from your Segment workspace
ALGOLIA_APP_ID=
ALGOLIA_SEARCH_KEY=
ALGOLIA_SEARCH_KEY=
2 changes: 1 addition & 1 deletion src/_data/catalog/destination_categories.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination categories last updated 2023-05-18
# destination categories last updated 2023-05-23
items:
- display_name: A/B Testing
slug: a-b-testing
Expand Down
91 changes: 13 additions & 78 deletions src/_data/catalog/destinations.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination data last updated 2023-05-18
# destination data last updated 2023-05-23
items:
- id: 637e8d185e2dec264895ea89
display_name: 1Flow
Expand Down Expand Up @@ -15105,71 +15105,6 @@ items:
dynamic: false
allowNull: false
presets: []
- id: 5d433ab511dfe7000134faca
display_name: Criteo Offline Conversions
name: Criteo Offline Conversions
slug: criteo-offline-conversions
hidden: false
endpoints:
- US
regions:
- us-west-2
url: connections/destinations/catalog/criteo-offline-conversions
previous_names:
- Criteo Offline Conversions
website: http://www.criteo.com
status: PUBLIC
categories:
- Advertising
- A/B Testing
- Attribution
- Personalization
logo:
url: https://cdn-devcenter.segment.com/304967dc-9099-4c28-9745-dc0e6d742ccd.svg
mark:
url: https://cdn-devcenter.segment.com/7d1e9292-d6a5-4665-81d1-e610f971ba05.svg
methods:
track: true
identify: true
group: true
alias: true
screen: false
page: true
platforms:
browser: true
mobile: true
server: true
warehouse: false
components: []
browserUnbundlingSupported: false
browserUnbundlingPublic: false
replay: false
connection_modes:
device:
web: false
mobile: false
server: false
cloud:
web: true
mobile: true
server: true
settings:
- name: apiKey
type: string
defaultValue: ''
description: >-
Please enter "NA" in this field. Criteo Offline Sales API does not require
an API key
required: true
label: API Key
- name: clientId
type: string
defaultValue: ''
description: Ask your Criteo Account Strategist (AS) for this ID
required: true
label: Client ID
actions: []
presets: []
- id: 54521fd525e721e32a72eea3
display_name: Crittercism
name: Crittercism
Expand Down Expand Up @@ -42246,9 +42181,9 @@ items:
categories:
- Analytics
logo:
url: https://cdn.filepicker.io/api/file/pUF0kwpTTu0Z5POuzZXV
url: https://cdn.filepicker.io/api/file/DVOLKwFwS3OZtcBG8WsU
mark:
url: https://cdn.filepicker.io/api/file/0mdiroESxtRQBoR8ieBg
url: https://cdn.filepicker.io/api/file/Kxk6HvAYR7yEaDI5pyfp
methods:
track: true
identify: true
Expand Down Expand Up @@ -56092,7 +56027,7 @@ items:
hidden: false
defaultTrigger: type = "identify"
fields:
- id: jTewdfEL814nijtKA6frvM
- id: v8pSdvz3kwFkCXK8qG8goj
sortOrder: 0
fieldKey: engage_space
label: Profile Space
Expand All @@ -56109,7 +56044,7 @@ items:
choices: null
dynamic: true
allowNull: false
- id: i9E4dEmbawJU4qrBaCTLTW
- id: rqqFU8D93eDbg5fAaRDUr5
sortOrder: 1
fieldKey: user_id
label: User ID
Expand All @@ -56123,7 +56058,7 @@ items:
choices: null
dynamic: false
allowNull: false
- id: vE67L9A9uorcWmVwTdr43f
- id: jcsDCMLqHv8HpoXamjd9gg
sortOrder: 2
fieldKey: anonymous_id
label: Anonymous ID
Expand All @@ -56137,7 +56072,7 @@ items:
choices: null
dynamic: false
allowNull: false
- id: 3riQQUbHiZBUg6JpXdMh5Z
- id: mE51bAhBcZDHi163XpYfdy
sortOrder: 3
fieldKey: group_id
label: Group ID
Expand All @@ -56149,7 +56084,7 @@ items:
choices: null
dynamic: false
allowNull: false
- id: 4WxmQPd7o8rhYzUQrDzAfP
- id: cKwg6HPJ3UF2t1hpTD273D
sortOrder: 4
fieldKey: traits
label: Traits
Expand All @@ -56171,7 +56106,7 @@ items:
hidden: false
defaultTrigger: type = "group"
fields:
- id: 2AouogMfwofdjrMMMR55pk
- id: c4AfCyGxVeZiC3xLMEzLEt
sortOrder: 0
fieldKey: engage_space
label: Profile Space
Expand All @@ -56188,7 +56123,7 @@ items:
choices: null
dynamic: true
allowNull: false
- id: gEQg4ZiHFDuYuc6ruUfR3E
- id: r7wL2rucrRoCA8FN85GHHx
sortOrder: 1
fieldKey: user_id
label: User ID
Expand All @@ -56202,7 +56137,7 @@ items:
choices: null
dynamic: false
allowNull: false
- id: nrw1atRKvirUgfv4jXtGnB
- id: 6fQZa98k99SmQ5jLqJoYns
sortOrder: 2
fieldKey: anonymous_id
label: Anonymous ID
Expand All @@ -56216,7 +56151,7 @@ items:
choices: null
dynamic: false
allowNull: false
- id: fkZT6A5ch2uHmcAwWW3Ftc
- id: dCBJaJh6DVK4XbUnRt4n5r
sortOrder: 3
fieldKey: group_id
label: Group ID
Expand All @@ -56228,7 +56163,7 @@ items:
choices: null
dynamic: false
allowNull: false
- id: c1fdHfzHx5FuoJkK92aEYm
- id: vzN2FB2WmqgTXKmeNqEKox
sortOrder: 4
fieldKey: traits
label: Traits
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/destinations_private.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination data last updated 2023-05-18
# destination data last updated 2023-05-23
items:
- id: 54521fd725e721e32a72eec1
display_name: HubSpot
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/regional-supported.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL
# Last updated 2023-05-18
# Last updated 2023-05-23
warehouses:
- id: WcjBCzUGff
display_name: Azure SQL Data Warehouse
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/source_categories.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# source cateogries last updated 2023-05-18
# source cateogries last updated 2023-05-23
items:
- display_name: A/B Testing
slug: a-b-testing
Expand Down
23 changes: 16 additions & 7 deletions src/_data/catalog/sources.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# sources last updated 2023-05-18
# sources last updated 2023-05-23
items:
- id: 8HWbgPTt3k
display_name: .NET
Expand Down Expand Up @@ -1122,7 +1122,7 @@ items:
isCloudEventSource: true
slug: listrak-dev
url: connections/sources/catalog/cloud-apps/listrak-dev
hidden: false
hidden: true
regions:
- us
endpoints:
Expand Down Expand Up @@ -1228,16 +1228,25 @@ items:
isCloudEventSource: true
slug: mailmodo
url: connections/sources/catalog/cloud-apps/mailmodo
hidden: false
hidden: true
regions:
- us
endpoints:
- us
source_type: cloud-app
description: ''
description: >-
Mailmodo is an email marketing platform that helps you create interactive
emails powered by AMP. With our no-code editor, you can create interactive
email in minutes and send engaging and personalized emails that boost
conversions. Using Mailmodo Source allows you to export the campaign
activity events generated after your contacts engage with the Mailmodo
campaigns to Segment. Segment will automatically collect campaign activity
data and then forward them to your destinations.
logo:
url: ''
categories: []
url: https://cdn.filepicker.io/api/file/6seblS8KSqiXLUNeW5xW
categories:
- Email Marketing
- Marketing Automation
- id: asdf76as89
display_name: Mandrill
isCloudEventSource: false
Expand Down Expand Up @@ -1292,7 +1301,7 @@ items:
creating behavioral cohorts visually from any analyses you perform, which
you can then route to Segment to engage your users in meaningful ways.
logo:
url: https://d3hotuclm6if1r.cloudfront.net/logos/mixpanel-default.svg
url: https://cdn.filepicker.io/api/file/DVOLKwFwS3OZtcBG8WsU
categories:
- Analytics
- id: kpDbTUR9oD
Expand Down
2 changes: 2 additions & 0 deletions src/_data/sidenav/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,8 @@ sections:
title: Using Schema Controls
- path: /connections/event-delivery
title: Event Delivery
- path: /connections/delivery-overview
title: Delivery Overview
- path: /connections/find-writekey
title: Locate Your Write Key
- path: /connections/integration_error_codes
Expand Down
20 changes: 11 additions & 9 deletions src/_data/sidenav/strat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -166,15 +166,17 @@ sections:
section_title: Analytics-React-Native Documentation
section:
- path: /connections/sources/catalog/libraries/mobile/react-native
title: Analytics-React-Native mobile source
- path: /connections/sources/catalog/libraries/mobile/react-native/migration
title: Upgrade to React-Native 2.0
- path: /connections/sources/catalog/libraries/mobile/react-native/troubleshooting
title: Troubleshooting Analytics-React-Native
- path: /connections/sources/catalog/libraries/mobile/react-native/react-faqs/
title: React-Native FAQs
- path: /connections/sources/catalog/libraries/mobile/react-native/changelog
title: Analytics-React-Native Changelog
title: Overview
- path: /connections/sources/catalog/libraries/mobile/react-native/implementation
title: Implementation / Upgrade
- path: /connections/sources/catalog/libraries/mobile/react-native/destination-plugins
title: Destination Plugins
- path: /connections/sources/catalog/libraries/mobile/react-native/cloud-mode-destinations
title: Cloud-mode Destinations
- path: /connections/sources/catalog/libraries/mobile/react-native/react-native-typewriter
title: Typewriter for React Native
- path: /connections/sources/catalog/libraries/mobile/react-native/react-native-destination-filters
title: Destination Filters for React Native

- slug: kotlin-android
section_title: Analytics-Kotlin Documentation
Expand Down
85 changes: 85 additions & 0 deletions src/connections/delivery-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
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 is currently in beta"
> This means that the Delivery Overview feature is in active development, and some functionality may change before it becomes generally available. Beta users of Delivery Overview will still have access to the Event Delivery tab. During the public beta, Delivery Overview will only support event-streaming, cloud-mode destinations.
>
> The Delivery Overview public beta will be released to all Segment users on May 23, 2023 in a phased rollout. Users can expect to see the Delivery Overview tab in their destination details page by 5 PM PDT on May 26, 2023.

## 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, or 7 days) 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 shows 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), or [per source schema integration filters](/docs/guides/filtering-data/#per-source-schema-integrations-filters). Actions destinations 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.
- **Failed delivery**: Events that have been discarded due to errors or unmet destination requirements
- **Successful delivery**: Events that were successfully delivered to the destination

### 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 (successfully received,) the last step in the pipeline view (successful delivery,) 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 percentage<sup>1</sup>

<sup>1:</sup> *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 will link 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.
- **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 percentage<sup>1</sup>

<sup>1:</sup> *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.

## 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. <br/> ___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 products?
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?
During the Delivery Overview beta, you can use the Event Delivery alerting features (Delivery Alerts) by selecting the **Alerts** tab in the destination header.

Loading