[Bug] rmq.tools.logback.xml references an appender that is not defined in it, so mqadmin silently drops the Common/Store/Remoting logs

未关闭
#11,431 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@iloveeyjafjalla 已经在做这个了。

开始于 2026年10月14日。

  • #11432 来自 @iloveeyjafjalla —— 未关闭

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
20/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
停滞
技术栈
java
领域
cli

调研方向

The bad references are the three appender-ref entries to RocketmqBrokerAppender in tools/src/main/resources/rmq.tools.logback.xml; compare with rmq.namesrv.logback.xml around lines 94-100. Work is already under way: pull request #11432 is open against this issue, so check it before starting. If you pick this up, the fix is to point the three loggers at RocketmqToolsAppender and add a test that loads the file through JoranConfiguratorExt and asserts each logger has an appender.

由索引模型根据 Issue 内容生成。

描述

Before Creating the Bug Report
  • I found a bug, not just asking a question, which should be created in GitHub Discussions.
  • I have searched the GitHub Issues and GitHub Discussions of this repository and believe that this is not a duplicate.
  • I have confirmed that this bug belongs to the current repository, not other repositories of RocketMQ.
Runtime platform environment

OS: any (the mqadmin tool)

RocketMQ version

branch: develop
Git commit id: a7edeecfb

JDK Version

Compiler: Temurin 1.8.0_504 (target 1.8, same as CI)

Describe the Bug

tools/src/main/resources/rmq.tools.logback.xml — the configuration the distribution installs as conf/rmq.tools.logback.xml and that mqadmin selects with -Drmq.logback.configurationFile (distribution/bin/mqadmin:45) — attaches three loggers to an appender it never defines:

<logger name="RocketmqCommon" additivity="false" level="INFO">
    <appender-ref ref="RocketmqBrokerAppender"/>     <!-- not defined in this file -->
</logger>
<logger name="RocketmqStore" additivity="false" level="INFO">
    <appender-ref ref="RocketmqBrokerAppender"/>
</logger>
<logger name="RocketmqRemoting" additivity="false" level="INFO">
    <appender-ref ref="RocketmqBrokerAppender"/>
</logger>

The appenders this file defines are DefaultAppender, RocketmqToolsAppender, RocketmqToolsAppender_inner and STDOUT; RocketmqBrokerAppender only exists in the broker and proxy configurations, and logback resolves appender-refs inside the configuration file that is being loaded, so the reference cannot be satisfied.

The consequence is user-visible and completely silent: those loggers also set additivity="false", so once their only appender-ref is dropped they are attached to no appender at all — everything logged through RocketmqCommon, RocketmqStore and RocketmqRemoting is discarded and nothing from the client/store/remoting layers reaches tools.log (or any other appender), which is exactly the diagnostic trail an operator needs when a tool misbehaves. I verified with the project's own loader (JoranConfiguratorExt, the class the runtime uses) and a status collector that this logback build reports no status message at all for the unresolved reference — no warning, no error, so the loss is not even visible in the tool's output.

The sibling configurations do this correctly, which is the pattern to keep: broker points those loggers at its own RocketmqBrokerAppender, namesrv at RocketmqNamesrvAppender (namesrv/src/main/resources/rmq.namesrv.logback.xml:94-100), proxy at its RocketmqBrokerAppender. This is the same class of mistake that was fixed in #11177 (an appender registered under a name that did not match its definition).

Steps to Reproduce
  1. Run any admin command, e.g. mqadmin clusterList -n 127.0.0.1:9876 (the wrapper passes conf/rmq.tools.logback.xml).
  2. Check ${user.home}/logs/rocketmqlogs/tools.log: nothing logged by RocketmqCommon/RocketmqStore/RocketmqRemoting ever appears there, and no message is printed about the dropped configuration either.

At the unit level the shipped file is loaded with the project's own JoranConfiguratorExt (common/.../logging/JoranConfiguratorExt.java, the loader that also rewrites the unshaded logback class names for the shaded runtime) into a fresh logger context: the three loggers end up with no appender, and the loader reports no error or warning for it.

What Did You Expect to See?

mqadmin starts without configuration errors, and its component loggers write to the tool's own log file — i.e. the three loggers reference RocketmqToolsAppender (the appender the file defines and that RocketmqTools already uses, writing to ${user.home}/logs/rocketmqlogs/tools.log), mirroring how each other component points those loggers at its own appender.

What Did You See Instead?

Three logback errors on every invocation and three loggers whose output is silently discarded.

Additional Context

Minimal fix: replace the three RocketmqBrokerAppender references with RocketmqToolsAppender. I checked the other shipped configurations for the same mistake: only this file references an appender it does not define (the controller file defines RocketmqControllerConsole twice, but with identical content, which logback merges harmlessly).

I will open a PR with the three-line change plus a regression test that loads the shipped rmq.tools.logback.xml through JoranConfiguratorExt and asserts the three loggers are attached to an appender (red before: RocketmqCommon must be attached to an appender).

主要语言
Java
星标
22.7k
派生
12k
平均合并
3 天 18 小时
30 天内合并 PR
17

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

apache/rocketmq 的其他 Issue

查看 apache/rocketmq 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。