|
| 1 | +--- |
| 2 | +title: View Organization Audit Logs in the Cloud Console |
| 3 | +summary: Learn how to view CockroachDB Cloud organization audit logs in the Cloud Console. |
| 4 | +toc: true |
| 5 | +docs_area: manage |
| 6 | +cloud: true |
| 7 | +--- |
| 8 | + |
| 9 | +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. |
| 10 | + |
| 11 | +## View audit logs |
| 12 | + |
| 13 | +To access the **Audit Logs** page: |
| 14 | + |
| 15 | +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). |
| 16 | +1. In the top navigation bar, open the **Organization** menu and select **Audit Logs**. |
| 17 | + |
| 18 | +## Filter audit logs |
| 19 | + |
| 20 | +Filter the audit logs by the following fields: |
| 21 | + |
| 22 | +- **Time Range (UTC)**: |
| 23 | + - Default: Last 48 hours. |
| 24 | + - To set the time range, click the **Time Range (UTC)** field. You can select a **Start date** and **End date** from the displayed calendar or manually enter dates and times for the range. |
| 25 | +- **User email**: Select one or more email addresses from the list of [organization members]({% link cockroachcloud/managing-access.md %}#manage-an-organizations-users) (optional). |
| 26 | +- **Action name**: Select one or more predefined auditable actions (optional). |
| 27 | +- **Cluster name**: Select one or more cluster names (optional). |
| 28 | + |
| 29 | +## Audit Logs table |
| 30 | + |
| 31 | +If audit logs are found for the filter selections, a table is displayed with the following columns: |
| 32 | + |
| 33 | +- **Time (UTC)** |
| 34 | +- **User**: Displays the following: |
| 35 | + |
| 36 | + - User's email if **Source** is `UI`. |
| 37 | + - [Service account name]({% link cockroachcloud/managing-access.md %}#manage-service-accounts) if **Source** is `API`. *(Note: You cannot filter by service account name.)* |
| 38 | + - `CRL User` if **Source** is `CRL`. *(Note: You cannot filter by `CRL User`.)* |
| 39 | +- **Action name** |
| 40 | +- **Cluster name** |
| 41 | +- **Source**: Displays the following: |
| 42 | + |
| 43 | + - `UI` for actions executed in the {{ site.data.products.cloud }} Console. |
| 44 | + - `API` for actions executed via the [{{ site.data.products.cloud }} API]({% link cockroachcloud/cloud-api.md %}). |
| 45 | + - `CRL` for actions executed by Cockroach Labs. |
| 46 | + |
| 47 | +## Audit log details |
| 48 | + |
| 49 | +Click a row in the Audit Logs table to open the **Action details** panel, which displays event information, including the full payload in the Details section. |
| 50 | + |
| 51 | +## URL query parameters |
| 52 | + |
| 53 | +All selected filters are reflected in the URL query parameters, making it easy to share specific views. For example: |
| 54 | + |
| 55 | +- `startingFrom` and `endingAt`: Define the selected time range. |
| 56 | +- `logId`: Specifies the **Action ID** of an expanded log entry in the sidebar. |
| 57 | + |
| 58 | +``` |
| 59 | +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 |
| 60 | +``` |
| 61 | + |
| 62 | +## Example use cases |
| 63 | + |
| 64 | +For organization administrators, security teams, and compliance officers, audit logs provide critical insights into system activities. These logs are essential for: |
| 65 | + |
| 66 | +- Tracking user role changes |
| 67 | + - Example: To identify when and by whom an Admin role was assigned, filter by the action `ADD_USER_TO_ROLE`. |
| 68 | +- Investigating cluster costs |
| 69 | + - Example: To determine who created a cluster and when, filter by the action `CREATE_CLUSTER`. |
| 70 | +- Understanding IP allowlisting changes |
| 71 | + - Example: To identify why and by whom an IP address was added, filter by the action `ADD_IP_ALLOWLIST`. |
| 72 | +- Verifying cluster deletions |
| 73 | + - Example: To ensure cluster deletions were intentional, filter by the action `DELETE_CLUSTER`. |
| 74 | +- Diagnosing performance issues |
| 75 | + - Example: To track configuration changes affecting performance, filter by the action `UPDATE_CLUSTER`. |
| 76 | +- Analyzing security threats |
| 77 | + - Example: To investigate failed login attempts and suspicious login activity, filter by the action `USER_LOGIN`. |
| 78 | +- Reviewing maintenance schedule changes |
| 79 | + - Example: To track modifications to maintenance windows, filter by the actions `SET_CLUSTER_MAINTENANCE_WINDOW` and `DELETE_CLUSTER_MAINTENANCE_WINDOW`. |
| 80 | + |
| 81 | +## See also |
| 82 | + |
| 83 | +- [Export CockroachDB {{ site.data.products.cloud }} Organization Audit Logs]({% link cockroachcloud/cloud-org-audit-logs.md %}) |
0 commit comments