Zookeeper中如何解决zookeeper.out文件输出位置问题

2023-05-14 09:05:11 位置输出如何解决

使用过 Zookeeper 的小伙伴都知道，Zookeeper 中运行日志 zookeeper.out 文件的输出路径默认为启动脚本的当前路径，导致Zookeeper 集群启动失败想看日志时总是不记得输出日志在哪儿，不方便查看日志文件，所以需要修改日志输出位置及方式，方便查看日志。

具体操作如下：

注释：以下所用 $ZOOKEEPER_HOME 为 Zookeeper 的根目录

修改 $ZOOKEEPER_HOME/bin/zkEnv.sh 文件

将 ZOO_LOG_DIR 设置成自定义路径，本次设置为 ${ZOOKEEPER_PREFIX}/logs，其中 ZOOKEEPER_PREFIX 变量是此脚本开头获取的 Zookeeper 的 bin 路径，我们直接以此来定位自己的日志路径即可。

具体如下：

# 修改前
if [ "x${ZOO_LOG_DIR}" = "x" ]
then
    ZOO_LOG_DIR="."
fi

# 修改后
if [ "x${ZOO_LOG_DIR}" = "x" ]
then
#    ZOO_LOG_DIR="."
    # 自定义运行日志文件输出路径
    ZOO_LOG_DIR="${ZOOKEEPER_PREFIX}/logs"
fi

将日志文件写到 Zookeeper 安装目录下的 logs 文件夹中（logs 不需要创建，它会自己创建）。

这样在每次使用 zkSever.sh 的时候，都能将运行日志 zookeeper.out 输出到指定路径下，但这样配置有个问题，就是每次运行 Zookeeper 时，此日志都会被覆盖，而不是 append 到文件中，故每次运行结束后只会保存有本次运行日志，若单次运行时间很长也会导致日志文件也很大。

修改 $ZOOKEEPER_HOME/conf/log4j.properties 文件

在之前的配置中，我们只是实现了保存本次Zookeeper运行日志在指定路径下，这次我们通过配置 $ZOOKEEPER_HOME/conf/log4j.properties 来使用 log4j 日志框架将 Zookeeper 每次的运行日志都保存到指定路径下。

修改其中的 zookeeper.root.logger、zookeeper.log.dir 这两个参数。

具体如下：

# 修改前
zookeeper.root.logger=INFO, CONSOLE
zookeeper.log.dir=.

# 修改后
zookeeper.root.logger=INFO, CONSOLE, ROLLINGFILE
zookeeper.log.dir=/opt/module/zookeeper-3.4.10/logs

其中参数 zookeeper.root.logger 是设置日志优先级和打印方式，默认为控制台打印 CONSOLE，而在 zkServer.sh 中会启动后台命令，将控制台输出的日志输出重定向到 zookeeper.out 文件中。

修改后添加了滚动产生文件输出方式 ROLLINGFILE；通过参数 zookeeper.log.dir 设置日志文件 zookeeper.log 的存储路径，这里直接采用绝对路径，相对路径可能不识别；默认日志文件名为 zookeeper.log，其中所有参数都可以自定义修改。其余参数不再赘述。

修改 $ZOOKEEPER_HOME/bin/zkEnv.sh 文件

这里为什么又要修改 zkEnv.sh 文件呢？

因为 zkEnv.sh 文件中也有 log 文件的输出位置及方式，所以我们要将其中的 ZOO_LOG4J_PROP 设置成与 log4j 配置文件中相同，避免参数覆盖。

具体如下：

# 修改前
if [ "x${ZOO_LOG4J_PROP}" = "x" ]
then
    ZOO_LOG4J_PROP="INFO,CONSOLE"
fi

# 修改后
if [ "x${ZOO_LOG4J_PROP}" = "x" ]
then
#    ZOO_LOG4J_PROP="INFO,CONSOLE"
    #自定义运行日志信息输出方式,增加了滚动输出的方式,初始只有控制台输出
    ZOO_LOG4J_PROP="INFO,CONSOLE,ROLLINGFILE"
fi

修改 $ZOOKEEPER_HOME/bin/zkServer.sh 文件

完成以上配置就可以将日志文件按照自己想要的方式输出，唯一美中不足的是在你设定的目录中，仍会有 zookeeper.out 文件存在, 虽然它的 size=0，究其原因是因为 zkServer.sh 会使用 nohup 进行 Zookeeper 的启动，然而 nohup 必然会输出一个日志文件到你设置的目录中，所以修改 _ZOO_DAEMON_OUT 此处的逻辑修改掉, 就可以将zookeeper.out了。

具体如下：

#修改前
_ZOO_DAEMON_OUT="$ZOO_LOG_DIR/zookeeper.out"

#修改后
_ZOO_DAEMON_OUT="$ZOO_LOG_DIR/zookeeper.log"

修改 $ZOOKEEPER_HOME/conf/log4j.properties 文件

上述日志配置是以日志文件大小轮转的，如果想要按照天轮转，可以将 log4j.appender.ROLLINGFILE 修改为 DaliyRollingFileAppender。

通过参数 log4j.appender.ROLLINGFILE.MaxBackupIndex 设置最大日志数量，每个日志文件大小最大默认为 10MB，以此文件大小进行分割。

具体如下：

# 修改前
log4j.appender.ROLLINGFILE=org.apache.log4j.RollingFileAppender
#log4j.appender.ROLLINGFILE.MaxBackupIndex=10

# 修改后
log4j.appender.ROLLINGFILE=org.apache.log4j.DailyRollingFileAppender
log4j.appender.ROLLINGFILE.MaxBackupIndex=10

DailyRollingFileAppender特点是固定周期时间生成一个日志文件，比如，默认情况是每天生成一个文件。

这种日志可以方便根据时间来定位日志位置，使日志清晰易查。但是这种日志有个不好地方是，不能限制日志数量，MaxBackupIndex 属性和 MaxFileSize 在DailyRollingFileAppender 中是无效的，这个还是按照自己的需求来定！

当然还有其他一些参数：

log4j.appender.ROLLINGFILE.File=zookeeper.log
## 按照什么频率滚动文件：yyyy-MM(每月)、yyyy-ww(每周)、yyyy-MM-dd(每天)、yyyy-MM-dd-a(每半天)、yyyy-MM-dd-HH(每小时)、yyyy-MM-dd-HH-mm(每分钟)
## 此处文件名为zookeeper.log.yyyy-MM-dd，最新文件名为zookeeper.log
log4j.appender.ROLLINGFILE.DataPattern='.'yyyy-MM-dd
log4j.appender.ROLLINGFILE.encoding=UTF-8
## 是否启动追加模式，默认为true，false为覆盖
log4j.appender.ROLLINGFILE.Append=false

补充

修改原始输出逻辑，不再将本次运行日志信息所有输出到 zookeeper.out 中，而是使用log4j框架输出到 zookeeper.log 中，便于管理。而 zookeeper.out 只用于输出标准错误。

具体如下所示：

注意：要想实现此处操作，上述 _ZOO_DAEMON_OUT=“$ZOO_LOG_DIR/zookeeper.out” 不能修改为 _ZOO_DAEMON_OUT=“$ZOO_LOG_DIR/zookeeper.log”

# 修改前
141     nohup "$JAVA" "-Dzookeeper.log.dir=${ZOO_LOG_DIR}" "-Dzookeeper.root.logger=${ZOO_LOG4J_PROP}" \
142     -cp "$CLASSPATH" $JVMFLAGS $ZOOMAIN "$ZOOCFG" > "$_ZOO_DAEMON_OUT" 2>&1 < /dev/null &

# 修改后: 将原始指令注释,设置新的输出逻辑,只将标准错误输出到zookeeper.out中.
141 #    nohup "$JAVA" "-Dzookeeper.log.dir=${ZOO_LOG_DIR}" "-Dzookeeper.root.logger=${ZOO_LOG4J_PROP}" \
142 #    -cp "$CLASSPATH" $JVMFLAGS $ZOOMAIN "$ZOOCFG" > "$_ZOO_DAEMON_OUT" 2>&1 < /dev/null &
143     nohup "$JAVA" "-Dzookeeper.log.dir=${ZOO_LOG_DIR}" "-Dzookeeper.root.logger=${ZOO_LOG4J_PROP}" \
144     -cp "$CLASSPATH" $JVMFLAGS $ZOOMAIN "$ZOOCFG" 2> "$_ZOO_DAEMON_OUT" 1> /dev/null &

这样就能保证历史运行日志都能输出到指定文件夹中，并且不会因为运行日志文件堆积造成负载点爆炸。

而标准错误都会输出到 zookeeper.out 文件中，和运行日志放置在同一文件夹中。

当需要查看脚本命令错误时，可以查看 zookeeper.out 文件，当需要查看程序错误时就查看 zookeeper.log 运行日志文件。

需要注意的是：每次启动 Zookeeper 时，都会覆盖 zookeeper.out 文件，所以要做重启处理时记得备份文件。

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持。

相关文章