日志配置 - 消息队列RocketMQ版

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

打印客户端日志

消息队列RocketMQ版的TCP Java SDK基于SLF4J接口编程。

针对Java SDK 1.7.8.Final及以上版本

消息队列RocketMQ版的Java SDK 1.7.8.Final已内置了日志实现，您无需在客户端应用中添加日志实现依赖即可打印消息队列RocketMQ版的客户端日志。

客户端日志的默认配置以及如何修改默认配置的具体步骤，请参见下文的自定义配置部分。

针对Java SDK 1.7.8.Final以下版本

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

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

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

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
    <version>1.7.7</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.7</version>
</dependency>
<dependency>       
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

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

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
    <version>1.1.2</version>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.1.2</version>
</dependency>

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

客户端日志配置

消息队列RocketMQ版的客户端支持用户自定义日志保存路径、日志级别以及保存历史日志文件的最大个数。考虑到日志传输以及阅读的便利性，消息队列RocketMQ版暂不允许自定义单个日志文件大小，保持默认的64 MB。

各参数的配置说明如下：

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

默认配置

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

日志保存路径：/{user.home}/logs/ons.log，其中{user.home}是指您启动当前Java进程的根目录。
保存历史日志文件的最大个数：10个。
日志级别：INFO。
单个日志文件大小：64 MB。

自定义配置

注意若要自定义客户端的日志配置，请升级到Java SDK 1.2.5及以上版本。

在Java SDK中自定义客户端日志配置，请设置以下系统参数：

ons.client.logRoot：日志保存路径。
ons.client.logFileMaxIndex：保存历史日志文件的最大个数。
ons.client.logLevel：日志级别。

示例配置

您可在启动脚本中或者IDE的VM options中添加以下系统参数：

Linux示例

-Dons.client.logRoot=/home/admin/logs -Dons.client.logLevel=WARN -Dons.client.logFileMaxIndex=20

Windows示例

-Dons.client.logRoot=D:\logs -Dons.client.logLevel=WARN -Dons.client.logFileMaxIndex=20

其中，/home/admin/和D:\仅为示例，请填写您实际的系统目录。