日志配置

客户端日志用于记录客户端运行过程中的异常,帮助快速定位和修复问题。本文介绍 RocketMQ 的客户端日志的打印方式,以及默认和自定义配置。

打印客户端日志

RocketMQ 的 TCP Java SDK 基于 SLF4J 接口编程。

  • 针对 JavaSDK1.7.8.Final 版本及以上

RocketMQ 的 Java SDK 1.7.8.Final 已内置了日志实现,无需在客户端应用中添加日志实现依赖 即可打印 RocketMQ 客户端日志。 RocketMQ客户端日志的默认配置和如何修改默认配置,请参见下文的客户端日志配置部分。

  • 针对 JavaSDK1.7.8.Final 以下

RocketMQ 的Java SDK 1.7.8.Final 以下的旧版本不支持 log4j2,只支持 log4j、logback。您需要 在 pom.xml 配置文件 或者 lib 中添加对应的日志实现依赖来打印 RocketMQ 客户端日志。

方式一: 依赖 log4j 作为日志实现

依赖log4j或logback作为日志实现的示例代码如下所示。

  1. <dependency>
  2. <groupId>org.slf4j</groupId>
  3. <artifactId>jcl-over-slf4j</artifactId>
  4. <version>1.7.7</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>org.slf4j</groupId>
  8. <artifactId>slf4j-log4j12</artifactId>
  9. <version>1.7.7</version>
  10. </dependency>
  11. <dependency>
  12. <groupId>log4j</groupId>
  13. <artifactId>log4j</artifactId>
  14. <version>1.2.17</version>
  15. </dependency>

使用 log4j 属性配置文件时,配置如下。

  1. log4j.appender.mq=org.apache.rocketmq.logappender.log4j.RocketmqLog4jAppender
  2. log4j.appender.mq.Tag=yourTag
  3. log4j.appender.mq.Topic=yourLogTopic
  4. log4j.appender.mq.ProducerGroup=yourLogGroup
  5. log4j.appender.mq.NameServerAddress=yourRocketmqNameserverAddress
  6. log4j.appender.mq.layout=org.apache.log4j.PatternLayout
  7. log4j.appender.mq.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-4r [%t] (%F:%L) %-5p - %m%n

使用 log4j xml 配置文件时,将其配置为这样并添加一个异步附加程序:

  1. <appender name="mqAppender1" class="org.apache.rocketmq.logappender.log4j.RocketmqLog4jAppender">
  2. <param name="Tag" value="yourTag" />
  3. <param name="Topic" value="yourLogTopic" />
  4. <param name="ProducerGroup" value="yourLogGroup" />
  5. <param name="NameServerAddress" value="yourRocketmqNameserverAddress"/>
  6. <layout class="org.apache.log4j.PatternLayout">
  7. <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss}-%p %t %c - %m%n" />
  8. </layout>
  9. </appender>
  10. <appender name="mqAsyncAppender1" class="org.apache.log4j.AsyncAppender">
  11. <param name="BufferSize" value="1024" />
  12. <param name="Blocking" value="false" />
  13. <appender-ref ref="mqAppender1"/>
  14. </appender>

使用 log4j2 时,配置为 this。如果你想要 noneblock,只需为 ref 配置一个 asyncAppender。

  1. <RocketMQ name="rocketmqAppender" producerGroup="yourLogGroup" nameServerAddress="yourRocketmqNameserverAddress"
  2. topic="yourLogTopic" tag="yourTag">
  3. <PatternLayout pattern="%d [%p] hahahah %c %m%n"/>
  4. </RocketMQ>

方式二: 依赖 logback 作为日志实现

  1. <dependency>
  2. <groupId>ch.qos.logback</groupId>
  3. <artifactId>logback-core</artifactId>
  4. <version>1.1.2</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>ch.qos.logback</groupId>
  8. <artifactId>logback-classic</artifactId>
  9. <version>1.1.2</version>
  10. </dependency>
  1. <dependency>
  2. <groupId>ch.qos.logback</groupId>
  3. <artifactId>logback-core</artifactId>
  4. <version>1.1.2</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>ch.qos.logback</groupId>
  8. <artifactId>logback-classic</artifactId>
  9. <version>1.1.2</version>
  10. </dependency>

日志配置 - 图1提示

应用中同时依赖log4j和logback的日志实现会造成日志冲突导致客户端日志打印混乱。确保 应用只依赖其中一个日志实现,是正确打印RocketMQ客户端日志的前提条件,建议通过mvn clean dependency:tree | grep log命令排查。

客户端日志配置

RocketMQ 客户端支持自定义日志保存路径、日志级别以及保存历史日志文件的最大个数。考虑到日志传输以及阅读的便利性,暂不允许自定义单个日志文件大小,仍保持默认的64 MB。各参数的配置说明如下:

参数说明配置参数自定义取值
日志保存路径请确保应用进程有对该路径写的权限,否则日志 不会打印。rocketmq.client.logRoot可自定义为您需要将日志文件保存到本地的路径。请确保您的应用进程有该路径的写权限,否则日志无法打印。
保存历史日志文件的最大个数支持1到100之前的数值;若输入的值超出该范围 或格式错误,则系统默认保存10个。rocketmq.client.logFileMaxIndex取值范围:1~100。若设置的值超出该范围或格式错误,则以系统默认值(10个)为准。
日志级别支持ERROR、WARN、INFO、DEBUG中任何一 种,不匹配默认INFO。rocketmq.client.logLevel取值如下:ERRORWARNINFODEBUG**
单个文件日志大小支持以bytes为单位指定rocketmq.client.logFileMaxSize取值在0~1GB, 默认1GB, 建议64 MB
logback是否使用父级logger打印children-logger是否使用 rootLogger配置的appender进行输出rocketmq.client.log.additivetrue/false
使用项目的slf4j实现记录日志如果需要实现记录日志 则为truerocketmq.client.logUseSlf4jtrue/flase

默认配置

请确保应用进程有对该路径写的权限,否则日志 不会打印。 支持 1 到 100 之前的数值;若输入的值超出该范围 或格式错误,则系统默认保存10个。 支持 ERROR、WARN、INFO、DEBUG 中任何一 种,不匹配默认 INFO。

RocketMQ 客户端启动后,会按照如下的默认配置生成日志文件 :

  • 日志保存路径:/{user.home}/logs/rocketmqlogs/ 其中{user.home}是指启动当前Java进程的用 户的根目录
  • 保存历史日志文件的最大个数:10个
  • 日志级别:INFO
  • 单个日志文件大小: 1GB

自定义配置

如果需要进行自定义配置 参考 ClientLogger的静态变量定义, 参数意义对齐上文客户端配置。

  1. public static final String CLIENT_LOG_USESLF4J = "rocketmq.client.logUseSlf4j";
  2. public static final String CLIENT_LOG_ROOT = "rocketmq.client.logRoot";
  3. public static final String CLIENT_LOG_MAXINDEX = "rocketmq.client.logFileMaxIndex";
  4. public static final String CLIENT_LOG_FILESIZE = "rocketmq.client.logFileMaxSize";
  5. public static final String CLIENT_LOG_LEVEL = "rocketmq.client.logLevel";
  6. public static final String CLIENT_LOG_ADDITIVE = "rocketmq.client.log.additive";
  7. public static final String CLIENT_LOG_FILENAME = "rocketmq.client.logFileName";
  8. public static final String CLIENT_LOG_ASYNC_QUEUESIZE = "rocketmq.client.logAsyncQueueSize";
  9. public static final String ROCKETMQ_CLIENT_APPENDER_NAME = "RocketmqClientAppender";
  10. private static final InternalLogger CLIENT_LOGGER;
  11. private static final boolean CLIENT_USE_SLF4J;
  12. //private static Appender rocketmqClientAppender = null;
  13. static {
  14. CLIENT_USE_SLF4J = Boolean.parseBoolean(System.getProperty(CLIENT_LOG_USESLF4J, "false"));
  15. if (!CLIENT_USE_SLF4J) {
  16. InternalLoggerFactory.setCurrentLoggerType(InnerLoggerFactory.LOGGER_INNER);
  17. CLIENT_LOGGER = createLogger(LoggerName.CLIENT_LOGGER_NAME);
  18. createLogger(LoggerName.COMMON_LOGGER_NAME);
  19. createLogger(RemotingHelper.ROCKETMQ_REMOTING);
  20. } else {
  21. CLIENT_LOGGER = InternalLoggerFactory.getLogger(LoggerName.CLIENT_LOGGER_NAME);
  22. }
  23. }

示例

以下是一个简单示例

在启动脚本中或者IDE的VM options中添加如下系统参数:

  • Linux示例
  • windows示例
  1. -Drocketmq.client.logRoot=/home/admin/logs -Drocketmq.client.logLevel=WARN -Drocketmq.client.logFileMaxIndex=20 -Drocketmq.client.logFileMaxSize=67108864
  1. -Drocketmq.client.logRoot=D:\logs -Drocketmq.client.logLevel=WARN -Drocketmq.client.logFileMaxIndex=20 -Drocketmq.client.logFileMaxSize=67108864