Open
Conversation
ti-chi-bot
Bot
added
missing-translation-status
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the audit logging documentation for TiDB Cloud Premium by restructuring field descriptions into categorized tables and adding several new fields, including ROLES, KEYSPACE_NAME, and serverless-specific identifiers. It also introduces a note on real client IP visibility for AWS PrivateLink and a section on logging limitations. Review feedback addressed the use of an incorrect variable, grammatical errors, and missing backticks for technical terms like DISCONNECT and TIME.
ginkgoch
reviewed
Apr 22, 2026
ginkgoch
reviewed
Apr 22, 2026
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…ngcap/docs into Premium-audit-log-page-change
ginkgoch
approved these changes
Apr 22, 2026
|
@ginkgoch: adding LGTM is restricted to approvers and reviewers in OWNERS files. DetailsIn response to this: Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Oreoxmt
added
area/tidb-cloud
ti-chi-bot
Bot
removed
the
missing-translation-status
Collaborator
|
/cc @Oreoxmt |
Oreoxmt
changed the title
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Oreoxmt
reviewed
Apr 24, 2026
Comment on lines
+246
to
+253
| | `ID` | The unique identifier that identifies the audit record of an operation. | | ||
| | `EVENT` | The event classes of the audit record. Multiple event types are separated by commas (`,`). | | ||
| | `USER` | The username of the audit record. | | ||
| | `ROLES` | The roles of the user at the time of the operation. | | ||
| | `CONNECTION_ID` | The identifier of the user's connection. | | ||
| | `TABLES` | The accessed tables related to this audit record. | | ||
| | `STATUS_CODE` | The status code of the audit record. `1` means success, and `0` means failure. | | ||
| | `REASON` | The error message of the audit record. Only recorded when an error occurs during the operation.| |
Collaborator
There was a problem hiding this comment.
Suggested change
| | `ID` | The unique identifier that identifies the audit record of an operation. | | |
| | `EVENT` | The event classes of the audit record. Multiple event types are separated by commas (`,`). | | |
| | `USER` | The username of the audit record. | | |
| | `ROLES` | The roles of the user at the time of the operation. | | |
| | `CONNECTION_ID` | The identifier of the user's connection. | | |
| | `TABLES` | The accessed tables related to this audit record. | | |
| | `STATUS_CODE` | The status code of the audit record. `1` means success, and `0` means failure. | | |
| | `REASON` | The error message of the audit record. Only recorded when an error occurs during the operation.| | |
| | `ID` | The unique identifier of the audit record. | | |
| | `EVENT` | The event classes of the audit record. Multiple event classes are separated by commas (`,`). | | |
| | `USER` | The name of the user who performed the operation. | | |
| | `ROLES` | The roles assigned to the user at the time of the operation. | | |
| | `CONNECTION_ID` | The identifier of the user's connection. | | |
| | `TABLES` | The tables accessed during the operation. | | |
| | `STATUS_CODE` | The status code of the operation. `1` indicates success, and `0` indicates failure. | | |
| | `REASON` | The error message of the operation. Recorded only when an error occurs. | |
Oreoxmt
reviewed
Apr 24, 2026
Comment on lines
+262
to
+264
| | `SQL_TEXT` | The executed SQL statements. If audit log redaction is enabled, the redacted SQL statements are recorded. | | ||
| | `EXECUTE_PARAMS` | The parameters for the `EXECUTE` statements. Recorded only when the event classes include `EXECUTE` and redaction is disabled. | | ||
| | `AFFECTED_ROWS` | The number of affected rows of the SQL statements. Recorded only when the event classes include `QUERY_DML`. | |
Collaborator
There was a problem hiding this comment.
Suggested change
| | `SQL_TEXT` | The executed SQL statements. If audit log redaction is enabled, the redacted SQL statements are recorded. | | |
| | `EXECUTE_PARAMS` | The parameters for the `EXECUTE` statements. Recorded only when the event classes include `EXECUTE` and redaction is disabled. | | |
| | `AFFECTED_ROWS` | The number of affected rows of the SQL statements. Recorded only when the event classes include `QUERY_DML`. | | |
| | `SQL_TEXT` | The executed SQL statement. If audit log redaction is enabled, the redacted statement is recorded instead. | | |
| | `EXECUTE_PARAMS` | The parameters passed to the `EXECUTE` statement. Recorded only when the event classes include `EXECUTE` and redaction is disabled. | | |
| | `AFFECTED_ROWS` | The number of rows affected by the SQL statement. Recorded only when the event classes include `QUERY_DML`. | |
Oreoxmt
reviewed
Apr 24, 2026
Comment on lines
+272
to
+280
| | `CURRENT_DB` | The name of the current database. When the event classes include `DISCONNECT`, this information is not recorded. | | ||
| | `CONNECTION_TYPE` | The type of connection, including Socket, UnixSocket, and SSL/TLS. | | ||
| | `PID` | The process ID of the current connection. | | ||
| | `SERVER_VERSION` | The current version of the connected TiDB server. | | ||
| | `SSL_VERSION` | The current version of SSL in use. | | ||
| | `HOST_IP` | The current IP address of the connected TiDB server. | | ||
| | `HOST_PORT` | The current port of the connected TiDB server. | | ||
| | `CLIENT_IP` | The current IP address of the client. | | ||
| | `CLIENT_PORT` | The current port of the client. | |
Collaborator
There was a problem hiding this comment.
Suggested change
| | `CURRENT_DB` | The name of the current database. When the event classes include `DISCONNECT`, this information is not recorded. | | |
| | `CONNECTION_TYPE` | The type of connection, including Socket, UnixSocket, and SSL/TLS. | | |
| | `PID` | The process ID of the current connection. | | |
| | `SERVER_VERSION` | The current version of the connected TiDB server. | | |
| | `SSL_VERSION` | The current version of SSL in use. | | |
| | `HOST_IP` | The current IP address of the connected TiDB server. | | |
| | `HOST_PORT` | The current port of the connected TiDB server. | | |
| | `CLIENT_IP` | The current IP address of the client. | | |
| | `CLIENT_PORT` | The current port of the client. | | |
| | `CURRENT_DB` | The name of the current database. Not recorded when the event classes include `DISCONNECT`. | | |
| | `CONNECTION_TYPE` | The type of the connection, such as Socket, UnixSocket, or SSL/TLS. | | |
| | `PID` | The process ID of the current connection. | | |
| | `SERVER_VERSION` | The version of the connected TiDB server. | | |
| | `SSL_VERSION` | The version of SSL in use. | | |
| | `HOST_IP` | The IP address of the connected TiDB server. | | |
| | `HOST_PORT` | The port of the connected TiDB server. | | |
| | `CLIENT_IP` | The IP address of the client. | | |
| | `CLIENT_PORT` | The port of the client. | |
Oreoxmt
reviewed
Apr 24, 2026
| | 18 | COMMAND | VARCHAR | 14 | The command type of the MySQL protocol | | ||
| | 19 | SQL_STATEMENT | VARCHAR | 17 | The SQL statement type | | ||
| | 20 | PID | INTEGER | | The PID of the TiDB process | | ||
| > To improve traffic visibility, `CLIENT_IP` now displays the real client IP address for connections via AWS PrivateLink, instead of the Load Balancer (LB) IP. Currently, this feature is in beta and is available only in the AWS region `Frankfurt (eu-central-1)`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| > To improve traffic visibility, `CLIENT_IP` now displays the real client IP address for connections via AWS PrivateLink, instead of the Load Balancer (LB) IP. Currently, this feature is in beta and is available only in the AWS region `Frankfurt (eu-central-1)`. | |
| > To improve traffic visibility, `CLIENT_IP` displays the actual client IP address for connections through AWS PrivateLink instead of the load balancer IP. This feature is in beta and is available only in the AWS region `Frankfurt (eu-central-1)`. |
Oreoxmt
reviewed
Apr 24, 2026
Comment on lines
+292
to
+293
| | `AUDIT_OP_TARGET`| The objects of the setting related to TiDB Cloud database auditing. | | ||
| | `AUDIT_OP_ARGS` | The arguments of the setting related to TiDB Cloud database auditing. | |
Collaborator
There was a problem hiding this comment.
Suggested change
| | `AUDIT_OP_TARGET`| The objects of the setting related to TiDB Cloud database auditing. | | |
| | `AUDIT_OP_ARGS` | The arguments of the setting related to TiDB Cloud database auditing. | | |
| | `AUDIT_OP_TARGET`| The target object of the TiDB Cloud database audit setting change. | | |
| | `AUDIT_OP_ARGS` | The arguments used in the TiDB Cloud database audit setting change. | |
Oreoxmt
reviewed
Apr 24, 2026
|
|
||
| ## Audit logging limitations | ||
|
|
||
| {{{ .premium }}} does not guarantee the sequential order of audit logs, which means that you might have to review all log files to find the most recent events. To sort the logs chronologically, you can use the `TIME` field in the audit logs. |
Collaborator
There was a problem hiding this comment.
Suggested change
| {{{ .premium }}} does not guarantee the sequential order of audit logs, which means that you might have to review all log files to find the most recent events. To sort the logs chronologically, you can use the `TIME` field in the audit logs. | |
| {{{ .premium }}} does not guarantee that audit logs are written in chronological order. To find the most recent events, you might need to review all log files. To sort logs chronologically, use the `TIME` field in each audit record. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?