Console Audit Logging

TiDB Cloud provides the console audit logging feature to help you track various behaviors and operations of users on the TiDB Cloud console. For example, you can track operations, such as inviting a user to join your organization and creating a cluster.

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:

1. In the TiDB Cloud console, switch to your target organization using the combo box in the upper-left corner.
2. In the left navigation pane, click Console Audit Logging.
3. Click Settings in the upper-right corner, enable console audit logging, and then click Update.

Disable console audit logging

To disable console audit logging, take the following steps:

1. In the TiDB Cloud console, switch to your target organization using the combo box in the upper-left corner.
2. In the left navigation pane, click Console Audit Logging.
3. Click Settings in the upper-right corner, disable console audit logging, and then click Update.

View console audit logs

You can only view the console audit logs of your organization.

1. In the TiDB Cloud console, switch to your target organization using the combo box in the upper-left corner.
2. In the left navigation pane, click Console Audit Logging.
3. To get a specific part of audit logs, you can filter the event type, operation status, and time range.
4. (Optional) To filter more fields, click Advanced filter, add more filters, and then click Apply.
5. Click the row of a log to view its detailed information in the right pane.

Export console audit logs

To export the console audit logs of your organization, take the following step:

1. In the TiDB Cloud console, switch to your target organization using the combo box in the upper-left corner.
2. In the left navigation pane, click Console Audit Logging.
3. (Optional) If you need to export a specific part of console audit logs, you can filter through various conditions. Otherwise, skip this step.
4. Click Download logs and select the desired export format in JSON or CSV.

Console audit log storage policy

The storage time of console audit logs is 90 days, after which the logs will be automatically cleaned up.

Console audit event types

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

Console audit log fields

To help you track user activities, TiDB Cloud provides the following fields for each console audit log: