Skip to content

Commit ba72fb1

Browse files
committed
Update index.md
1 parent c3f4b79 commit ba72fb1

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

src/engage/audiences/index.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,72 @@ Engage then processes your realtime Audience or Trait edits. While the edit task
201201
> warning ""
202202
> You can't edit an audience to include anonymous users. If you need to include anonymous profiles, recreate the audience with the appropriate conditions
203203
204+
## Monitor the health of your Audience syncs
205+
206+
Use Segment's [Delivery Overview](#delivery-overview) and [Alerting](#alerting) features to monitor the health of your Audience syncs and get notified when event volume spikes or drops.
207+
208+
### Delivery Overview
209+
210+
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.
211+
212+
Delivery Overview has three core features:
213+
- [Pipeline view](#pipeline-view): a visual overview of each step your data takes during the delivery process - from your source recieving audience events all the way to events successfully delivered to your connected destination.
214+
- [Breakdown table](#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.
215+
- [Discard table](#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.
216+
217+
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.
218+
219+
For more information about the pipeline view, see the [Delivery Overview](/docs/connections/delivery-overview/) documentation.
220+
221+
> info "Linked Audiences have additional filtering functionality"
222+
> 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.
223+
224+
#### Steps in the pipeline view
225+
226+
Audiences have the following steps in the pipeline view:
227+
228+
Delivery Overview shows you four steps in your data activation pipeline:
229+
230+
- **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.
231+
- **Filtered at source**:
232+
- **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.
233+
- **Events pending retry**: A step that reveals the number of events that are awaiting retry.
234+
- **Failed delivery**: Events that Segment attempted to deliver to your destination, but ultimately failed to deliver to your destination. Failed delivery indicates an issue with the destination, like invalid credentials, rate limits, or other error statuses received during delivery.
235+
- **Successful delivery**: Events that Segment successfully delivered to your destination. You’ll see these events in your downstream integrations.
236+
237+
### Alerting
238+
239+
Create alerts related to the performance and throughput of Audience syncs and receive in-app, email, and Slack notifications when event volume fluctuations occur.
240+
241+
> info "Generate a Slack webhook to receive Slack notifications"
242+
> 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.
243+
244+
To access Audience alerting, navigate to **Engage > Audiences**, select an Audience, and click the Alerts tab.
245+
246+
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/).
247+
248+
#### Activation event health spikes or drops
249+
250+
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.
251+
252+
To create an Activation event health spikes or drops alert:
253+
1. From your Segment workspace's home page, navigate to **Engage > Audiences**.
254+
2. Select the Audience you want to create an alert for, select the Alerts tab, and click **Create alert**.
255+
3. On the Create alert sidesheet, select the destination for which you'd like to monitor event health.
256+
4. Enter a percentage of activation event health that you'd like to be notified for.
257+
5. Select one or more of the following alert channels:
258+
- **Email**: Select this to receive notifications at the provided email address.
259+
- **Slack**: Select this to send alerts to one or more channels in your workspace.
260+
- **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.
261+
6. Click **Save**.
262+
263+
To make changes to a Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Edit**.
264+
265+
To delete a Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Delete**.
266+
267+
> info "Deleting alerts created by other users requires Workspace Owner role"
268+
> 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.
269+
204270
## Access your Audiences using the Profiles API
205271

206272
You can access your Audiences using the Profile API by querying the `/traits` endpoint. For example, you can query for `high_value_user` property with the following `GET` request:

0 commit comments

Comments
 (0)