SpringBoot應用整合ELK實現日誌收集

SpringBoot實戰電商項目mall地址：github.com/macrozheng/…

摘要

ELK即Elasticsearch、Logstash、Kibana,組合起來能夠搭建線上日誌系統，本文主要講解使用ELK來收集SpringBoot應用產生的日誌。

學習前須要瞭解的內容

• 開發者必備Docker命令
• 使用Docker Compose部署SpringBoot應用
• SpringBoot應用中使用AOP記錄接口訪問日誌

ELK中各個服務的做用

• Elasticsearch:用於存儲收集到的日誌信息；
• Logstash:用於收集日誌，SpringBoot應用整合了Logstash之後會把日誌發送給Logstash,Logstash再把日誌轉發給Elasticsearch；
• Kibana:經過Web端的可視化界面來查看日誌。

使用Docker Compose 搭建ELK環境

須要下載的Docker鏡像

docker pull elasticsearch:6.4.0
docker pull logstash:6.4.0
docker pull kibana:6.4.0
複製代碼

搭建前準備

• elasticsearch 啓動成功須要特殊配置，具體參考mall在Linux環境下的部署（基於Docker Compose）中的elasticsearch部分；
• docker-compose.yml文件地址:github.com/macrozheng/…
• logstash-springboot.conf配置文件地址：github.com/macrozheng/…

開始搭建

建立一個存放logstash配置的目錄並上傳配置文件

logstash-springboot.conf文件內容

input {
  tcp {
    mode => "server"
    host => "0.0.0.0"
    port => 4560
    codec => json_lines
  }
}
output {
  elasticsearch {
    hosts => "es:9200"
    index => "springboot-logstash-%{+YYYY.MM.dd}"
  }
}
複製代碼

建立配置文件存放目錄並上傳配置文件到該目錄

mkdir /mydata/logstash
複製代碼

使用docker-compose.yml腳本啓動ELK服務

docker-compose.yml內容

version: '3'
services:
 elasticsearch:
 image: elasticsearch:6.4.0
 container_name: elasticsearch
 environment:
 - "cluster.name=elasticsearch" #設置集羣名稱爲elasticsearch
 - "discovery.type=single-node" #以單一節點模式啓動
 - "ES_JAVA_OPTS=-Xms512m -Xmx512m" #設置使用jvm內存大小
 volumes:
 - /mydata/elasticsearch/plugins:/usr/share/elasticsearch/plugins #插件文件掛載
 - /mydata/elasticsearch/data:/usr/share/elasticsearch/data #數據文件掛載
 ports:
 - 9200:9200
 kibana:
 image: kibana:6.4.0
 container_name: kibana
 links:
 - elasticsearch:es #能夠用es這個域名訪問elasticsearch服務
 depends_on:
 - elasticsearch #kibana在elasticsearch啓動以後再啓動
 environment:
 - "elasticsearch.hosts=http://es:9200" #設置訪問elasticsearch的地址
 ports:
 - 5601:5601
 logstash:
 image: logstash:6.4.0
 container_name: logstash
 volumes:
 - /mydata/logstash/logstash-springboot.conf:/usr/share/logstash/pipeline/logstash.conf #掛載logstash的配置文件
 depends_on:
 - elasticsearch #kibana在elasticsearch啓動以後再啓動
 links:
 - elasticsearch:es #能夠用es這個域名訪問elasticsearch服務
 ports:
 - 4560:4560
複製代碼

上傳到linux服務器並使用docker-compose命令運行

docker-compose up -d
複製代碼

注意：Elasticsearch啓動可能須要好幾分鐘，要耐心等待。

在logstash中安裝json_lines插件

# 進入logstash容器
docker exec -it logstash /bin/bash
# 進入bin目錄
cd /bin/
# 安裝插件
logstash-plugin install logstash-codec-json_lines
# 退出容器
exit
# 重啓logstash服務
docker restart logstash
複製代碼

開啓防火牆並在kibana中查看

systemctl stop firewalld
複製代碼

訪問地址：http://192.168.3.101:5601

SpringBoot應用集成Logstash

在pom.xml中添加logstash-logback-encoder依賴

<!--集成logstash-->
<dependency>
    <groupId>net.logstash.logback</groupId>
    <artifactId>logstash-logback-encoder</artifactId>
    <version>5.3</version>
</dependency>
複製代碼

添加配置文件logback-spring.xml讓logback的日誌輸出到logstash

注意appender節點下的destination須要改爲你本身的logstash服務地址，好比個人是：192.168.3.101:4560 。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration>
<configuration>
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
    <!--應用名稱-->
    <property name="APP_NAME" value="mall-admin"/>
    <!--日誌文件保存路徑-->
    <property name="LOG_FILE_PATH" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/logs}"/>
    <contextName>${APP_NAME}</contextName>
    <!--天天記錄日誌到文件appender-->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_FILE_PATH}/${APP_NAME}-%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    <!--輸出到logstash的appender-->
    <appender name="LOGSTASH" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
        <!--能夠訪問的logstash日誌收集端口-->
        <destination>192.168.3.101:4560</destination>
        <encoder charset="UTF-8" class="net.logstash.logback.encoder.LogstashEncoder"/>
    </appender>
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
        <appender-ref ref="LOGSTASH"/>
    </root>
</configuration>
複製代碼

運行Springboot應用

在kibana中查看日誌信息

建立index pattern

查看收集的日誌

調用接口進行測試

製造一個異常並查看

修改獲取全部品牌列表接口

調用該接口並查看日誌

總結

搭建了ELK日誌收集系統以後，咱們若是要查看SpringBoot應用的日誌信息，就不須要查看日誌文件了，直接在Kibana中查看便可。

項目源碼地址

github.com/macrozheng/…

公衆號

mall項目全套學習教程連載中，關注公衆號第一時間獲取。