文章首發(fā)于微信公眾號(hào)《程序員果果》
地址:https://mp.weixin.qq.com/s/k6UUCD-Rn96po2dw6maSxQ
本篇源碼:https://github.com/gf-huanchupk/SpringBootLearning
一响谓、elk 簡(jiǎn)介
Elasticsearch是個(gè)開(kāi)源分布式搜索引擎搏明,它的特點(diǎn)有:分布式,零配置岭粤,自動(dòng)發(fā)現(xiàn),索引自動(dòng)分片特笋,索引副本機(jī)制剃浇,restful風(fēng)格接口,多數(shù)據(jù)源猎物,自動(dòng)搜索負(fù)載等虎囚。
Logstash是一個(gè)完全開(kāi)源的工具,他可以對(duì)你的日志進(jìn)行收集蔫磨、過(guò)濾淘讥,并將其存儲(chǔ)供以后使用(如,搜索)堤如。
Kibana 也是一個(gè)開(kāi)源和免費(fèi)的工具蒲列,它Kibana可以為 Logstash 和 ElasticSearch 提供的日志分析友好的 Web 界面,可以幫助您匯總搀罢、分析和搜索重要數(shù)據(jù)日志蝗岖。
二、elk的安裝
我們采用的 docker 鏡像安裝榔至。
#下載鏡像
docker pull sebp/elk
#啟動(dòng)鏡像 , 指定es的內(nèi)存
docker run -e ES_JAVA_OPTS="-Xms256m -Xmx256m" -p 5601:5601 -p 5044:5044 -p 9200:9200 -p 9300:9300 -it --name elk 2fbf0a30426d
由于sebp/elk中l(wèi)ogstash的input的方式默認(rèn)是filebeat,首先們需要進(jìn)入elk容器中修改input方式抵赢。logstash默認(rèn)會(huì)將etc/logstash/conf.d/中的配置文件進(jìn)行整合然后啟動(dòng)。
#進(jìn)入容器
docker exec -it elk /bin/bash
#進(jìn)入修改目錄
cd etc/logstash/conf.d/
修改 02-beats-input.conf 文件唧取,修改如下:
input {
tcp {
port => 5044
codec => json_lines
}
}
output{
elasticsearch {
hosts => ["localhost:9200"]
}
}
保存后瓣俯,我們使用 control + P + Q 退出容器。然后重啟容器兵怯,讓我們的配置生效彩匕。
docker restart elk
我們?cè)L問(wèn)http://127.0.0.1:5601
三、創(chuàng)建工程
創(chuàng)建工程springboot-elk 媒区,并使用logback 記錄日志驼仪。
1. pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.gf</groupId>
<artifactId>springboot-elk</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>springboot-elk</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.1.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- logback -->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
</dependency>
<dependency>
<groupId>net.logstash.logback</groupId>
<artifactId>logstash-logback-encoder</artifactId>
<version>5.2</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<fork>true</fork>
</configuration>
</plugin>
</plugins>
</build>
</project>
2. 啟動(dòng)類
@RestController
@SpringBootApplication
public class SpringbootElkApplication {
private final static Logger logger = LoggerFactory.getLogger( SpringbootElkApplication.class );
public static void main(String[] args) {
SpringApplication.run(SpringbootElkApplication.class, args);
}
@GetMapping("/{name}")
public String hi(@PathVariable(value = "name") String name) {
logger.info( "name = {}" , name );
return "hi , " + name;
}
}
3. logback-spring.xml
<?xml version="1.0" encoding="UTF-8"?>
<!--該日志將日志級(jí)別不同的log信息保存到不同的文件中 -->
<configuration>
<include resource="org/springframework/boot/logging/logback/defaults.xml" />
<springProperty scope="context" name="springAppName"
source="spring.application.name" />
<!-- 日志在工程中的輸出位置 -->
<property name="LOG_FILE" value="${BUILD_FOLDER:-build}/${springAppName}" />
<!-- 控制臺(tái)的日志輸出樣式 -->
<property name="CONSOLE_LOG_PATTERN"
value="%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}" />
<!-- 控制臺(tái)輸出 -->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
<!-- 日志輸出編碼 -->
<encoder>
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
<charset>utf8</charset>
</encoder>
</appender>
<!-- 為logstash輸出的JSON格式的Appender -->
<appender name="logstash"
class="net.logstash.logback.appender.LogstashTcpSocketAppender">
<destination>127.0.0.1:5044</destination>
<!-- 日志輸出編碼 -->
<encoder
class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
<providers>
<timestamp>
<timeZone>UTC</timeZone>
</timestamp>
<pattern>
<pattern>
{
"severity": "%level",
"service": "${springAppName:-}",
"trace": "%X{X-B3-TraceId:-}",
"span": "%X{X-B3-SpanId:-}",
"exportable": "%X{X-Span-Export:-}",
"pid": "${PID:-}",
"thread": "%thread",
"class": "%logger{40}",
"rest": "%message"
}
</pattern>
</pattern>
</providers>
</encoder>
</appender>
<!-- 日志輸出級(jí)別 -->
<root level="INFO">
<appender-ref ref="console" />
<appender-ref ref="logstash" />
</root>
</configuration>
啟動(dòng)工程,日志會(huì)存入elasticsearch中袜漩,通過(guò)Kibana 的web界面绪爸,配置后,我們就可看到宙攻,下面我簡(jiǎn)單的修改下配置奠货。
三垄惧、配置 pattern
配置 pattern 輸入*魔策,匹配所有數(shù)據(jù)。
選擇時(shí)間@timestamp,這樣數(shù)據(jù)展示會(huì)以時(shí)間排序
好了 叔遂,點(diǎn)擊discover该肴,就可以看到我們springboot-elk項(xiàng)目的日志信息了轴脐。