Skip to content
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

DOC-11808 Docs for Audit Logs Page for Customers #19428

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,11 @@
"urls": [
"/cockroachcloud/sql-audit-logging.html"
]
}, {
"title": "View Organization Audit Logs in Cloud Console",
"urls": [
"/cockroachcloud/organization-audit-logs-in-cloud-console.html"
]
},
{
"title": "Export Cloud Organization Audit Logs",
Expand Down
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 an account 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.

## Filter audit logs
Filter the audit logs by the following fields:

- **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.
- **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).
- **Cluster name**: Select one or more cluster names (optional).

## Audit logs table

If audit logs are found for the filter selections, a table will be displayed with the following columns:

- **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.)*
- **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.

## 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.

## URL Query Parameters

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

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`
- 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
- [Export CockroachDB {{ site.data.products.cloud }} Organization Audit Logs]({% link cockroachcloud/cloud-org-audit-logs.md %})
4 changes: 4 additions & 0 deletions src/current/releases/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ CockroachDB v25.1 is now generally available for select CockroachDB Cloud {{ sit
- [CockroachDB (pay-as-you-go)](https://console.cloud.google.com/marketplace/product/cockroachlabs/cockroachdb-pay-as-you-go) on the Google Cloud Marketplace.
- [Subscribe through the Google Cloud Marketplace]({% link cockroachcloud/billing-management.md %}?filters=gcp#subscribe-through-aws-marketplace) in the CockroachDB {{ site.data.products.cloud }} documentation.

## December 3, 2024

You can now use the CockroachDB {{ site.data.products.cloud }} Console to [view and filter organization-level audit logs]({% link cockroachcloud/organization-audit-logs-in-cloud-console.md %}), providing greater visibility into user activity across your organization.

## December 1, 2024

As of December 1, 2024, [updated pricing](https://www.cockroachlabs.com/pricing/new/) that was recently [announced](https://www.cockroachlabs.com/blog/improved-cockroachdb-cloud-pricing/) for CockroachDB Cloud is now in effect for all customers except those with annual or multi-year contracts that began prior to December 1, 2024. For those customers, the updated pricing, including new usage-based costs, goes into effect upon contract renewal. Prior to renewal, line items for usage of data transfer, backups, and changefeeds are displayed in the [Billing](https://cockroachlabs.cloud/billing) interface and on invoices with a $0 charge, while showing actual usage metrics to help estimate future costs.
Expand Down
Loading