RocketMQ客户端修改默认日志配置【java版】

梦里梦外; 2022-11-07 14:39 723阅读 0赞

# RocketMQ客户端日志默认配置 #

内部日志初始化代码

static {
            // 是否使用项目配置的slf4j记录日志，默认不使用
            CLIENT_USE_SLF4J = Boolean.parseBoolean(System.getProperty(CLIENT_LOG_USESLF4J, "false"));
            if (!CLIENT_USE_SLF4J) {
                InternalLoggerFactory.setCurrentLoggerType(InnerLoggerFactory.LOGGER_INNER);
                CLIENT_LOGGER = createLogger(LoggerName.CLIENT_LOGGER_NAME);
                createLogger(LoggerName.COMMON_LOGGER_NAME);
                createLogger(RemotingHelper.ROCKETMQ_REMOTING);
            } else {
                CLIENT_LOGGER = InternalLoggerFactory.getLogger(LoggerName.CLIENT_LOGGER_NAME);
            }
        }
    
        private static synchronized Appender createClientAppender() {
            // 日志目录：${user.home}/logs/rocketmqlogs/rocketmq_client.log
            String clientLogRoot = System.getProperty(CLIENT_LOG_ROOT, System.getProperty("user.home") + "/logs/rocketmqlogs");
            String clientLogMaxIndex = System.getProperty(CLIENT_LOG_MAXINDEX, "10");
            String clientLogFileName = System.getProperty(CLIENT_LOG_FILENAME, "rocketmq_client.log");
            String maxFileSize = System.getProperty(CLIENT_LOG_FILESIZE, "1073741824"); // 1个G
            String asyncQueueSize = System.getProperty(CLIENT_LOG_ASYNC_QUEUESIZE, "1024");
    
            String logFileName = clientLogRoot + "/" + clientLogFileName;
    
            int maxFileIndex = Integer.parseInt(clientLogMaxIndex);
            int queueSize = Integer.parseInt(asyncQueueSize);
    
            Layout layout = LoggingBuilder.newLayoutBuilder().withDefaultLayout().build();
    
            Appender rocketmqClientAppender = LoggingBuilder.newAppenderBuilder()
                .withRollingFileAppender(logFileName, maxFileSize, maxFileIndex)
                .withAsync(false, queueSize).withName(ROCKETMQ_CLIENT_APPENDER_NAME).withLayout(layout).build();
    
            Logger.getRootLogger().addAppender(rocketmqClientAppender);
            return rocketmqClientAppender;
        }

上面的代码所在类：org.apache.rocketmq.client.log.ClientLogger

关键的配置如下：

String CLIENT_LOG_USESLF4J = "rocketmq.client.logUseSlf4j";
    String CLIENT_LOG_ROOT = "rocketmq.client.logRoot";
    String CLIENT_LOG_FILENAME = "rocketmq.client.logFileName";
    
    // 是否使用项目配置的slf4j记录日志，默认不使用，使用自己内部封装的日志框架记录日志
    CLIENT_USE_SLF4J = Boolean.parseBoolean(System.getProperty(CLIENT_LOG_USESLF4J, "false"));
    // 日志目录及日志文件：${user.home}/logs/rocketmqlogs/rocketmq_client.log
    String clientLogRoot = System.getProperty(CLIENT_LOG_ROOT, System.getProperty("user.home") + "/logs/rocketmqlogs");
    String clientLogFileName = System.getProperty(CLIENT_LOG_FILENAME, "rocketmq_client.log");

所以我们可以在jvm属性里设置这几个属性的值来修改日志记录的默认配置。

# 更换客户端日志目录 #

RocketMQ客户端日志默认记录位置：$\{user.home\}/logs/rocketmqlogs/rocketmq\_client.log

以下2种示例方式任选1种：

*  设置启动参数指定目录：-Drocketmq.client.logRoot=/opt/logs，指定日志目录为/opt/logs
 *  main方法，调用System.setProperty()方法：`System.setProperty(ClientLogger.CLIENT_LOG_ROOT, "/`opt`/logs");`

`如果需要修改日志文件名，可以针对这个属性处理：`

String clientLogFileName = System.getProperty(CLIENT_LOG_FILENAME, "rocketmq_client.log");

# 使用项目的slf4j实现记录日志 #

以下2种示例方式任选1种：

*  设置启动参数指定目录：`-Drocketmq.client.logUseSlf4j=``true`
 *  main方法，调用System.setProperty()方法：`System.setProperty(ClientLogger.CLIENT_LOG_USESLF4J, "true");`

`这种方式更灵活，可以通过项目的日志配置来定义rocketmq客户端日志的格式、输出位置、滚动策略...等等。`