使用流水线部署了项目却没有打印日志

一、背景

工作中遇到一个问题，使用流水线发布了项目后，项目程序功能正常，但是日志却没打印到指定的日志文件上。
该项目是部署到虚拟机上的，大致部署流程是流水线发布后执行项目里的启动脚本。

二、分析

log4j.xml配置的日志信息样例如下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration>

    <!-- 将日志信息输出到控制台 -->
    <appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
        <!-- 设置日志输出的样式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <!-- 设置日志输出的格式 -->
            <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n" />
        </layout>
        <!--过滤器设置输出的级别-->
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <!-- 设置日志输出的最小级别 -->
            <param name="levelMin" value="WARN" />
            <!-- 设置日志输出的最大级别 -->
            <param name="levelMax" value="ERROR" />
            <!-- 设置日志输出的xxx，默认是false -->
            <param name="AcceptOnMatch" value="true" />
        </filter>
    </appender>

    <!-- 将日志信息输出到文件，但是当文件的大小达到某个阈值的时候，日志文件会自动回滚 -->
    <appender name="RollingFileAppender" class="org.apache.log4j.RollingFileAppender">
        <!-- 设置日志信息输出文件全路径名 -->
        <param name="File" value="../logs/RollingFileAppender.log" />
        <!-- 设置是否在重新启动服务时，在原有日志的基础添加新日志 -->
        <param name="Append" value="true" />
        <!-- 设置保存备份回滚日志的最大个数 -->
        <param name="MaxBackupIndex" value="10" />
        <!-- 设置当日志文件达到此阈值的时候自动回滚，单位可以是KB，MB，GB，默认单位是KB -->
        <param name="MaxFileSize" value="10KB" />
        <!-- 设置日志输出的样式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <!-- 设置日志输出的格式 -->
            <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n" />
        </layout>
    </appender>

    <!-- 将日志信息输出到文件，可以配置多久产生一个新的日志信息文件 -->
    <appender name="DailyRollingFileAppender" class="org.apache.log4j.DailyRollingFileAppender">
        <!-- 设置日志信息输出文件全路径名 -->
        <param name="File" value="../logs/RollingFileAppender.log" />
        <!-- 设置日志每分钟回滚一次，即产生一个新的日志文件 -->
        <param name="DatePattern" value="'.'yyyy-MM-dd-HH-mm'.log'" />
        <!-- 设置日志输出的样式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <!-- 设置日志输出的格式 -->
            <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n" />
        </layout>
    </appender>


    <!--
     注意：
     1：当additivity="false"时，root中的配置就失灵了，不遵循缺省的继承机制
     2：logger中的name非常重要，它代表记录器的包的形式，有一定的包含关系，试验表明
        2-1：当定义的logger的name同名时，只有最后的那一个才能正确的打印日志
        2-2：当对应的logger含有包含关系时，比如：name=test.log4j.test8 和 name=test.log4j.test8.UseLog4j，则2-1的情况是一样的
        2-3：logger的name表示所有的包含在此名的所有记录器都遵循同样的配置，name的值中的包含关系是指记录器的名称哟！注意啦！
     3：logger中定义的level和appender中的filter定义的level的区间取交集
     4：如果appender中的filter定义的 levelMin > levelMax ，则打印不出日志信息
     -->

    <!-- 指定logger的设置，additivity指示是否遵循缺省的继承机制-->
    <logger name="test.log4j.test8.UseLog4j" additivity="false">
        <level value ="WARN"/>
        <appender-ref ref="DailyRollingFileAppender"/>
    </logger>

    <!--指定logger的设置，additivity指示是否遵循缺省的继承机制 -->
    <logger name="test.log4j.test8.UseLog4j_" additivity="false">
        <level value ="ERROR"/>
        <appender-ref ref="RollingFileAppender"/>
    </logger>

    <!-- 根logger的设置-->
    <root>
        <level value ="INFO"/>
        <appender-ref ref="ConsoleAppender"/>
        <!--<appender-ref ref="DailyRollingFileAppender"/>-->
    </root>

</log4j:configuration>

关注打印的日志文件即可：

 <param name="File" value="../logs/RollingFileAppender.log" />

使用的是相对路径。

再看一下流水线启动项目的脚本：

if [ $RESTART == "true" ]
then
    echo "Will restart $INSTALL_PROG"
    sh $INSTALL_DIR/bin/shutdown.sh
    sleep 3
    sh $INSTALL_DIR/bin/startup.sh
    echo "$INSTALL_PROG restarted successfully"
else
    echo "$INSTALL_PROG is not restarted"
fi

重点关注这一行：

sh $INSTALL_DIR/bin/startup.sh

项目跑完流水线启动后功能正常，但是在项目下的logs目录下找不到RollingFileAppender.log文件。

但是手动登录虚拟机进入bin目录下执行：

sh startup.sh

启动后的服务，是能成功打印RollingFileAppender.log文件日志内容的。

于是对比两者方式的不同，一个是在根目录下执行的startup脚本，一个是在项目的bin目录下执行的startup脚本。

所以分析得到，我们使用的log4j指定的“…/logs/RollingFileAppender.log”相对路径，以命令执行的位置作为基础目录。

在根目录执行的startup.sh脚本，创建的日志文件存在“/logs/RollingFileAppender.log”下了，而在bin目录下执行的startup.sh脚本创建的日志文件存"项目路径/logs/RollingFileAppender.log"。

但是由于执行startup脚本的用户没有拥有root权限，因此日志可能无法写到根目录下，导致到处都找不到日志。

三、解决方案

3.1 方案一：修改流水线启动的脚本

直接进入bin目录下执行：

if [ $RESTART == "true" ]
then
    echo "Will restart $INSTALL_PROG"
    cd $INSTALL_DIR/bin
    sh shutdown.sh
    sleep 3
    sh startup.sh
    echo "$INSTALL_PROG restarted successfully"
else
    echo "$INSTALL_PROG is not restarted"
fi

3.2 方案二：修改log4j的指定路径

 <param name="File" value="指定绝对路径" />