说在前面
作为开发,日志是可以说是最重要,没有之一的东西。有代码就一定要有日志,日志写的越详细,处理器bug来越简单,解决问题也越容易,所以码代码之前务必先理解日志是怎么生成的。
本文只介绍 Spring Boot 如何在集成 LogBack的情况下 将日志传输到 远端平台 ELK。
ELK,Elasticsearch,logstash,kibana简介,配置,启动,请直接点击对应的名字。
logback(Spring Boot 默认日志)
Logback是log4j框架的作者开发的新一代日志框架,它效率更高、能够适应诸多的运行环境,同时天然支持SLF4J。
Spring Boot (日志篇):集成默认日志logback:https://blog.youkuaiyun.com/Soinice/article/details/82424815
在pom.xml加入相关依赖
<dependency>
<groupId>net.logstash.logback</groupId>
<artifactId>logstash-logback-encoder</artifactId>
<version>4.11</version>
</dependency>
在我们的入口类中填写日志输出
@SpringBootApplication
public class ElkApplication implements CommandLineRunner {
private final static Logger logger= LoggerFactory.getLogger(ElkApplication.class);
public static void main(String[] args) {
SpringApplication.run(ElkApplication.class, args);
}
@Override
public void run(String... arg0) throws Exception {
logger.info("=========hello World========");
}
}
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>
<appender name="LOGSTASH" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
<!-- 指定地址,ip+端口,以及 指定字符集-->
<destination>127.0.0.1:4560</destination>
<encoder charset="UTF-8" class="net.logstash.logback.encoder.LogstashEncoder" />
</appender>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<!--encoder 可以指定字符集,对于中文输出有意义,pattern 包含的日志输出格式-->
<encoder charset="UTF-8">
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>
</encoder>
</appender>
<root level="INFO">
<appender-ref ref="LOGSTASH" />
<appender-ref ref="STDOUT" />
</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:换行符
总结
到此为止终于介绍完日志框架了,平时使用的时候推荐用自定义logback-spring.xml来配置,代码中使用日志也很简单,类里面添加private final Logger logger = LoggerFactory.getLogger(Logger.class);即可。
当然也可以使用lombok方式。