Skip to content

docs: add TiCDC log redaction configuration - #24097

Open
asddongmen wants to merge 5 commits into
pingcap:masterfrom
asddongmen:docs/ticdc-log-redaction
Open

asddongmen wants to merge 5 commits into
pingcap:masterfrom
asddongmen:docs/ticdc-log-redaction

Conversation

@asddongmen

@asddongmen asddongmen commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

What is changed, added or deleted? (Required)

  • Document the TiCDC [security] redact-info-log configuration parameter and its default and supported redaction modes.
  • Clarify that this configuration is available only in the TiCDC new architecture, starting from TiCDC v8.5.6.
  • Add TiCDC guidance to the log redaction overview.

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

  • master (the latest development version)
  • TiCDC v8.5.6 and later in the 8.5 release line (tracked by the needs-cherry-pick-release-8.5 label)

What is the related PR or file 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

  • Documentation
    • Documented TiCDC log redaction support for the new architecture, available starting with TiCDC v8.5.6. Redaction is disabled by default and is configured with security.redact-info-log: true replaces sensitive log values with ?, while "marker" encloses them in markers. The configuration reference now describes this setting and its default. Existing DM-worker log redaction guidance remains available.

@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 Sep 30, 2026
@coderabbitai

coderabbitai Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Review in 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

No actionable comments were generated in the recent review.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: pingcap/docs/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 6ad16239-5d88-4756-a64d-8272b326d2db

📥 Commits

Reviewing files that changed from the base of the PR and between d5f6719 and f522020.

📒 Files selected for processing (2)
  • log-redaction.md
  • ticdc/ticdc-server-config.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 1 remain after this review.

Walkthrough

The documentation describes TiCDC log redaction, including its new-architecture-only availability, default setting, and behavior for true and "marker".

Changes: TiCDC log redaction

Layer / File(s) Summary
Document the redaction option
log-redaction.md, ticdc/ticdc-server-config.md
Both guides document redact-info-log, its false default, its new-architecture-only availability, and the behavior for true and "marker". The DM-worker guidance and region-retry-duration default remain unchanged.

Priority: Low

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

Change: Other

Merge Risk: Minimal · previous review f5220

The guides accurately describe TiCDC log redaction and preserve the adjacent configuration guidance. No concrete merge-blocking risk remains.

Architecture risk: Low · up to f5220

The change affects 2 systems.

Changed systems: log-redaction.md, ticdc

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — log-redaction.md (service) was modified; 1 changed file maps to changed impact.
  • observed — ticdc (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in log-redaction.md: Adds TiCDC log redaction guidance, including the v8.5.6 new-architecture-only restriction, the false default, and the effects of setting security.redact-info-log to true or "marker".
  • observed — Modified behavior in log-redaction.md: The DM-worker redaction configuration guidance remains after the inserted TiCDC section; its setting and default are unchanged.
  • observed — Modified behavior in ticdc/ticdc-server-config.md: Adds documentation for redact-info-log, including its new-architecture restriction, default of false, and documented redaction formats for true and "marker".
  • observed — Modified behavior in ticdc/ticdc-server-config.md: The region-retry-duration default value is unchanged; the old and new lines match.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding TiCDC log redaction configuration documentation.
Description check ✅ Passed The description covers the changes, affected versions, and related code reference. It omits some template sections, including AI agent involvement and the final change-type checklist, and it does not …
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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: 💡 1
🛠️ Fix failing CI checks: 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@asddongmen
asddongmen force-pushed the docs/ticdc-log-redaction branch from 2f8d02c to d5f6719 Compare September 30, 2026 02:04
@asddongmen asddongmen added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Sep 30, 2026
@asddongmen
asddongmen force-pushed the docs/ticdc-log-redaction branch from d5f6719 to f522020 Compare September 30, 2026 02:29
@ti-chi-bot

ti-chi-bot Bot commented Oct 29, 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 lance6716 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

Comment thread log-redaction.md Outdated
Comment thread ticdc/ticdc-server-config.md Outdated
Comment thread log-redaction.md Outdated
Comment thread log-redaction.md Outdated

@qiancai qiancai left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Rest LGTM

@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Oct 29, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 29, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-10-29 13:03:35.917727661 +0000 UTC m=+153340.542877934: ☑️ agreed by qiancai.

asddongmen and others added 3 commits October 30, 2026 09:46
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.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. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. 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.

2 participants