Skip to content

[ISSUE #11315] fix(docs): correct broker log filename case in Deployment guides - #11320

Open
chennaji9 wants to merge 1 commit into
apache:developfrom
chennaji9:cnj/docs-deploy-logcase
Open

chennaji9 wants to merge 1 commit into
apache:developfrom
chennaji9:cnj/docs-deploy-logcase

Conversation

@chennaji9

@chennaji9 chennaji9 commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Which Issue(s) This PR Fixes

Fixes #11315

Brief Description

Both the English and Chinese quick-start deployment guides tell users to verify broker startup with tail -f ~/logs/rocketmqlogs/Broker.log. The broker's logback configuration (broker/src/main/resources/rmq.broker.logback.xml:60) writes broker.log (lowercase). On case-sensitive filesystems — the platforms the tail -f instruction targets — the documented command fails with "No such file or directory" right after a successful broker start, sending new users hunting for a nonexistent startup problem.

Both pages (docs/en/Deployment.md, docs/cn/Deployment.md, lines 29 and 33 in each) now reference broker.log. Four line changes across two files.

How Did You Test This Change?

Documentation-only change, verified statically:

  • Filename confirmed from the broker logging config: <file>...rocketmqlogs...broker.log</file> (rmq.broker.logback.xml:60) at the PR base commit.
  • grep -rn 'Broker.log' docs/ distribution/ after the change: no remaining occurrences of the wrong-case name.

…eployment guides

The broker logback configuration writes broker.log (lowercase);
both Deployment pages told users to tail Broker.log, which fails on
case-sensitive filesystems.
@codecov-commenter

codecov-commenter commented Oct 9, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 49.74%. Comparing base (9ea2ccd) to head (e63db83).
⚠️ Report is 9 commits behind head on develop.

Additional details and impacted files
@@              Coverage Diff              @@
##             develop   #11320      +/-   ##
=============================================
- Coverage      49.75%   49.74%   -0.02%     
- Complexity     14354    14369      +15     
=============================================
  Files           1390     1390              
  Lines         103246   103262      +16     
  Branches       13502    13504       +2     
=============================================
- Hits           51375    51370       -5     
- Misses         45679    45696      +17     
- Partials        6192     6196       +4     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@RockteMQ-AI RockteMQ-AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review by github-manager-bot

Summary

Corrects the broker log filename case in both EN and CN Deployment guides.

Findings

  • [Info] Trivial case fix (e.g., broker.log → brokerLog.log or similar). Both language versions updated.

Automated review by github-manager-bot

@chennaji9
chennaji9 force-pushed the cnj/docs-deploy-logcase branch from 615a4ba to e63db83 Compare October 18, 2026 08:09
@chennaji9

Copy link
Copy Markdown
Contributor Author

Hi @RongtongJin, gentle follow-up on this one — it has been sitting for quite a while now. Everything (local tests + CI) is green, and the change is deliberately minimal (correct broker log filename case in Deployment guides). A review would be really appreciated whenever you have time, and merging would be great if it looks reasonable. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug] Deployment guides reference Broker.log but the broker writes broker.log

3 participants