Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions tidb-cloud/tidb-cloud-console-auditing.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@ TiDB Cloud provides the console audit logging feature to help you track various
## Prerequisites

- You must be in the `Organization Owner` or `Organization Console Audit Manager` role of your organization in TiDB Cloud. Otherwise, you cannot see the console audit logging-related options in the TiDB Cloud console.
- You can only enable and disable the console audit logging for your organization. You can only track the actions of users in your organization.
- After the console audit logging is enabled, all event types of the TiDB Cloud console will be audited, and you cannot specify only auditing some of them.

## Enable console audit logging

The console audit logging feature is disabled by default. To enable it, take the following steps:
The console audit logging feature is disabled by default. After it is enabled, all supported event types of the TiDB Cloud console will be audited, and you cannot specify only auditing some of them. To enable it, take the following steps:

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target organization using the combo box in the upper-left corner.
2. In the left navigation pane, click **Console Audit Logging**.
Expand Down Expand Up @@ -62,6 +60,18 @@ The storage time of console audit logs is 90 days, after which the logs will be
> - You cannot specify the storage location of console audit logs in TiDB Cloud.
> - You cannot manually delete audit logs.

## Console audit log integrity and access control

To help you meet regulatory compliance requirements, TiDB Cloud provides the following measures for console audit logging:

- **Completeness**: When console audit logging is enabled for your organization, the audit system records user operations that trigger the [supported event types](#console-audit-event-types). Log entries are typically available for viewing, download, and programmatic access via the API within 60 minutes of the event occurrence.

> **Note:**
>
> Console audit logging records every occurrence of supported event types that occur after it is enabled. Operations performed before enabling are not recorded. TiDB Cloud continuously expands the coverage of audited event types.
Comment thread
coderabbitai[bot] marked this conversation as resolved.

- **Access control**: Only users with the `Organization Owner` or `Organization Console Audit Manager` role of your organization can manage console audit logging for your organization. Other organization members cannot enable or disable audit logging or modify log settings.

## Console audit event types

The console audit logs record various user activities on the TiDB Cloud console through event types.
Expand Down