日志全局配置

系统默认提供logback的日志，具体配置如下

logback.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <configuration>
  4.     <springProperty scope="context" name="logPath" source="logging.file.path" defaultValue="./logs"/>
  5.     <springProperty scope="context" name="appName" source="spring.application.name" defaultValue="company-demo"/>
  7.     <property name="LOG_HOME" value="${logPath}"/>
  8.     <!--
  9.     <contextName>${appName}</contextName>
  10.     -->
  11.     <conversionRule conversionWord="clr"
  12.                     converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
  14.     <conversionRule conversionWord="wex"
  15.                     converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
  17.     <conversionRule conversionWord="wEx"
  18.                     converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
  20.     <!-- 控制台输出 -->
  21.     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
  22.         <encoder>
  23.             <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符 -->
  24.             <pattern>[%d{yyyyMMdd HH:mm:ss}][${appName}][%thread][%level][%logger{36}][%X{traceId}][%X{userId}][%msg]%n
  25.             </pattern>
  26.         </encoder>
  27.     </appender>
  29.     <!-- 按照每天生成日志文件(正常类型文件) -->
  30.     <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  31.         <file>${LOG_HOME}/${appName}.log</file>
  32.         <append>true</append>
  33.         <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
  34.             <!--日志文件输出的文件名 -->
  35.             <FileNamePattern>${LOG_HOME}/logs/%d{yyyy-MM-dd}.%i.${appName}.log.zip</FileNamePattern>
  36.             <maxFileSize>200MB</maxFileSize>
  37.             <MaxHistory>7</MaxHistory>
  38.             <totalSizeCap>20GB</totalSizeCap>
  39.         </rollingPolicy>
  40.         <encoder>
  41.             <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符 -->
  42.             <pattern>[%d{yyyyMMdd HH:mm:ss}][${appName}][%thread][%level][%logger{36}][%X{traceId}][%X{userId}][%msg]%n
  43.             </pattern>
  44.         </encoder>
  45.     </appender>
  47.     <!-- 按照每天生成日志文件(正常类型文件) -->
  48.     <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
  49.         <file>${LOG_HOME}/${appName}-info.log</file>
  50.         <append>true</append>
  51.         <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
  52.             <!--日志文件输出的文件名 -->
  53.             <FileNamePattern>${LOG_HOME}/logs/%d{yyyy-MM-dd}.%i.${appName}-info.log.zip</FileNamePattern>
  54.             <maxFileSize>200MB</maxFileSize>
  55.             <MaxHistory>7</MaxHistory>
  56.             <totalSizeCap>20GB</totalSizeCap>
  57.         </rollingPolicy>
  58.         <encoder>
  59.             <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符 -->
  60.             <pattern>[%d{yyyyMMdd HH:mm:ss}][${appName}][%thread][%level][%logger{36}][%X{traceId}][%X{userId}][%msg]%n
  61.             </pattern>
  62.         </encoder>
  63.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  64.             <level>INFO</level>
  65.             <onMatch>ACCEPT</onMatch>
  66.             <onMismatch>DENY</onMismatch>
  67.         </filter>
  68.     </appender>
  70.     <!-- 按照每天生成日志文件(警告类型文件) -->
  71.     <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
  72.         <file>${LOG_HOME}/${appName}-warn.log</file>
  73.         <append>true</append>
  74.         <rollingPolicy
  75.                 class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
  76.             <!--日志文件输出的文件名 -->
  77.             <FileNamePattern>${LOG_HOME}/logs/%d{yyyy-MM-dd}.%i.${appName}-warn.log.zip</FileNamePattern>
  78.             <maxFileSize>200MB</maxFileSize>
  79.             <MaxHistory>7</MaxHistory>
  80.             <totalSizeCap>20GB</totalSizeCap>
  81.         </rollingPolicy>
  82.         <encoder>
  83.             <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符 -->
  84.             <pattern>[%d{yyyyMMdd HH:mm:ss}][${appName}][%thread][%level][%logger{36}][%X{traceId}][%X{userId}][%msg]%n
  85.             </pattern>
  86.         </encoder>
  87.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  88.             <level>WARN</level>
  89.             <onMatch>ACCEPT</onMatch>
  90.             <onMismatch>DENY</onMismatch>
  91.         </filter>
  92.     </appender>
  94.     <!-- 按照每天生成日志文件(错误类型文件) -->
  95.     <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
  96.         <file>${LOG_HOME}/${appName}-error.log</file>
  97.         <append>true</append>
  98.         <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
  99.             <!--日志文件输出的文件名 -->
  100.             <FileNamePattern>${LOG_HOME}/logs/%d{yyyy-MM-dd}.%i.${appName}-error.log.zip</FileNamePattern>
  101.             <maxFileSize>200MB</maxFileSize>
  102.             <MaxHistory>7</MaxHistory>
  103.             <totalSizeCap>20GB</totalSizeCap>
  104.         </rollingPolicy>
  105.         <encoder>
  106.             <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符 -->
  107.             <pattern>[%d{yyyyMMdd HH:mm:ss}][${appName}][%thread][%level][%logger{36}][%X{traceId}][%X{userId}][%msg]%n
  108.             </pattern>
  109.         </encoder>
  110.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  111.             <level>ERROR</level>
  112.             <onMatch>ACCEPT</onMatch>
  113.             <onMismatch>DENY</onMismatch>
  114.         </filter>
  115.     </appender>
  116.     <!--配置CatAppender，所有的log.error日志，都会打印到cat监控面板-->
  117.     <appender name="CatAppender" class="com.dianping.cat.logback.CatLogbackAppender"/>
  118.     <!-- 指定环境输出指定日志 -->
  119.     <springProfile name="local,dev,test">
  120.         <logger name="java.sql.Connection" level="WARN"/>
  121.         <logger name="java.sql.Statement" level="WARN"/>
  122.         <logger name="java.sql.PreparedStatement" level="WARN"/>
  123.         <logger name="com.company.demo" level="INFO"/>
  124.         <logger name="com.company.demo.dmr.mapper" level="INFO"/>
  125.         <logger name="RocketmqClient" level="WARN"/>
  126.         <logger name="RocketmqCommon" level="WARN"/>
  127.         <logger name="RocketmqRemoting" level="WARN"/>
  128.         <logger name="org.springframework.boot.actuate.endpoint.web.servlet" level="WARN"/>
  130.         <!-- 日志输出级别 -->
  131.         <root level="INFO">
  132.             <!---->
  133.             <appender-ref ref="CONSOLE"/>
  134.             <appender-ref ref="FILE"/>
  135.             <appender-ref ref="CatAppender"/>
  136.             <!--
  137.             <appender-ref ref="INFO"/>
  138.             <appender-ref ref="ERROR"/>
  139.             <appender-ref ref="WARN"/>
  140.             -->
  141.         </root>
  142.     </springProfile>
  143.     <!-- 指定环境输出指定日志 -->
  144.     <springProfile name="staging,pro,task">
  145.         <logger name="java.sql.Connection" level="WARN"/>
  146.         <logger name="java.sql.Statement" level="WARN"/>
  147.         <logger name="java.sql.PreparedStatement" level="WARN"/>
  148.         <logger name="com.company.demo" level="INFO"/>
  149.         <logger name="com.company.demo.dmr.mapper" level="INFO"/>
  150.         <logger name="RocketmqClient" level="WARN"/>
  151.         <logger name="RocketmqCommon" level="WARN"/>
  152.         <logger name="RocketmqRemoting" level="WARN"/>
  153.         <logger name="org.springframework.boot.actuate.endpoint.web.servlet" level="WARN"/>
  155.         <!-- 日志输出级别 -->
  156.         <root level="INFO">
  157.             <appender-ref ref="CONSOLE"/>
  158.             <appender-ref ref="FILE"/>
  159.             <appender-ref ref="CatAppender"/>
  160.             <!--
  161.             <appender-ref ref="ERROR"/>
  162.             <appender-ref ref="INFO"/>
  163.             <appender-ref ref="WARN"/>
  164.             -->
  165.         </root>
  166.     </springProfile>
  167. </configuration>

请求/返回参数日志

提供基于@LogPoint注解方法打印和RequstMapping等spring注解的方法对请求返回参数进行打印。

��配置如下:

  1. #方法上添加LogPoint注解 
  2. xy.log.type=annotation
  3. #拦截restful请求各种Mapping进行拦截
  4. xy.log.type=mapping
  5. xy.log.annotation.enable=true
  6. #指定方url不打印请求入参数据
  7. xy.log.annotation.skip-request=/public/sentinelTest0,/public/sentinelTest1
  8. #指定url不打印请求返回数据
  9. xy.log.annotation.skip-response=/public/sentinelTest0,/public/sentinelTest1
  10. xy.log.mapping.enable=true
  11. #指定方url不打印请求入参数据
  12. xy.log.mapping.skip-request=/ss
  13. #指定url不打印请求返回数据
  14. xy.log.mapping.skip-response=/ss

日志格式

系统日志 - 图1

[请求时间]-[服务名]-[线程ID]-[日志级别]-[当前日志输出的Java对象]-[traceId]-[userId]-[日志类容]

taceId在整个请求链路同步处理中唯一且相同。

对于异步线程处理，若需要记录traceId,需要手动从主线程中通过MDC.get(“traceId”)获取并传递给异步线程。