[asddongmen]

What is changed, added, or deleted? (Required)

Replace outdated broker-level advice for the Kafka Message was too large error with a procedure that aligns the TiCDC Sink URI max-message-bytes setting and the actual Kafka Topics' max.message.bytes settings. Add commands to identify dispatched Topics, update and verify their limits, update the complete Sink URI, and confirm that the changefeed resumes.

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.

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

• Related code change PR links (if applicable):
• This PR is translated from: ticdc: clarify Kafka message size configuration docs-cn#22017
• Other reference link(s):

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
  • Updated the Kafka “Message was too large” troubleshooting guide with steps to align the TiCDC Sink URI’s message-size limit with the applicable Kafka Topic limit.
  • Added guidance for identifying the default and dispatcher-selected Topics, configuring and verifying Topic limits, and updating the Sink URI.
  • For running changefeeds, the guide now covers pausing before an update and resuming afterward, then checking the URI, changefeed state, and checkpoint progress.
  • Replaced broker-level configuration instructions.

[ti-chi-bot]

[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 qiancai 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:

• OWNERS

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

[coderabbitai]

Walkthrough

The troubleshooting guide now covers aligning TiCDC’s max-message-bytes with Kafka topic max.message.bytes. It adds steps to inspect topic routing, configure topic limits, update a changefeed, and verify its state and checkpoint.

Changes: Kafka message size troubleshooting

Layer / File(s)	Summary
Configure topic and changefeed limits ticdc/troubleshoot-ticdc.md	The guide identifies the default and dispatcher-selected topics, explains how to set and verify their max.message.bytes limits, and adds steps to update the changefeed Sink URI and verify its state and checkpoint.

Priority: Normal

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

Change: Other

Suggested reviewers: hfxsd, qiancai

Merge Risk: Minimal · up to 2c552

The updated troubleshooting workflow is supported and has no established merge-blocking risk.

Pre-merge checks: 5

Check name	Status	Explanation
Title check		The title clearly and concisely describes the main documentation change: clarifying Kafka message size configuration for TiCDC.
Description check		The description includes the required change summary and affected version, and it provides related PR information, AI involvement, and change-type checklist details.
Docstring Coverage		No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches

🧪 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

---

Review info

Run configuration

• Source mode: Auto
• Repository: pingcap/docs
• Branch: master
• File: .coderabbit.yaml
• Commit: e5e80ae
• Layers: Repository YAML
• Review profile: ASSERTIVE
• Plan: Advanced
• Run ID: 0d260c60-e1fa-4dc9-8ae0-cf91bce119ba

Commits

Reviewing files that changed from the base of the PR and between e5e80ae and 8a1aed4.

Files selected for processing: 1

• ticdc/troubleshoot-ticdc.md

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