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

Audience observability and monitoring features #7312

Merged
merged 13 commits into from
Mar 18, 2025

Conversation

forstisabella
Copy link
Contributor

@forstisabella forstisabella commented Dec 11, 2024

Proposed changes

Added DO for Audiences and Audience Alerting sections to the Audiences overview page + add Audience-specific section to the DO page + add specifics about filtering by events to the Linked Audiences docs

Merge timing

3/18/25

Related issues (optional)

DOC-1047
DOC-991

Copy link

netlify bot commented Dec 11, 2024

Deploy Preview for segment-docs ready!

Name Link
🔨 Latest commit 69c0393
🔍 Latest deploy log https://app.netlify.com/sites/segment-docs/deploys/6759cafd7cbee30008d35eec
😎 Deploy Preview https://deploy-preview-7312--segment-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Dec 11, 2024

Deploy Preview for segment-docs ready!

Name Link
🔨 Latest commit 7452dd0
🔍 Latest deploy log https://app.netlify.com/sites/segment-docs/deploys/67d83665e0af9900095d0407
😎 Deploy Preview https://deploy-preview-7312--segment-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

pwseg
pwseg previously approved these changes Dec 19, 2024
pwseg
pwseg previously approved these changes Jan 30, 2025

Delivery Overview has three core features:
- [Pipeline view](/docs/connections/delivery-overview/#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/connections/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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

details instead of detail?

Delivery Overview has three core features:
- [Pipeline view](/docs/connections/delivery-overview/#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/connections/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.
- [Discard table](/docs/connections/delivery-overview/#discard-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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 you can inspect samples of them.

> 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**<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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Events that Segment created for your activation. The number of events depends on the changes detected in your audience membership.

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.

Delivery Overview has three core features:
- [Pipeline view](/docs/connections/delivery-overview/#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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"from when your source receives audience events"
Is that true, because later in the docs (in this commit) it says otherwise (it says "Events from audience")?
If we are referring to the engage shadow source then customers arent aware of this source and we should change this line to be " from events outputted from your Audience to when ...."

To view Delivery Overview for an Audience:
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change

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.

to

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 option to view your metrics as percentages.

@forstisabella forstisabella requested a review from pwseg March 10, 2025 22:56
@forstisabella forstisabella changed the base branch from develop to master March 17, 2025 14:36
Copy link
Contributor

@pwseg pwseg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some super minor suggestions, but LGTM!

@forstisabella forstisabella merged commit d12bc79 into master Mar 18, 2025
4 checks passed
@forstisabella forstisabella deleted the audience-do-alerting branch March 18, 2025 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants