Db audit log beta dedicated by ginkgoch · Pull Request #22889 · pingcap/docs

ginkgoch · 2026-05-14T08:31:40Z

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)

We are going to public preview audit log v2, so documents are update accordingly. V1 document is still keep for existing user for reference.

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

Summary by CodeRabbit

New Documentation
- Added “TiDB Cloud Dedicated Database Audit Logging (Legacy)” documentation with enablement prerequisites, AWS/GCS/Azure log forwarding setup, auditing filter rules, disablement behavior, and audit log field schema.
Documentation
- Updated Dedicated Database Audit Logging docs for Public Preview eligibility and revised enable/disable workflows across AWS, GCS, and Azure, including “Test Connection and Save” and updated settings (rotation/redaction, limitations).
- Refreshed guidance on auditing filter rules and table/field breakdowns, and updated the Table of Contents link for audit management.

ti-chi-bot · 2026-05-14T08:31:51Z

Hi @ginkgoch. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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.

gemini-code-assist

Code Review

This pull request updates the TiDB Cloud Dedicated Database Audit Logging documentation to reflect its Public Preview status, introduces a legacy guide, and details new configuration steps for log rotation and redaction. Reviewer feedback focuses on correcting grammatical errors, ensuring terminology consistency for Azure storage, and aligning list formatting and capitalization with the style guide.

ti-chi-bot · 2026-05-14T08:56:25Z

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

Details

In 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.

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

coderabbitai · 2026-07-23T09:24:58Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

📝 Walkthrough

Walkthrough

TiDB Cloud audit logging documentation now covers Public Preview eligibility, updated cloud-storage workflows, settings, limitations, and schemas. A separate legacy reference page was added, and the table of contents now links to both documentation versions.

Changes

Audit Logging Documentation

Layer / File(s)	Summary
Current audit logging workflows and reference `tidb-cloud/tidb-cloud-auditing.md`	Updates eligibility from request-only to Public Preview with version/region criteria, modernizes AWS/GCS/Azure setup steps with "Test Connection and Save" flows, adds database settings sections, updates disabling instructions, and adds event classes, field definitions, limitations, and legacy references.
Legacy audit logging reference `tidb-cloud/tidb-cloud-auditing-legacy.md`	Adds prerequisites, detailed AWS/GCS/Azure cloud storage enablement workflows, filter rule configuration, log retrieval guidance, disabling behavior, and comprehensive audit log field schema with event class variants.
Audit logging navigation `TOC-tidb-cloud.md`	Updates table of contents entry from "TiDB Cloud Dedicated Database Audit Logging" to "Database Audit Logging" while preserving the link target.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested labels: area/tidb-cloud

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title matches the main change: updating dedicated database audit logging docs for the audit log v2 public preview.
Description check	✅ Passed	The description covers the change and target version, and the required sections are present even though reference links and optional checkboxes are left blank.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 3

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2e4c69ef-264f-4f2d-a81b-b9912681f063

📥 Commits

Reviewing files that changed from the base of the PR and between ae49837 and 5eead49.

📒 Files selected for processing (3)

TOC-tidb-cloud.md
tidb-cloud/tidb-cloud-auditing-legacy.md
tidb-cloud/tidb-cloud-auditing.md

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

coderabbitai

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

tidb-cloud/tidb-cloud-auditing.md (1)
112-112: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Fix the bucket-region wording.

“Where the bucket locates” is ungrammatical. Replace it with “where the bucket is located.”
Suggested replacement
-2. In the **Bucket Region** drop-down list, select the AWS region where the bucket locates.
+2. In the **Bucket Region** drop-down list, select the AWS region where the bucket is located.
Source: Path instructions

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 21a4092c-e56f-4943-8465-f1f32f294245

📥 Commits

Reviewing files that changed from the base of the PR and between 5eead49 and ab32441.

📒 Files selected for processing (2)

tidb-cloud/tidb-cloud-auditing-legacy.md
tidb-cloud/tidb-cloud-auditing.md

qiancai · 2026-07-24T08:22:56Z

+| `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.                |
+| `KEYSPACE_NAME` | The keyspace name of the audit record.                                                        |
+| `SERVERLESS_TENANT_ID`           | The ID of the serverless tenant that the {{{ .essential }}} instance belongs to.                 |


This is the Dedicated audit logging page and the prerequisites already direct Essential users to a separate document.

Suggested change

| `SERVERLESS_TENANT_ID` | The ID of the serverless tenant that the {{{ .essential }}} instance belongs to. |

qiancai · 2026-07-24T08:22:57Z

+| `STATUS_CODE`   | The status code of the audit record. `1` means success, and `0` means failure.                |
+| `KEYSPACE_NAME` | The keyspace name of the audit record.                                                        |
+| `SERVERLESS_TENANT_ID`           | The ID of the serverless tenant that the {{{ .essential }}} instance belongs to.                 |
+| `SERVERLESS_PROJECT_ID`          | The ID of the serverless project that the {{{ .essential }}} instance belongs to.                |


Same issue as above: this serverless-only field belongs in the Essential audit logging doc, not the Dedicated doc.

Suggested change

| `SERVERLESS_PROJECT_ID` | The ID of the serverless project that the {{{ .essential }}} instance belongs to. |

qiancai · 2026-07-24T08:22:57Z

+| `KEYSPACE_NAME` | The keyspace name of the audit record.                                                        |
+| `SERVERLESS_TENANT_ID`           | The ID of the serverless tenant that the {{{ .essential }}} instance belongs to.                 |
+| `SERVERLESS_PROJECT_ID`          | The ID of the serverless project that the {{{ .essential }}} instance belongs to.                |
+| `SERVERLESS_CLUSTER_ID`          | The ID of the serverless {{{ .essential }}} instance that the audit record belongs to.           |


Same issue as above: this serverless-only field belongs in the Essential audit logging doc, not the Dedicated doc.

Suggested change

| `SERVERLESS_CLUSTER_ID` | The ID of the serverless {{{ .essential }}} instance that the audit record belongs to. |

ti-chi-bot · 2026-07-24T08:44:27Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from qiancai. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

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

Details

Needs approval from an approver in each of these files:

OWNERS

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

…Log Storage Configuration** dialog

ginkgoch added 5 commits May 14, 2026 11:41

Update the doc of enabling.

8d890c1

Update the general settings.

46722c6

Add event class and fields.

5354d96

Keep legacy doc.

e066a92

Add legacy plugin doc.

ec20d7c

ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels May 14, 2026

gemini-code-assist Bot reviewed May 14, 2026

View reviewed changes

jusong approved these changes May 14, 2026

View reviewed changes

hfxsd added translation/no-need No need to translate this PR. and removed missing-translation-status This PR does not have translation status info. labels May 26, 2026

Apply suggestions from code review

5eead49

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

coderabbitai Bot reviewed Jul 23, 2026

View reviewed changes

Comment thread tidb-cloud/tidb-cloud-auditing-legacy.md Outdated

Comment thread tidb-cloud/tidb-cloud-auditing.md

Comment thread tidb-cloud/tidb-cloud-auditing.md Outdated

ginkgoch and others added 3 commits July 23, 2026 18:24

Add more description to differentiate the legacy doc.

a4e35a2

Apply suggestions from code review

ab32441

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

Remove the legacy link from TOC.

e04a731

coderabbitai Bot reviewed Jul 23, 2026

View reviewed changes

qiancai self-assigned this Jul 24, 2026

qiancai added the area/tidb-cloud This PR relates to the area of TiDB Cloud. label Jul 24, 2026

qiancai reviewed Jul 24, 2026

View reviewed changes

Comment thread tidb-cloud/tidb-cloud-auditing-legacy.md Outdated

qiancai reviewed Jul 24, 2026

View reviewed changes

Apply suggestions from code review

de0f146

Merge branch 'release-8.5' into pr/22889

a4a1659

revise descriptions from user's perspective

9eeeb7e

qiancai reviewed Jul 27, 2026

View reviewed changes

Comment thread tidb-cloud/tidb-cloud-auditing-legacy.md Outdated

qiancai added 3 commits July 27, 2026 10:13

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

fa0ebe1

the **Enable Database Audit Logging** dialog -> the **Database Audit …

5736da8

…Log Storage Configuration** dialog

add links to AWS Management Console and Google Cloud console

45ffbc6

Uh oh!

Conversation

ginkgoch commented May 14, 2026 • edited by coderabbitai Bot 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?

Summary by CodeRabbit

Uh oh!

ti-chi-bot Bot commented May 14, 2026

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!

ti-chi-bot Bot commented May 14, 2026

Uh oh!

coderabbitai Bot commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot 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!

qiancai Jul 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

qiancai Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

qiancai Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

ti-chi-bot Bot commented Jul 24, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ginkgoch commented May 14, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 23, 2026 •

edited

Loading

qiancai Jul 24, 2026 •

edited

Loading