Skip to content

Commit 11220de

Browse files
forstisabellaforstisabella
committed
init monitor tab
1 parent fb1f882 commit 11220de

File tree

6 files changed

+102
-0
lines changed

6 files changed

+102
-0
lines changed

‎src/_data/sidenav/main.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -597,6 +597,17 @@ sections:
597597
title: HIPAA Eligible Segment
598598
- path: /privacy/faq
599599
title: Privacy FAQs
600+
- section_title: Monitor
601+
section:
602+
- path: /monitor
603+
title: Monitor Overview
604+
- section_title: Alerts
605+
slug: /monitor/alerts
606+
section:
607+
- path: /monitor/alerts/connections-alerts
608+
title: Connections Alerts
609+
- path: /monitor/audit-trail
610+
title: Audit Trail
600611
- section_title: Protocols
601612
section:
602613
- path: /protocols

‎src/_includes/icons/monitor.svg

Lines changed: 3 additions & 0 deletions
Loading

‎src/connections/alerting.md renamed to ‎src/monitor/alerts/connections-alerts.md

File renamed without changes.

‎src/monitor/alerts/index.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Alerts
3+
---
4+
Connections Alerting allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection.
5+
6+
To access Connections Alerting, select an event-streaming connection (like a web library source or cloud mode destination) and click the **Alerts** tab.
7+
8+
On the Alerts tab, you can create alerts and view all active alerts for this connection. You can only edit or delete the alerts that you create.
9+
10+
## Source volume alerts
11+
12+
You can create an alert that notifies you when the volume of events received by your source in the last 24 hours changes beyond a percentage you set. For example, if you set a change percentage of 4% and your source received 100 events over the first 24 hours, Segment would notify you the following day if your source ingested fewer than 96 or more than 104 events.
13+
14+
To receive a source volume alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see the [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation.
15+
16+
<img src="images/alerting-source-alert.png" alt="A screenshot of the Source Volume alert creation sidesheet." width="470px" height="540px">
17+
18+
To create a source volume alert:
19+
1. In your workspace, navigate to Connections, select Sources, and select the Event streams tab.
20+
2. Select the [event streams source](/docs/connections/sources/#event-streams-sources) you'd like to configure alerts for.
21+
2. Select the Alerts tab and click **Create alert**.
22+
3. On the Create alert sidesheet, enter a percentage of source volume change that you'd like to be notified for.
23+
4. Select one or more of the following alert channels:
24+
- **Email**: Select this to receive notifications at the provided email address.
25+
- **Slack**: Select this to send alerts to one or more channels in your workspace.
26+
- **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.
27+
5. Click **Save**.
28+
29+
To make changes to a source volume alert, select the icon in the Actions column for the alert and click **Edit**.
30+
31+
To delete a source volume alert, select the icon in the Actions column for the alert and click **Delete**.
32+
33+
> info "Deleting alerts created by other users requires Workspace Owner permissions"
34+
> All users can delete source volume alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
35+
36+
## Successful delivery rate alerts
37+
38+
You can create an alert that notifies you when the volume of events successfully received by your destination in the last 24 hours falls below a percentage you set. For example, if you set a percentage of 99%, Segment notifies you if your destination had a successful delivery rate of 98% or below.
39+
40+
To receive a successful delivery rate alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see the [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation.
41+
42+
To create a successful delivery rate alert:
43+
1. Navigate to the [cloud-mode destinations](/docs/connections/destinations/#:~:text=Cloud%2Dmode%3A%20The%20sources%20send%20data%20directly%20to%20the%20Segment%20servers%2C%20which%20then%20translate%20it%20for%20each%20connected%20downstream%20destination%2C%20and%20send%20it%20on.) you'd like to configure alerts for.
44+
2. Select the Alerts tab and click **Create alert**.
45+
3. On the Create alert sidesheet, enter a percentage. You will receive events if your successful delivery rate falls below this percentage.
46+
4. Select one of the following alert channels:
47+
- **Email**: Select this to receive notifications at either the email address associated with your account or another email address that you enter into this field.
48+
- **Slack**: Select this and enter a Slack webhook URL and channel name to send alerts to a channel in your Slack workspace.
49+
- **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.
50+
5. Click **Save**.
51+
52+
To make changes to a successful delivery rate alert, select the icon in the Actions column for the alert and click **Edit**.
53+
54+
To delete a successful delivery rate alert, select the icon in the Actions column for the alert and click **Delete**.
55+
56+
> info "Deleting alerts created by other users requires Workspace Owner permissions"
57+
> All users can delete successful delivery alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
58+
59+
Segment generates delivery alerts for failed deliveries and successful deliveries, which are the last two stages of the delivery pipeline. As a result, alerts are based on Segment's attempts to send qualified events to your destination, excluding those filtered out by business rules (like protocols, destination filters, or mappings).

‎src/segment-app/iam/audit-trail.md renamed to ‎src/monitor/audit-trail.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Audit Trail
33
plan: audit-trail
4+
redirect_from: /docs/segment-app/iam/audit-trail/
45
---
56

67

‎src/monitor/index.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Monitor Overview
3+
---
4+
With Segment’s auditing and alerting capabilities, you can monitor the health of your integrations, diagnose issues that might be present in your data pipeline, and view a record of all user and system activity that happened in Segment over the past 90 days.
5+
6+
Receive alerts for the performance and throughput of your Sources and Destinations, fluctuations in events delivered to your Reverse ETL mappings, and the performance and throughput of Audience syncs with Alerting.
7+
8+
Segment’s Audit Trail provides a high-level view of all changes made in your workspace over the last 90 days. Use the Audit Trail and Audit Forwarding to quickly revert unintentional actions made in Segment to prevent downstream data loss.
9+
10+
Select a product below to learn about its capabilities, supported destinations, and more.
11+
12+
13+
<div class="double">
14+
{% include components/reference-button.html
15+
href="/docs/monitor/alerts"
16+
icon="read-more.svg"
17+
title="Alerts"
18+
description="Receive in-app, email, or Slack notifications related to the performance and throughput of a Segment connection."
19+
%}
20+
21+
{% include components/reference-button.html
22+
href="/docs/monitor/audit-trail"
23+
icon="connections.svg"
24+
title="Audit Trail"
25+
description="View, filter, and export the last 90 days of user and system activity."
26+
%}
27+
</div>
28+

0 commit comments

Comments
 (0)