-
Notifications
You must be signed in to change notification settings - Fork 469
DOC-11808 Docs for Audit Logs Page for Customers #19428
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
Changes from 9 commits
689ed17
73a428d
e4b66cf
897264d
5912b94
14e363b
18a2675
451ed90
5305a68
7af3c6e
5d219f9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
--- | ||
title: View Organization Audit Logs in the Cloud Console | ||
summary: Learn how to view CockroachDB Cloud organization audit logs in the Cloud Console. | ||
toc: true | ||
docs_area: manage | ||
cloud: true | ||
--- | ||
|
||
CockroachDB {{ site.data.products.cloud }} captures audit logs when many types of events occur, such as when a cluster is created or when a user is added to or removed from an organization. | ||
|
||
## View audit logs | ||
|
||
1. Navigate to the [CockroachDB {{ site.data.products.cloud }} Console](https://cockroachlabs.cloud/) and log in as a user with the [Organization Admin role]({% link cockroachcloud/authorization.md %}#org-administrator). | ||
1. In the top navigation bar, select **Organization**, then choose **Audit Logs** from the dropdown menu. This will bring you to the **Audit Logs** page, which shows a (possibly empty) list of audit logs. | ||
florence-crl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Filter audit logs | ||
Filter the audit logs by the following fields: | ||
florence-crl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- **Time Range (UTC)**: | ||
- Default: Last 48 hours. | ||
- To set the time range, select **Start date** or **End date**. Select your desired time range in the calendar dropdown or type in your desired dates and times. | ||
florence-crl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- **User email**: Select one or more email addresses from the list of [organization members]({% link cockroachcloud/managing-access.md %}#manage-an-organizations-users) (optional). | ||
- **Action name**: Select one or more predefined auditable actions (optional). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm going to create a follow up issue for us to define these. (I found them here.) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @mikeCRL please add a link to the follow-up issue. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @florence-crl Will do. Added a link to this comment in my task/draft so I’ll come back to this. |
||
- **Cluster name**: Select one or more cluster names (optional). | ||
|
||
## Audit logs table | ||
florence-crl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
If audit logs are found for the filter selections, a table will be displayed with the following columns: | ||
florence-crl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- **Time (UTC)** | ||
- **Users**: Displays either a member's email or a [service account name]({% link cockroachcloud/managing-access.md %}#manage-service-accounts). *(Note: You cannot filter by service account name.)* | ||
florence-crl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- **Action name** | ||
- **Cluster name** | ||
- **Source**: Displays the following: | ||
- `UI` for actions executed in the {{ site.data.products.cloud }} Console. | ||
- `API` for actions executed via the [{{ site.data.products.cloud }} API]({% link cockroachcloud/cloud-api.md %}). | ||
- `CRL` for actions executed by Cockroach Labs. | ||
florence-crl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Audit log details | ||
|
||
Click on a log row in the audit logs table to open an **Action details** right sidebar displaying event information, including the full payload in the **Details** section. | ||
florence-crl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## URL Query Parameters | ||
florence-crl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
All selected filters are reflected in the URL query parameters, making it easy to share specific views. For example: | ||
|
||
- `startingFrom` and `endingAt`: Define the selected time range. | ||
- `logId`: Specifies the **Action ID** of an expanded log entry in the sidebar. | ||
|
||
``` | ||
https://cockroachlabs.cloud/audit-logs?startingFrom=2025-03-04T19%3A51%3A36.590Z&endingAt=2025-03-07T19%3A51%3A36.000-05%3A00&logId=78d55b3c-424e-45fa-bbce-03f2ed738897 | ||
``` | ||
|
||
## Examples | ||
florence-crl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
For organization administrators, security teams, and compliance officers, audit logs provide critical insights into system activities. These logs are essential for: | ||
|
||
- Tracking user role changes | ||
- Example: To identify when and by whom an Admin role was assigned, filter by the action `ADD_USER_TO_ROLE`. | ||
- Investigating cluster costs | ||
- Example: To determine who created a cluster and when, filter by the action `CREATE_CLUSTER`. | ||
- Understanding IP allowlisting changes | ||
- Example: To identify why and by whom an IP address was added, filter by the action `ADD_IP_ALLOWLIST`. | ||
- Verifying cluster deletions | ||
- Example: To ensure cluster deletions were intentional, filter by the action `DELETE_CLUSTER`. | ||
- Diagnosing performance issues | ||
- Example: To track configuration changes affecting performance, filter by the action `UPDATE_CLUSTER` | ||
florence-crl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Analyzing security threats | ||
- Example: To investigate failed login attempts and suspicious login activity, filter by the action `USER_LOGIN`. | ||
- Reviewing maintenance schedule changes | ||
- Example: To track modifications to maintenance windows, filter by the actions `SET_CLUSTER_MAINTENANCE_WINDOW` and `DELETE_CLUSTER_MAINTENANCE_WINDOW`. | ||
|
||
## See also | ||
florence-crl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- [Export CockroachDB {{ site.data.products.cloud }} Organization Audit Logs]({% link cockroachcloud/cloud-org-audit-logs.md %}) |
Uh oh!
There was an error while loading. Please reload this page.