Skip to content

Commit d89dc18

Browse files
ellakzellakz
committed
add logs fields to logs
1 parent ca1a946 commit d89dc18

File tree

5 files changed

+138
-66
lines changed

5 files changed

+138
-66
lines changed

‎docs/cloud/features/collaboration-and-communication/audit_logs/index.mdx‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Logs
3+
sidebarTitle: Logs
4+
---
5+
6+
The **Logs** feature allows workspace admins to track and export both user actions and system-level events across the platform. This includes user configuration changes, data synchronization events, and alert deliveries.
7+
8+
This feature provides visibility into workspace activity and helps support audit readiness, team coordination, operational monitoring, and troubleshooting.
9+
10+
## Log Types
11+
12+
- **[User Activity Logs](/cloud/features/collaboration-and-communication/audit_logs/user-activity-logs)** - Track changes made by users across the system
13+
- **[System Logs](/cloud/features/collaboration-and-communication/audit_logs/system-logs)** - Track system-level events and operations
14+
15+
## How to Access Logs
16+
17+
Once enabled for your account, access the logs:
18+
19+
<Frame>
20+
<div className="dark:bg-white rounded-md p-4">
21+
<img
22+
height ="400"
23+
width="400"
24+
src="https://res.cloudinary.com/do5hrgokq/image/upload/v1751204715/logs_fqsfbb.png"
25+
/>
26+
</div>
27+
</Frame>
28+
29+
1. Click on your **account name** in the top-right corner of the UI
30+
2. Open the dropdown menu
31+
3. Select **Logs**
32+
4. Choose **User Activity Logs** or **System Logs** from the log type selector
33+
5. Select the number of days to look back
34+
6. Click **Export** to download the log as a **CSV file**
35+
36+
You can open the CSV in any spreadsheet tool to review and filter the activity as needed.

‎docs/cloud/features/collaboration-and-communication/audit_logs/system-logs.mdx‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: System Logs
3+
sidebarTitle: System Logs
4+
---
5+
6+
System logs track system-level events and operations, including data synchronization events and alert deliveries that help with monitoring system operations and troubleshooting.
7+
8+
## What's Included
9+
10+
The system logs capture system-level events and operations across your workspace, including:
11+
12+
- **Data synchronization events**, including:
13+
- Beginning and end of synchronization with dbt
14+
- Beginning and end of data warehouse (DWH) synchronization
15+
- Beginning and end of business intelligence (BI) synchronization
16+
- **Alert deliveries** - When alerts are sent to configured destinations
17+
18+
## Fields
19+
20+
The exported CSV file for system logs includes the following fields:
21+
22+
- **Timestamp** - The date and time when the event occurred (in UTC, ISO 8601 format)
23+
- *Example:* `"2024-01-15T14:30:45.123456+00:00"`
24+
25+
- **Event Name** - The specific action that was performed
26+
- *Examples:* `"dbt_data_sync_started"`, `"dbt_data_sync_completed"`, `"dwh_data_sync_started"`, `"dwh_data_sync_completed"`, `"bi_data_sync_started"`, `"bi_data_sync_completed"`, `"alerts_sent"`
27+
- *Example:* `"dbt_data_sync_completed"` or `"alerts_sent"`
28+
29+
- **Success** - Whether the action completed successfully
30+
- *Values:* `"True"` or `"False"` (as strings in CSV)
31+
- *Example:* `"True"` or `"False"`
32+
33+
- **Event Content** - Additional context-specific information about the action (stored as a JSON string)
34+
- The contents vary by action type. For example:
35+
- For sync actions: `{"environment_id": "env_789", "environment_name": "Production"}`
36+
- For alert delivery actions: `{"alert_count": 5, "destination": "slack"}`
37+
- *Example:* `{"environment_id": "env_789", "environment_name": "Production"}`
38+
39+
- **Env ID** - The environment identifier where the action occurred
40+
- *Example:* `"env_7890123456abcdef"`
41+
42+
- **Env Name** - The name of the environment where the action occurred
43+
- *Example:* `"Production"` or `"Staging"`
44+
45+
**Note:** System logs do not include user information fields since they represent automated system operations rather than user-initiated actions.

‎docs/cloud/features/collaboration-and-communication/audit_logs/user-activity-logs.mdx‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: User Activity Logs
3+
sidebarTitle: User Activity Logs
4+
---
5+
6+
User activity logs track changes made by users across the system, including actions such as creating, editing, or deleting tests, monitors, metadata, and other configurations.
7+
8+
## What's Included
9+
10+
The user activity logs capture a wide range of user actions across your workspace, including:
11+
12+
- **User login and logout events**
13+
- **Failed login attempts** (when applicable)
14+
- **Creation, modification, or deletion of configuration**, including:
15+
- Adding, editing, or deleting tests
16+
- Adding, editing, deleting, or archiving alert rules
17+
- Acknowledging, resolving, or assigning incidents
18+
- Adding, editing, or deleting metadata (owners, descriptions, tags, critical assets)
19+
- Adding, editing, or deleting integrations
20+
- Sending team member invites
21+
- Changing user roles
22+
23+
## Fields
24+
25+
The exported CSV file for user activity logs includes the following fields:
26+
27+
- **Timestamp** - The date and time when the event occurred (in UTC, ISO 8601 format)
28+
- *Example:* `"2024-01-15T14:30:45.123456+00:00"`
29+
30+
- **User Email** - The email address of the user who performed the action
31+
- *Example:* `"[email protected]"`
32+
33+
- **User Name** - The display name of the user who performed the action
34+
- *Example:* `"John Doe"`
35+
36+
- **Event Name** - The specific action that was performed
37+
- *Examples:* `"user_login"`, `"create_test"`, `"edit_alert_rule"`, `"assign_incident"`, `"create_alert_rule"`, `"edit_metadata"`, `"delete_test"`, `"invite_team_member"`, `"change_user_role"`
38+
- *Example:* `"user_login"` or `"create_test"`
39+
40+
- **Success** - Whether the action completed successfully
41+
- *Values:* `"True"` or `"False"` (as strings in CSV)
42+
- *Example:* `"True"` or `"False"`
43+
44+
- **Event Content** - Additional context-specific information about the action (stored as a JSON string)
45+
- The contents vary by action type. For example:
46+
- For incident actions: `{"incident_id": "inc_123", "incident_summary": "Test failure detected"}`
47+
- For test actions: `{"test_id": "test_456", "test_name": "assert_no_null_values"}`
48+
- For alert rule actions: `{"alert_routing_rule_id": "rule_789", "alert_routing_rule": {...}}`
49+
- For metadata actions: `{"asset_id": "asset_123", "metadata_type": "owner"}`
50+
- *Example:* `{"incident_id": "inc_123", "incident_summary": "Test failure detected"}`
51+
52+
- **Env ID** - The environment identifier where the action occurred. Empty for account-level actions like login/logout that aren't tied to a specific environment.
53+
- *Example:* `"env_7890123456abcdef"`
54+
55+
- **Env Name** - The name of the environment where the action occurred. Empty for account-level actions like login/logout that aren't tied to a specific environment.
56+
- *Example:* `"Production"` or `"Staging"`

‎docs/cloud/features/collaboration-and-communication/logs.mdx‎

Lines changed: 0 additions & 65 deletions
This file was deleted.

‎docs/docs.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@
156156
},
157157
"cloud/features/roles-and-permissions",
158158
"cloud/features/ci",
159-
"cloud/features/collaboration-and-communication/logs"
159+
"cloud/features/collaboration-and-communication/audit_logs"
160160
]
161161
},
162162
{

0 commit comments

Comments
 (0)