Skip to content

Commit c71da99

Browse files
committed
add list of supported product areas, filtering
1 parent 87474c6 commit c71da99

File tree

1 file changed

+36
-9
lines changed

1 file changed

+36
-9
lines changed

src/segment-app/iam/audit-trail.md

Lines changed: 36 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,56 @@
11
---
22
title: Audit Trail
33
plan: audit-trail
4-
hide_toc: true
54
---
65

7-
Workspace Owners can view user and system activity in the Audit Trail. You can filter for specific actions or actors to see who made changes to specific resources in the app. Actors can include both logged-in users as well as access tokens.
6+
The Audit Trail allows you can view user and system activity, filter activity for specific actions or actors, and export your data to an event streams source or CSV file.
87

9-
You can export the information to a CSV for download, or [forward the activity to a Segment source](#audit-forwarding). For example, you can forward Audit Trail activity to set up real-time Slack alerts and quickly revert changes that could cause unwanted downstream effects, such as a user unintentionally disabling a warehouse.
8+
> info "Viewing the Audit Trail requires Workspace Owner permissions"
9+
> You must have the Workspace Owner role to view the Audit Trail page. For more information about roles and permissions within Segment, see the [Roles documentation](/docs/segment-app/iam/roles/).
1010
1111
To view the Audit Trail:
1212
1. From the Segment app, select **Settings**.
1313
2. From the Settings tab, select **Admin**.
1414

15-
You can find a list of all events surfaced in the Audit Trail by accessing Audit Trail, clicking **Filters**, and selecting the **Events** dropdown.
15+
## Audit Trail events
16+
17+
The Audit Trail returns information about the following Segment product areas:
18+
19+
- Sources
20+
- Functions
21+
- Warehouses
22+
- Destinations
23+
- Storage
24+
- Tracking Plans
25+
- Destination Filters
26+
- Transformations
27+
- Audiences
28+
- Computed Traits
29+
- Engage Warehouse Sources
30+
- Profiles Sync
31+
- Spaces
32+
- Users
33+
- Journeys
34+
- Broadcasts
35+
- Workspace
36+
<!--- IG, 11/2023: Add consent to this list when this goes to public beta (q1 '24?)--->
37+
38+
To find a list of all events surfaced in the Audit Trail: open the Audit Trail, click **Filters**, and select the **Events** dropdown.
1639

1740
<!--- IG, 11/2023: PM for CX suggested directing to the Filter part in the app for a full list of events. PAPI support for a list of all events is on the roadmap, so at some point we can probably build a list automagically instead of using the Filters workaround --->
1841

42+
## Filtering events
43+
44+
The Filters dropdown allows you to refine your search results by filtering by actions or actors to see who made changes on specific resources in the app. Actors include both logged-in users and access tokens.
45+
1946
## Audit forwarding
2047

21-
You can forward events in your workspace to an [event streams source](/docs/connections/sources/#event-streams-sources).
48+
You can forward events in your workspace to an [event streams source](/docs/connections/sources/#event-streams-sources) to set up real-time alerts and quickly revert changes (like a user unintentionally disabling a warehouse) that could cause unwanted downstream effects.
49+
50+
> info "Segment recommends creating a dedicated source for audit trail events"
51+
> Segment recommends forwarding all events to an instance of the [HTTP API](/docs/connections/sources/catalog/libraries/server/http-api/) source. Segment passes all forwarded events through its entire processing pipeline. This ensures that Tracking Plans, Filters, and other features work with the audit events, and also ensures you can send those events to multiple downstream destinations.
2252
23-
To forward Audit Trail events:
53+
To forward Audit Trail events to an event streams source:
2454
1. Navigate to **Settings > Workspace Settings > Audit Forwarding**.
2555
2. Select or create an [event streams source](/docs/connections/sources/#event-streams-sources) to which you'll forward workspace events.
2656
3. Toggle the setting to **On** and click **Save Changes**.
27-
28-
> info "Segment recommends creating a dedicated source for audit trail events"
29-
> Segment recommends forwarding all events to one instance of the [HTTP API](/docs/connections/sources/catalog/libraries/server/http-api/) source. Segment passes all forwarded events through its entire processing pipeline. This ensures that Tracking Plans, Filters, and other features work with the audit events, and also ensures you can send those events to multiple downstream destinations.

0 commit comments

Comments
 (0)