作为开发,日志是可以说是最重要,没有之一的东西。有代码就一定要有日志,日志写的越详细,处理器bug来越简单,解决问题也越容易,所以码代码之前务必先理解日志是怎么生成的。
本文只介绍 Spring Boot 如何在集成 LogBack的情况下 将日志传输到 远端平台 ELK。
ELK(https://blog.csdn.net/Soinice/article/details/84029776#ELK),
Elasticsearch(https://blog.csdn.net/Soinice/article/details/84029776#%E9%85%8D%E7%BD%AE%E3%80%81%E5%90%AF%E5%8A%A8%20Elasticsearch),
简介,配置,启动,请直接点击对应的名字。
logback(Spring Boot 默认日志)
Logback是log4j框架的作者开发的新一代日志框架,它效率更高、能够适应诸多的运行环境,同时天然支持SLF4J。
Spring Boot (日志篇):集成默认日志logback:https://blog.csdn.net/Soinice/article/details/82424815
在pom.xml加入相关依赖
<dependency> <groupId>net.logstash.logback</groupId> <artifactId>logstash-logback-encoder</artifactId> <version>4.9</version> </dependency>
在我们的入口类中填写日志输出
package elk; import com.cmge.sdk.charge.CmgeChargeSdkApplication; import org.junit.Test; import org.junit.runner.RunWith; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner; @RunWith(SpringRunner.class) @SpringBootTest(classes = CmgeChargeSdkApplication.class) public class ElkTest { // 定义一个全局的记录器,通过LoggerFactory获取 private final static Logger log = LoggerFactory.getLogger(ElkTest.class); @Test public void test() { log.trace("trace 成功了"); log.debug("debug 成功了"); log.info("info 成功了"); log.warn("warn 成功了"); log.error("error 成功了"); } }
logback.xml日志配置
Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置(如使用logback-spring.xml,而不是logback.xml),命名为logback-spring.xml的日志配置文件,spring boot可以为它添加一些spring boot特有的配置项(下面会提到)。
默认的命名规则,并且放在 src/main/resources 下面即可:
子节点一:<appender>添加器
appender用来格式化日志输出节点,有俩个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。
<?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="60 seconds" debug="false"> <property name="log.path" value="d://logs/cmge-sdk-charge" /> <property name="log.maxHistory" value="15" /> <property name="log.colorPattern" value="%magenta(%d{yyyy-MM-dd HH:mm:ss}) %highlight(%-5level) %yellow(%thread) %green(%logger) %msg%n"/> <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5level %thread %logger %msg%n"/> <property name="logstash.url" value="127.0.0.1"/> <!--输出到控制台--> <appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>${log.colorPattern}</pattern> </encoder> </appender> <!--输出到文件--> <appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${log.path}/info/info.%d{yyyy-MM-dd}.log</fileNamePattern> <MaxHistory>${log.maxHistory}</MaxHistory> </rollingPolicy> <encoder> <pattern>${log.pattern}</pattern> </encoder> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>INFO</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <appender name="file_error" class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${log.path}/error/error.%d{yyyy-MM-dd}.log</fileNamePattern> </rollingPolicy> <encoder> <pattern>${log.pattern}</pattern> </encoder> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>ERROR</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!--开启tcp格式的logstash传输,通过TCP协议连接Logstash--> <appender name="logstash" class="net.logstash.logback.appender.LogstashTcpSocketAppender"> <destination>${logstash.url}:9601</destination> <encoder charset="GBK" class="net.logstash.logback.encoder.LogstashEncoder"/> </appender> <root level="debug"> <appender-ref ref="console" /> </root> <root level="info"> <appender-ref ref="logstash" /> <appender-ref ref="file_info" /> <appender-ref ref="file_error" /> <!-- <appender-ref ref="logstash" />--> </root> </configuration>
<encoder>表示对日志进行编码:
%contextName:上下文名称
%d{"yyyy-MM-dd HH:mm:ss,SSS"}:日志输出时间
%thread:输出日志的进程名字,这在Web应用以及异步任务处理中很有用
%-5level 或者 %-5p:日志级别,并且使用5个字符靠左对齐
%logger{36}:日志输出者的名字(从右边数,长度为36),由于太长这里引用的 %c{0}-%M
%c{0}:日志输出者的名字,从右边数,第一个(类名)
%M:方法名
%msg 或者%m:日志消息
%n:换行符
logstash-sample.conf配置
# Sample Logstash configuration for creating a simple
# Beats -> Logstash -> Elasticsearch pipeline.
input {
beats {
port => 5044
}
stdin{
}
#开启tcp模式的监听
tcp{
host => "127.0.0.1" #这个需要配置成本机ip,不然logstash无法启动
port => 9601 #端口号
codec => json_lines #将日志以json格式输入
}
}
output {
elasticsearch {
hosts => ["http://localhost:9200"]
index => "%{[@metadata][beat]}-%{[@metadata][version]}-%{+YYYY.MM.dd}"
#user => "elastic"
#password => "changeme"
}
stdout{
codec => json_lines
}
}
总结
到此为止终于介绍完日志框架了,平时使用的时候推荐用自定义logback-spring.xml来配置,代码中使用日志也很简单,类里面添加private final Logger logger = LoggerFactory.getLogger(Logger.class);即可。
当然也可以使用lombok方式。