首页 > 技术文章 > springboot日志配置Logback

chendeming 2018-02-14 14:23 原文

日志信息是一个应用几乎必须的选项,运维人员以及相关人员可以通过此类信息对应用运行状态进行把控或者对过往错误进行定位。springboot框架当然也有关于日志的配置。

 

一、日志配置

当不需要过多个性化配置时,可直接在springboot的配置文件(application.yml或者application.properties)中配置如下内容即可

#日志文件位置配置,相对于jar

logging.file=log/logger.log

#包路径对应日志级别配置
logging.level.com.inspur=error
logging.level.com.ibatis=info
logging.level.org.java.sql=info
logging.level.org.springframework=debug

当需要更具体的个性化日志配置时,也可以在springboot的配置中进行如下配置,然后参照第二大点进行个性化配置

#logback日志配置xml存放路径配置
logging.config=classpath:logback.xml
#日志文件存储位置
logging.path=/workspace/rock/jpa-test/log

 

二、logback.xml日志结构

<configuration>
  <!-- 日志输出根配置 -->
  <root level="INFO">
    <!-- 生效的appender -->
    <appender-ref ref="INFO_FILE" />
  </root>

  <!-- 日志输出过滤配置 -->
  <logger name="com.inspur" level="error"></logger>
  <logger name="com.ibatis" level="info"></logger>

  <!-- 日志输出方式配置 -->
  <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>

  <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${log.path}</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>${log.path}.%d{yyyy-MM-dd}.zip</fileNamePattern>
    </rollingPolicy>

    <encoder>
      <pattern>%date %level [%thread] %logger{36} [%file : %line] %msg%n</pattern>
    </encoder>
  </appender>

</configuration>

root和logger的属性就没什么可以说的了,appender的属性说一下:

FileAppender:把日志添加到文件,有以下子节点:
  <file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
  <append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
  <encoder>:对记录事件进行格式化。(具体参数稍后讲解 )
  <prudent>:如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。

RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。有以下子节点:
  <file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
  <append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。  
  <rollingPolicy>:当发生滚动时,决定RollingFileAppender的行为,涉及文件移动和重命名。属性class定义具体的滚动策略类
  class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy": 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。有以下子节点:
  <fileNamePattern>:必要节点,包含文件名及“%d”转换符,“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式,如:%d{yyyy-MM}。
如果直接使用 %d,默认格式是 yyyy-MM-dd。RollingFileAppender的file字节点可有可无,通过设置file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到file指定的文件(活动文件),活动文件的名字不会改变;
如果没设置file,活动文件的名字会根据fileNamePattern 的值,每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。  
  <maxHistory>:可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且<maxHistory>是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。


例如:  
<configuration>
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
      <maxHistory>30</maxHistory>
    </rollingPolicy>
    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    </encoder>
  </appender>

  <root level="DEBUG">
    <appender-ref ref="FILE" />
  </root>
</configuration>
上述配置表示每天生成一个日志文件,保存30天的日志文件。

<configuration>
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>test.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
      <fileNamePattern>tests.%i.log.zip</fileNamePattern>
      <minIndex>1</minIndex>
      <maxIndex>3</maxIndex>
    </rollingPolicy>
    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <maxFileSize>5MB</maxFileSize>
    </triggeringPolicy>
    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    </encoder>
  </appender>

  <root level="DEBUG">
    <appender-ref ref="FILE" />
  </root>
</configuration>
上述配置表示按照固定窗口模式生成日志文件,当文件大于20MB时,生成新的日志文件。窗口大小是1到3,当保存了3个归档文件后,将覆盖最早的日志。

 

更多详细内容参照

(1)logback标签属性详解

  http://blog.csdn.net/yingxiake/article/details/51274426

  https://www.jianshu.com/p/f29748aca9c0

(2)springboot如何使用logback

  https://www.cnblogs.com/zb38/p/5411701.html

(3)logback原理详解

  https://www.cnblogs.com/warking/p/5710303.html

推荐阅读