| title | summary |
|---|---|
Console Audit Logging |
Learn about the audit logging feature for the TiDB Cloud console. |
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.
- You must be in the
Organization OwnerorOrganization Console Audit Adminrole 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.
The console audit logging feature is disabled by default. To enable it, take the following steps:
- In the lower-left corner of the TiDB Cloud console, click , and then click Console Audit Logging.
- Click Settings in the upper-right corner, and then enable console audit logging.
To disable console audit logging, take the following steps:
- In the lower-left corner of the TiDB Cloud console, click , and then click Console Audit Logging.
- Click Settings in the upper-right corner, and then disable console audit logging.
You can only view the console audit logs of your organization.
Note:
- If it is the first time your organization enables console audit logging, the console audit logs are empty. After any audited events are performed, you will see the corresponding logs.
- If it has been more than 90 days since console audit logging was disabled, you cannot see any logs.
- In the lower-left corner of the TiDB Cloud console, click , and then click Console Audit Logging.
- To get a specific part of audit logs, you can filter the event type, operation status, and time range.
- (Optional) To filter more fields, click Advanced filter, add more filters, and then click Apply.
- Click the row of a log to view its detailed information in the right pane.
To export the console audit logs of your organization, take the following step:
- In the lower-left corner of the TiDB Cloud console, click , and then click Console Audit Logging.
- (Optional) If you need to export a specific part of console audit logs, you can filter through various conditions. Otherwise, skip this step.
- Click Export and select the desired export format in JSON or CSV.
The storage time of console audit logs is 90 days, after which the logs will be automatically cleaned up.
Note:
- You cannot specify the storage location of console audit logs in TiDB Cloud.
- You cannot manually delete audit logs.
The console audit logs record various user activities on the TiDB Cloud console through event types.
Note:
Currently, most event types on the TiDB Cloud console can be audited, and you can find them in the following table. For the remaining event types that are not covered yet, TiDB Cloud will continuously work on including them as well.
| Console audit event type | Description |
|---|---|
| CreateOrganization | Create an organization |
| LoginOrganization | Log in to an organization |
| SwitchOrganization | Switch from the current organization to another organization |
| LogoutOrganization | Log out from an organization |
| InviteUserToOrganization | Invite a user to join the organization |
| DeleteInvitationToOrganization | Delete a user's invitation to join the organization |
| ResendInvitationToOrganization | Resend an invitation for a user to join the organization |
| ConfirmJoinOrganization | The invited user confirms joining the organization |
| DeleteUserFromOrganization | Delete a joined user from the organization |
| UpdateUserRoleInOrganization | Update the role of a user in the organization |
| CreateAPIKey | Create an API Key |
| EditAPIKey | Edit an API Key |
| DeleteAPIKey | Delete an API Key |
| UpdateTimezone | Update the time zone of your organization |
| ShowBill | Show organization bill |
| DownloadBill | Download organization bill |
| ShowCredits | Show organization credits |
| AddPaymentCard | Add a payment card |
| UpdatePaymentCard | Update a payment card |
| DeletePaymentCard | Delete a payment card |
| SetDefaultPaymentCard | Set a default payment card |
| EditBillingProfile | Edit billing profile information |
| ContractAction | Organize contract-related activities |
| EnableConsoleAuditLog | Enable console audit logging |
| ShowConsoleAuditLog | Show console audit logs |
| InviteUserToProject | Invite a user to join a project |
| DeleteInvitationToProject | Delete a user's invitation to join the project |
| ResendInvitationToProject | Resend an invitation for a user to join the project |
| ConfirmJoinProject | The invited user confirms joining the project |
| DeleteUserFromProject | Delete a joined user from the project |
| CreateProject | Create a project |
| CreateProjectCIDR | Create a new project CIDR |
| CreateAWSVPCPeering | Create an AWS VPC Peering |
| DeleteAWSVPCPeering | Delete an AWS VPC Peering |
| CreateGCPVPCPeering | Create a Google Cloud VPC Peering |
| DeleteGCPVPCPeering | Delete a Google Cloud VPC Peering |
| CreatePrivateEndpointService | Create private endpoint service |
| DeletePrivateEndpointService | Delete private endpoint service |
| CreateAWSPrivateEndPoint | Create an AWS private endpoint |
| DeleteAWSPrivateEndPoint | Delete AWS private endpoint |
| SubscribeAlerts | Subscribe alerts |
| UnsubscribeAlerts | Unsubscribe alerts |
| CreateDatadogIntegration | Create datadog integration |
| DeleteDatadogIntegration | Delete datadog integration |
| CreateVercelIntegration | Create vercel integration |
| DeleteVercelIntegration | Delete vercel integration |
| CreatePrometheusIntegration | Create Prometheus integration |
| DeletePrometheusIntegration | Delete Prometheus integration |
| CreateCluster | Create a cluster |
| DeleteCluster | Delete a cluster |
| PauseCluster | Pause a cluster |
| ResumeCluster | Resume a cluster |
| ScaleCluster | Scale a cluster |
| DownloadTiDBClusterCA | Download CA certificate |
| OpenWebSQLConsole | Connect to a TiDB cluster through Web SQL |
| SetRootPassword | Set the root password of a TiDB cluster |
| UpdateIPAccessList | Update the IP access list of a TiDB cluster |
| SetAutoBackup | Set the automatic backup mechanism of a TiDB cluster |
| DoManualBackup | Perform a manual backup of TiDB cluster |
| DeleteBackupTask | Delete a backup task |
| DeleteBackup | Delete a backup file |
| RestoreFromBackup | Restore to a TiDB cluster based on the backup files |
| RestoreFromTrash | Restore to a TiDB cluster based on the backup files in the trash |
| ImportDataFromAWS | Import data from AWS |
| ImportDataFromGCP | Import data from Google Cloud |
| ImportDataFromLocal | Import data from local disks |
| CreateMigrationJob | Create a migration job |
| SuspendMigrationJob | Suspend a migration job |
| ResumeMigrationJob | Resume a migration job |
| DeleteMigrationJob | Delete a migration job |
| ShowDiagnose | Show diagnosis information |
| DBAuditLogAction | Set the activity of database audit logging |
| AddDBAuditFilter | Add a database audit log filter |
| DeleteDBAuditFilter | Delete a database audit log filter |
| EditProject | Edit the information of a project |
| DeleteProject | Delete a project |
| BindSupportPlan | Bind a support plan |
| CancelSupportPlan | Cancel a support plan |
| UpdateOrganizationName | Update the organization name |
| SetSpendLimit | Edit the spending limit of a TiDB Cloud Serverless scalable cluster |
| UpdateMaintenanceWindow | Modify maintenance window start time |
| DeferMaintenanceTask | Defer a maintenance task |
| CreateBranch | Create a TiDB Cloud Serverless branch |
| DeleteBranch | Delete a TiDB Cloud Serverless branch |
| SetBranchRootPassword | Set root password for a TiDB Cloud Serverless branch |
| ConnectBranchGitHub | Connect the cluster with a GitHub repository to enable branching integration |
| DisconnectBranchGitHub | Disconnect the cluster from a GitHub repository to disable branching integration |
To help you track user activities, TiDB Cloud provides the following fields for each console audit log:
| Field name | Data type | Description |
|---|---|---|
| type | string | Event type |
| ends_at | timestamp | Event time |
| operator_type | enum | Operator type: user or api_key |
| operator_id | uint64 | Operator ID |
| operator_name | string | Operator name |
| operator_ip | string | Operator's IP address |
| operator_login_method | enum | Operator's login method: google, github, microsoft, email, or api_key |
| org_id | uint64 | Organization ID to which the event belongs |
| org_name | string | Organization name to which the event belongs |
| project_id | uint64 | Project ID to which the event belongs |
| project_name | string | Project name to which the event belongs |
| cluster_id | uint64 | Cluster ID to which the event belongs |
| cluster_name | string | Cluster name to which the event belongs |
| trace_id | string | Trace ID of the request initiated by the operator. This field is empty currently and will be available in future releases. |
| result | enum | Event result: success or failure |
| details | json | Detailed description of the event |