Springboot Logback自定义日志

本文展示两种日志文件命名格式：
格式一：

1
2
3
Boer-Office.springboot-produce.20180728.0.log
Boer-Office.springboot-produce.20180728.1.log
Boer-Office.springboot-produce.20180728.2.log <- 当前active日志

格式二：

1
2
3
Boer-Office.springboot-produce.20180728.0.log
Boer-Office.springboot-produce.20180728.1.log
Boer-Office.springboot-produce.log <- 当前active日志

一般根据日志文件的备份脚本会这么写：

伪代码如下：$(date -d “-1 day” +%Y%m%d)

crontab - rsync: tar -zcf Boer-Office.springboot-produce.$(date -d "-1 day" +%Y%m%d).tgz Boer-Office.springboot-produce.$(date -d "-1 day" +%Y%m%d).*.log

简单、高效！

基于此脚本，格式一不会有问题，格式二在传统虚拟机的部署方式下也不会有问题，但是在K8S的deployment部署方式下就会存在问题：考虑一下，假设当前active日志是Boer-Office.springboot-produce.log，这时由于某种原因服务挂掉，kube-apiserver, kube-controller配合kube-scheduler将应用pod重新调度(有可能会调度到其他node上)，此时当前active日志Boer-Office.springboot-produce.log并不会归档为Boer-Office.springboot-produce.20180728.x.log的格式，所以当备份脚本运行的时候Boer-Office.springboot-produce.log文件的日志就丢失了。
运维又背锅啦…

1、Springboot配置

1
2
3
4
5
6
7
8
9
10
logging:
  config: classpath:logback-spring.xml
  # config: classpath:logback-${spring.profiles.active}.xml
  # file:
  #   max-size: 10KB
  #   max-history: 7
  #   path: logs
  #   name: logs/${HOSTNAME}.${spring.application.name}.log
  # pattern:
  #   rolling-file-name: "logs/${HOSTNAME}.${spring.application.name}.%d{yyyyMMdd}.%i.log"

2、Custom Log Configuration

src/main/resources/logback-spring.xml 即：classpath目录

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
  <conversionRule conversionWord="wex"
                  converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
  <conversionRule conversionWord="wEx"
                  converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
  <property name="CONSOLE_LOG_PATTERN"
            value="${CONSOLE_LOG_PATTERN:-%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
  <property name="FILE_LOG_PATTERN"
            value="${FILE_LOG_PATTERN:-%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
  <property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>

  <logger name="org.apache.catalina.startup.DigesterFactory" level="ERROR"/>
  <logger name="org.apache.catalina.util.LifecycleBase" level="ERROR"/>
  <logger name="org.apache.coyote.http11.Http11NioProtocol" level="WARN"/>
  <logger name="org.apache.sshd.common.util.SecurityUtils" level="WARN"/>
  <logger name="org.apache.tomcat.util.net.NioSelectorPool" level="WARN"/>
  <logger name="org.eclipse.jetty.util.component.AbstractLifeCycle" level="ERROR"/>
  <logger name="org.hibernate.validator.internal.util.Version" level="WARN"/>
  <logger name="org.springframework.boot.actuate.endpoint.jmx" level="WARN"/>

  <appender name="FILE"
            class="ch.qos.logback.core.rolling.RollingFileAppender">
    <encoder>
      <pattern>${FILE_LOG_PATTERN}</pattern>
    </encoder>
    <!-- <file>${LOG_FILE}</file> -->
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
      <cleanHistoryOnStart>${LOG_FILE_CLEAN_HISTORY_ON_START:-false}</cleanHistoryOnStart>
      <!-- <fileNamePattern>${ROLLING_FILE_NAME_PATTERN:-${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz}</fileNamePattern> -->
      <fileNamePattern>logs/${HOSTNAME}.${APPNAME}.%d{yyyyMMdd}.%i.log</fileNamePattern>
      <maxFileSize>${LOG_FILE_MAX_SIZE:-1KB}</maxFileSize>
      <maxHistory>${LOG_FILE_MAX_HISTORY:-7}</maxHistory>
      <totalSizeCap>${LOG_FILE_TOTAL_SIZE_CAP:-0}</totalSizeCap>
    </rollingPolicy>
  </appender>

  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>${CONSOLE_LOG_PATTERN}</pattern>
    </encoder>
  </appender>

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

3、Ref

DevOps
#SpringCloud #SpringBoot #Log4J2 #Logback
Springboot Logback自定义日志
https://www.boer.xyz/2018/07/28/springboot-logging-configuration/
作者
boer
发布于
2018年7月28日
许可协议