一、前言

这篇文章https://www.jianshu.com/p/9be945a1c318中我详细描述了Spring Boot中如何配置logback日志。在最近的项目中,有这样一个需求:日志信息要使用日志搜集模块进行收集并存入mongodb数据库,所以在日志配置文件中我们必须传入mongodb的配置信息。

二、解决问题

  1. 官网描述


    根据官网的描述可以得到这样的信息:logback.xml加载早于application.yml,如果直接通过${参数key}的形式获取是无法获取到对应参数值的。解决的方法是:
<springProperty scope="context" name="mongo.host" source="spring.data.mongodb.host"/>

source指定的是application.yml配置文件中key,其它地方直接用${mongo.host}引用这个值。但是,相关的属性信息必须放在内部配置文件中,无法从配置中心的配置文件中读取。经过网上收集资料,最后认定可能是这个原因:logback.xml和logback-spring.xml名称为这两个的配置文件,SpringBoot默认为logback的配置文件,那么SpringBoot会在从配置中心获取信息之前就进行加载,这样就会读不到配置中心的属性。

  1. 解决方案
    经过fq搜索,在一个论坛里发现了解决方案:自定义logback配置文件的名称(不是SpringBoot默认的两种名称)并在配置中心指定logback配置文件的位置。这样SpringBoot就不会在获取配置中心的配置前加载日志配置了。经过测试,完美解决问题。
  • 配置中心配置
#mongodb配置

spring.data.mongodb.host=192.168.10.58
spring.data.mongodb.database=ibase2job
spring.data.mongodb.port=27017

#日志配置

logging.config=classpath:logback-custom.xml
  • 日志配置logback-custom.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<property name="logRoot" value="D:/logs"/>
<property name="logModule" value="demo"/>
<!--读取配置中心的属性-->
<springProperty scope="context" name="mongo.host" source="spring.data.mongodb.host"/>
<springProperty scope="context" name="mongo.port" source="spring.data.mongodb.port"/>
<springProperty scope="context" name="mongo.database" source="spring.data.mongodb.database"/>
<appender name="INVOKELOG"
  class="ch.qos.logback.core.rolling.RollingFileAppender">
  <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
    <evaluator class="ch.qos.logback.classic.boolex.OnMarkerEvaluator">
      <marker>INVOKE</marker>
    </evaluator>
    <OnMismatch>DENY</OnMismatch>
    <OnMatch>NEUTRAL</OnMatch>
  </filter>
  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    <fileNamePattern>${logRoot}/${logModule}/invokeLog/%d{yyyy-MM-dd}.log</fileNamePattern>
  </rollingPolicy>
  <encoder>
     <pattern>%d{yyyy-MM-dd HH:mm:ss.SSSS} [requestUrl: %X{REQUESTURI}] [methodName: %X{MNAME}] [args: %X{ARGS}] [userId: %X{UID}] [ip: %X{CLIENTID}] [%thread] %logger - %msg%n</pattern>
  </encoder>
</appender>
<appender name="EXECSQLOG"
  class="ch.qos.logback.core.rolling.RollingFileAppender">
  <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
    <evaluator class="ch.qos.logback.classic.boolex.OnMarkerEvaluator">
      <marker>SQL</marker>
    </evaluator>
    <OnMismatch>DENY</OnMismatch>
    <OnMatch>NEUTRAL</OnMatch>
  </filter>
  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    <fileNamePattern>${logRoot}/${logModule}/execsqlLog/%d{yyyy-MM-dd}.log</fileNamePattern>
  </rollingPolicy>
  <encoder>
    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSSS} [methodName: %X{MNAME}] [args: %X{ARGS}] [sql: %X{SQL}] [table: %X{TABLE}] [userId: %X{UID}] [ip: %X{CLIENTID}] [%thread] %logger - %msg%n</pattern>
  </encoder>
</appender>
<appender name="EXCEPTIONLOG"
  class="ch.qos.logback.core.rolling.RollingFileAppender">
  <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
    <evaluator class="ch.qos.logback.classic.boolex.OnMarkerEvaluator">
      <marker>EXCEPTION</marker>
    </evaluator>
    <OnMismatch>DENY</OnMismatch>
    <OnMatch>NEUTRAL</OnMatch>
  </filter>
  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    <fileNamePattern>${logRoot}/${logModule}/exceptionLog/%d{yyyy-MM-dd}.log</fileNamePattern>
  </rollingPolicy>
  <encoder>
    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSSS} [marker: %marker] [requestUrl: %X{REQUESTURI}] [methodName: %X{MNAME}] [args: %X{ARGS}] [userId: %X{UID}] [ip: %X{CLIENTID}] [%thread] %logger - %msg%n %ex</pattern>
  </encoder>
</appender>
<appender name="PERFORMANCELOG"
  class="ch.qos.logback.core.rolling.RollingFileAppender">
  <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
    <evaluator class="ch.qos.logback.classic.boolex.OnMarkerEvaluator">
      <marker>PERFORMANCE</marker>
    </evaluator>
    <OnMismatch>DENY</OnMismatch>
    <OnMatch>NEUTRAL</OnMatch>
  </filter>
  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    <fileNamePattern>${logRoot}/${logModule}/performanceLog/%d{yyyy-MM-dd}.log</fileNamePattern>
  </rollingPolicy>
  <encoder>
    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSSS} [marker: %marker] [requestUrl: %X{REQUESTURI}] [methodName: %X{MNAME}]  [args: %X{ARGS}]  [userId: %X{UID}] [ip: %X{CLIENTID}] [%thread] [elapseTime: %X{ELAPSETIME}] %logger - %msg%n</pattern>
  </encoder>
</appender>

<appender name="JOBSCHEDULELOG"
  class="ch.qos.logback.core.rolling.RollingFileAppender">
  <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
    <evaluator class="ch.qos.logback.classic.boolex.OnMarkerEvaluator">
      <marker>JOBSCHEDULE</marker>
    </evaluator>
    <OnMismatch>DENY</OnMismatch>
    <OnMatch>NEUTRAL</OnMatch>
  </filter>
  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    <fileNamePattern>${logRoot}/${logModule}/jobscheduleLog/%d{yyyy-MM-dd}.log</fileNamePattern>
  </rollingPolicy>
  <encoder>
    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSSS}  [marker: %marker]  [jobID: %X{JOBID}]  [jobStartTime: %X{JOBSTARTTIME}]  [jobRunTime: %X{JOBRUNTIME}] [jobRunResult: %X{JOBRUNRESULT}]   %logger - %msg%n</pattern>
  </encoder>
</appender>

<!--输出到文件 时间滚动输出-->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
      <!-- 正在记录的日志文件的路径及文件名 -->
    <file>${logRoot}/${logModule}/errorLog/%d{yyyy-MM-dd}.log</file>
      <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
          <!-- 日志归档 -->
        <fileNamePattern>${logRoot}/${logModule}/errorLog/%d{yyyy-MM-dd}.log.zip</fileNamePattern>
          <!--日志文件保留天数-->
          <maxHistory>5</maxHistory>
    </rollingPolicy>
      <!--日志文件输出格式-->
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%msg [%file:%line] %n</pattern>
    </encoder>
</appender>

<!-- mongo 操作调用日志 -->
<appender name="MONGO_INVOKE" class="com.simon.logstatistics.service.MongoDBAppender">
   <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
         <evaluator class="ch.qos.logback.classic.boolex.OnMarkerEvaluator">
             <marker>INVOKE</marker>
         </evaluator>
         <OnMismatch>DENY</OnMismatch>
         <OnMatch>NEUTRAL</OnMatch>
     </filter>
    <host>${mongo.host}</host>
    <port>${mongo.port}</port>
    <dbName>${mongo.database}</dbName>
    <collectionName>log_invoke</collectionName>
</appender>

<!-- <logger>用来设置某一个包或者具体的某一个类的日志打印级别、
     以及指定<appender>。<logger>仅有一个name属性,
     一个可选的level和一个可选的addtivity属性。
     name:用来指定受此logger约束的某一个包或者具体的某一个类。
     level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
     还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。
     如果未设置此属性,那么当前logger将会继承上级的级别。
     addtivity:是否向上级logger传递打印信息。默认是true。
-->
<logger name="com.simon.logstatistics.service" level="INFO">
    <appender-ref ref="INVOKELOG" />
    <appender-ref ref="EXCEPTIONLOG" />
    <appender-ref ref="PERFORMANCELOG" />
    <appender-ref ref="EXECSQLOG" />
    <appender-ref ref="JOBSCHEDULELOG" />
    <appender-ref ref="MONGO_INVOKE" />
</logger>
<!--root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性
    level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
    不能设置为INHERITED或者同义词NULL。默认是DEBUG
    可以包含零个或多个元素,标识这个appender将会添加到这个logger。
-->

<root level="INFO">
    <appender-ref ref="FILE" />
</root>
</configuration>