Skip to content

cloud: add console audit log integrity and access control section - #23445

Open
xboxeer wants to merge 5 commits into
pingcap:release-8.5from
xboxeer:console-audit-integrity
Open

cloud: add console audit log integrity and access control section#23445
xboxeer wants to merge 5 commits into
pingcap:release-8.5from
xboxeer:console-audit-integrity

Conversation

@xboxeer

@xboxeer xboxeer commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

Add a new "Console audit log integrity and access control" section to the console audit logging documentation, describing:

  • Completeness: the audit system records user operations that trigger supported event types when console audit logging is enabled, and log entries are typically available within 60 minutes.
  • Access control: only users with the Organization Owner or Organization Console Audit Manager role can manage console audit logging.

This section clarifies the integrity and access control guarantees of console audit logs for customers with regulatory compliance requirements.

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

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

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

  • This PR is translated from: N/A
  • Other reference link(s): N/A

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

  • Documentation
    • Added guidance on console audit log integrity and access control.
    • Documented audit-log completeness, availability within 60 minutes, recording behavior after enablement, evolving event coverage, and role-based management restrictions.

@ti-chi-bot

ti-chi-bot Bot commented Aug 5, 2026

Copy link
Copy Markdown

[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 assign icemap for approval. 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:

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

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 5, 2026
@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown

Review Change Stack

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

The documentation adds requirements for console audit log completeness, availability within 60 minutes, post-enablement recording, evolving event coverage, and role-based management restrictions.

Changes

Console audit logging

Layer / File(s) Summary
Audit log integrity and access controls
tidb-cloud/tidb-cloud-console-auditing.md
Documents audit log completeness, availability timing, recording after enablement, expanding event coverage, and management restrictions.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested labels: contribution, area/tidb-cloud, needs-1-more-lgtm

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the added console audit log integrity and access control documentation section.
Description check ✅ Passed The description covers the documentation changes, affected version, related links, AI involvement, and applicable change categories.
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 coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 5c637a1a-918b-4d6c-a93e-5579f323a449

📥 Commits

Reviewing files that changed from the base of the PR and between caedeb5 and aca0194.

📒 Files selected for processing (1)
  • tidb-cloud/tidb-cloud-console-auditing.md

Comment thread tidb-cloud/tidb-cloud-console-auditing.md Outdated
Comment thread tidb-cloud/tidb-cloud-console-auditing.md Outdated
>
> Console audit logging records operations that occur after it is enabled. Operations performed before enabling are not recorded. TiDB Cloud continuously expands the coverage of audited event types.

- **Access control**: Only users with the `Organization Owner` or `Organization Console Audit Manager` role can manage console audit logging. Other organization members cannot enable or disable audit logging, modify log settings, or delete logs.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

State that log deletion is unavailable to all users.

Line 75 says that other organization members cannot delete logs. This can imply that Organization Owner or Organization Console Audit Manager users can delete them. Line 63 states that users cannot manually delete audit logs.

Committable replacement
- - **Access control**: Only users with the `Organization Owner` or `Organization Console Audit Manager` role can manage console audit logging. Other organization members cannot enable or disable audit logging, modify log settings, or delete logs.
+ - **Access control**: Only users with the `Organization Owner` or `Organization Console Audit Manager` role can manage console audit logging. Other organization members cannot enable or disable audit logging or modify log settings. No user can manually delete console audit logs.

As per path instructions: provide an exact replacement when the fix is contiguous in the diff.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **Access control**: Only users with the `Organization Owner` or `Organization Console Audit Manager` role can manage console audit logging. Other organization members cannot enable or disable audit logging, modify log settings, or delete logs.
- **Access control**: Only users with the `Organization Owner` or `Organization Console Audit Manager` role can manage console audit logging. Other organization members cannot enable or disable audit logging or modify log settings. No user can manually delete console audit logs.

Source: Path instructions

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 555ee5a4-5f83-4931-b298-defd850800d9

📥 Commits

Reviewing files that changed from the base of the PR and between 0724ff0 and 46371d6.

📒 Files selected for processing (1)
  • tidb-cloud/tidb-cloud-console-auditing.md

Comment thread tidb-cloud/tidb-cloud-console-auditing.md
xboxeer and others added 2 commits August 6, 2026 10:08
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant