premium: add database audit logging #22044

wildpcww · 2025-11-12T03:47:12Z

First-time contributors' checklist

I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

What is changed, added or deleted? (Required)

Add a doc for TiDB Cloud Premium database audit logging.

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)?

This PR is translated from:
Other reference link(s):

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

gemini-code-assist · 2025-11-12T03:47:25Z

Summary of Changes

Hello @wildpcww, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces new documentation for the TiDB Cloud Premium Database Audit Logging feature. The added content provides users with a comprehensive guide on how to enable, configure, and manage audit logs across various cloud providers, including AWS, Google Cloud, and Azure. It also details the structure of the audit log fields, ensuring users can effectively analyze database access and activity for security and compliance purposes.

Highlights

New Documentation for TiDB Cloud Premium Audit Logging: A new markdown file, tidb-cloud-auditing-premium.md, has been added to provide comprehensive documentation for the TiDB Cloud Premium Database Audit Logging feature.
Detailed Multi-Cloud Integration Guide: The document includes step-by-step instructions for enabling and configuring audit logging to integrate with various cloud storage services, specifically AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage.
Audit Log Structure and Fields Defined: The new documentation clearly outlines the structure and fields of the audit logs, detailing common fields and additional fields specific to CONNECTION, TABLE_ACCESS, or GENERAL event classes.
Discrepancy Noted in Cloud Provider Section: The section titled 'Enable audit logging for Alibaba Cloud' incorrectly describes the process for Google Cloud Storage (GCS) instead of Alibaba Cloud. This requires review and correction.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces a new documentation page for TiDB Cloud Premium Database Audit Logging. The document is well-structured and provides detailed setup instructions for AWS, Google Cloud, and Azure. My review focuses on correcting a critical error where Google Cloud instructions were mislabeled under an "Alibaba Cloud" heading, fixing various grammatical mistakes (such as using "a instance" instead of "an instance"), and enhancing overall clarity and consistency throughout the document. I have provided specific code suggestions for each point to facilitate quick improvements.

tidb-cloud/premium/tidb-cloud-auditing-premium.md

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

…nto pr/22044

tennix · 2025-11-12T10:35:41Z

tidb-cloud/premium/tidb-cloud-auditing-premium.md

+
+TiDB Cloud audit logs are readable text files with the instance ID, Pod ID, and log creation date incorporated into the fully qualified filenames.
+
+For example, `13796619446086334065/tidb-0/tidb-audit-2022-04-21T18-16-29.529.log`. In this example, `13796619446086334065` indicates the instance ID and `tidb-0` indicates the Pod ID.


For premium TiDB, the audit log does not name as tidb-0, besides don't use Pod here.

qiancai

Rest LGTM

tidb-cloud/tidb-cloud-auditing.md

tidb-cloud/premium/tidb-cloud-auditing-premium.md

Co-authored-by: Grace Cai <qqzczy@126.com>

tidb-cloud/essential-database-audit-logging.md

tidb-cloud/premium/tidb-cloud-auditing-premium.md

tennix

LGTM

ti-chi-bot · 2025-11-13T03:41:27Z

@tennix: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

LGTM

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.

tidb-cloud/premium/tidb-cloud-auditing-premium.md

lilin90

/lgtm

ti-chi-bot · 2025-11-13T03:46:28Z

[LGTM Timeline notifier]

Timeline:

2025-11-13 01:48:16.988800593 +0000 UTC m=+925946.431830472: ☑️ agreed by qiancai.
2025-11-13 03:46:27.512868424 +0000 UTC m=+933036.955898303: ☑️ agreed by lilin90.

lilin90 · 2025-11-13T03:52:23Z

/approve

ti-chi-bot · 2025-11-13T03:52:31Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lilin90

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [lilin90]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

lilin90 · 2025-11-13T06:13:51Z

/hold

lilin90 · 2025-11-13T08:38:16Z

/unhold

ti-chi-bot · 2025-11-13T08:38:28Z

@lilin90: We have migrated to builtin LGTM and approve plugins for reviewing.

👉 Please use /approve when you want to approve this pull request.

The changes announcement: LGTM plugin changes

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 ti-community-infra/tichi repository.

Create tidb-cloud-auditing-premium.md

a20707a

ti-chi-bot bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. labels Nov 12, 2025

ti-chi-bot bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Nov 12, 2025

lilin90 added area/tidb-cloud This PR relates to the area of TiDB Cloud. for-cloud-release This PR is related to TiDB Cloud release. labels Nov 12, 2025

lilin90 self-assigned this Nov 12, 2025

gemini-code-assist bot reviewed Nov 12, 2025

View reviewed changes

Update tidb-cloud-auditing-premium.md

502327b

lilin90 reviewed Nov 12, 2025

View reviewed changes

lilin90 and others added 2 commits November 12, 2025 14:19

Refine wording and format

0117999

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

*: refine wording, fix format, update toc

69f55db

lilin90 changed the title ~~Create tidb-cloud-auditing-premium.md~~ premium: add database audit logging Nov 12, 2025

wildpcww and others added 10 commits November 12, 2025 14:56

Update tidb-cloud/premium/tidb-cloud-auditing-premium.md

8b94e02

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Update tidb-cloud/premium/tidb-cloud-auditing-premium.md

18413e0

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Update wording

c7a594b

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Update toc

2797b75

Merge branch 'auditlog-primium' of https://github.com/wildpcww/docs i…

cfcd8ee

…nto pr/22044

Update tidb-cloud-auditing-premium.md

2dcab32

Update wording

844c087

Update wording for consistency

7443222

Update TOC-tidb-cloud-premium.md

994db6f

Update grammar

727a053

lilin90 requested a review from tennix November 12, 2025 08:53

lilin90 added 2 commits November 12, 2025 17:03

Update wording for consistency

8e19ccb

Add a note

399bfbe

lilin90 added the translation/no-need No need to translate this PR. label Nov 12, 2025

ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Nov 12, 2025

tennix reviewed Nov 12, 2025

View reviewed changes

qiancai approved these changes Nov 13, 2025

View reviewed changes

ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Nov 13, 2025

qiancai reviewed Nov 13, 2025

View reviewed changes

tidb-cloud/premium/tidb-cloud-auditing-premium.md Show resolved Hide resolved

qiancai reviewed Nov 13, 2025

View reviewed changes

tidb-cloud/premium/tidb-cloud-auditing-premium.md Outdated Show resolved Hide resolved

lilin90 and others added 2 commits November 13, 2025 10:02

Apply suggestions from code review

73465c9

Co-authored-by: Grace Cai <qqzczy@126.com>

Apply suggestions from code review

9fe22f9

Co-authored-by: Grace Cai <qqzczy@126.com>

qiancai reviewed Nov 13, 2025

View reviewed changes

tidb-cloud/essential-database-audit-logging.md Outdated Show resolved Hide resolved

qiancai reviewed Nov 13, 2025

View reviewed changes

tidb-cloud/premium/tidb-cloud-auditing-premium.md Outdated Show resolved Hide resolved

lilin90 and others added 4 commits November 13, 2025 10:20

Update wording

da08721

Add customcontent for alibaba cloud

321ba0b

Update anchor link wording

122693a

description change

377acf2

tennix approved these changes Nov 13, 2025

View reviewed changes

lilin90 reviewed Nov 13, 2025

View reviewed changes

tidb-cloud/premium/tidb-cloud-auditing-premium.md Outdated Show resolved Hide resolved

Update capitalization for style consistency

1cb5fab

lilin90 approved these changes Nov 13, 2025

View reviewed changes

ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Nov 13, 2025

ti-chi-bot bot added the approved label Nov 13, 2025

ti-chi-bot bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 13, 2025

ti-chi-bot bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 13, 2025

ti-chi-bot bot merged commit 5a33f42 into pingcap:release-8.5 Nov 13, 2025
8 of 9 checks passed


		TiDB Cloud audit logs are readable text files with the instance ID, Pod ID, and log creation date incorporated into the fully qualified filenames.

		For example, `13796619446086334065/tidb-0/tidb-audit-2022-04-21T18-16-29.529.log`. In this example, `13796619446086334065` indicates the instance ID and `tidb-0` indicates the Pod ID.

premium: add database audit logging #22044

premium: add database audit logging #22044

Uh oh!

Conversation

wildpcww commented Nov 12, 2025 • edited by lilin90 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

Uh oh!

gemini-code-assist bot commented Nov 12, 2025

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tennix Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

qiancai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tennix left a comment

Choose a reason for hiding this comment

Uh oh!

ti-chi-bot bot commented Nov 13, 2025

Uh oh!

Uh oh!

lilin90 left a comment

Choose a reason for hiding this comment

Uh oh!

ti-chi-bot bot commented Nov 13, 2025

[LGTM Timeline notifier]

Uh oh!

lilin90 commented Nov 13, 2025

Uh oh!

ti-chi-bot bot commented Nov 13, 2025

Uh oh!

lilin90 commented Nov 13, 2025

Uh oh!

lilin90 commented Nov 13, 2025

Uh oh!

ti-chi-bot bot commented Nov 13, 2025

Uh oh!

Uh oh!

wildpcww commented Nov 12, 2025 •

edited by lilin90

Loading