摘要

ELK日志收集系統(tǒng)進(jìn)階使用，本文主要講解如何打造一個(gè)線上環(huán)境真實(shí)可用的日志收集系統(tǒng)。有了它，你就可以和去服務(wù)器上撈日志說再見了！

ELK環(huán)境安裝

ELK是指Elasticsearch、Kibana、Logstash這三種服務(wù)搭建的日志收集系統(tǒng)，具體搭建方式可以參考《SpringBoot應(yīng)用整合ELK實(shí)現(xiàn)日志收集》。這里僅提供最新版本的Docker-compose腳本和一些安裝要點(diǎn)。

docker-compose腳本

version: '3'
services:
  elasticsearch:
    image: elasticsearch:6.4.0
    container_name: elasticsearch
    environment:
      - "cluster.name=elasticsearch" #設(shè)置集群名稱為elasticsearch
      - "discovery.type=single-node" #以單一節(jié)點(diǎn)模式啟動(dòng)
      - "ES_JAVA_OPTS=-Xms512m -Xmx512m" #設(shè)置使用jvm內(nèi)存大小
      - TZ=Asia/Shanghai
    volumes:
      - /mydata/elasticsearch/plugins:/usr/share/elasticsearch/plugins #插件文件掛載
      - /mydata/elasticsearch/data:/usr/share/elasticsearch/data #數(shù)據(jù)文件掛載
    ports:
      - 9200:9200
      - 9300:9300
  kibana:
    image: kibana:6.4.0
    container_name: kibana
    links:
      - elasticsearch:es #可以用es這個(gè)域名訪問elasticsearch服務(wù)
    depends_on:
      - elasticsearch #kibana在elasticsearch啟動(dòng)之后再啟動(dòng)
    environment:
      - "elasticsearch.hosts=http://es:9200" #設(shè)置訪問elasticsearch的地址
      - TZ=Asia/Shanghai
    ports:
      - 5601:5601
  logstash:
    image: logstash:6.4.0
    container_name: logstash
    environment:
      - TZ=Asia/Shanghai
    volumes:
      - /mydata/logstash/logstash.conf:/usr/share/logstash/pipeline/logstash.conf #掛載logstash的配置文件
    depends_on:
      - elasticsearch #kibana在elasticsearch啟動(dòng)之后再啟動(dòng)
    links:
      - elasticsearch:es #可以用es這個(gè)域名訪問elasticsearch服務(wù)
    ports:
      - 4560:4560
      - 4561:4561
      - 4562:4562
      - 4563:4563

安裝要點(diǎn)

• 使用docker-compose命令運(yùn)行所有服務(wù)：

docker-compose up -d

• 第一次啟動(dòng)可能會(huì)發(fā)現(xiàn)Elasticsearch無法啟動(dòng)，那是因?yàn)?usr/share/elasticsearch/data目錄沒有訪問權(quán)限，只需要修改/mydata/elasticsearch/data目錄的權(quán)限，再重新啟動(dòng)；

chmod 777 /mydata/elasticsearch/data/

• Logstash需要安裝json_lines插件。

logstash-plugin install logstash-codec-json_lines

分場(chǎng)景收集日志

這里為了方便我們查看日志，提出一個(gè)分場(chǎng)景收集日志的概念，把日志分為以下四種。

• 調(diào)試日志：最全日志，包含了應(yīng)用中所有DEBUG級(jí)別以上的日志，僅在開發(fā)、測(cè)試環(huán)境中開啟收集；
• 錯(cuò)誤日志：只包含應(yīng)用中所有ERROR級(jí)別的日志，所有環(huán)境只都開啟收集；
• 業(yè)務(wù)日志：在我們應(yīng)用對(duì)應(yīng)包下打印的日志，可用于查看我們自己在應(yīng)用中打印的業(yè)務(wù)日志；
• 記錄日志：每個(gè)接口的訪問記錄，可以用來查看接口執(zhí)行效率，獲取接口訪問參數(shù)。

Logback配置詳解

要實(shí)現(xiàn)上面的分場(chǎng)景收集日志，主要通過Logback的配置來實(shí)現(xiàn)，我們先來了解下Logback的配置吧！

完全配置

在SpringBoot中，如果我們想要自定義Logback的配置，需要自行編寫logback-spring.xml文件，下面是我們這次要使用的完全配置。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration>
<configuration>
    <!--引用默認(rèn)日志配置-->
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <!--使用默認(rèn)的控制臺(tái)日志輸出實(shí)現(xiàn)-->
    <include resource="org/springframework/boot/logging/logback/console-Appender.xml"/>
    <!--應(yīng)用名稱-->
    <springProperty scope="context" name="APP_NAME" source="spring.application.name" defaultValue="springBoot"/>
    <!--日志文件保存路徑-->
    <property name="LOG_FILE_PATH" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/logs}"/>
    <!--LogStash訪問host-->
    <springProperty name="LOG_STASH_HOST" scope="context" source="logstash.host" defaultValue="localhost"/>

    <!--DEBUG日志輸出到文件-->
    <appender name="FILE_DEBUG"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--輸出DEBUG以上級(jí)別日志-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
        <encoder>
            <!--設(shè)置為默認(rèn)的文件日志格式-->
            <pattern>${FILE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--設(shè)置文件命名格式-->
            <fileNamePattern>${LOG_FILE_PATH}/debug/${APP_NAME}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!--設(shè)置日志文件大小，超過就重新生成文件，默認(rèn)10M-->
            <maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>
            <!--日志文件保留天數(shù)，默認(rèn)30天-->
            <maxHistory>${LOG_FILE_MAX_HISTORY:-30}</maxHistory>
        </rollingPolicy>
    </appender>

    <!--ERROR日志輸出到文件-->
    <appender name="FILE_ERROR"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--只輸出ERROR級(jí)別的日志-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder>
            <!--設(shè)置為默認(rèn)的文件日志格式-->
            <pattern>${FILE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--設(shè)置文件命名格式-->
            <fileNamePattern>${LOG_FILE_PATH}/error/${APP_NAME}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!--設(shè)置日志文件大小，超過就重新生成文件，默認(rèn)10M-->
            <maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>
            <!--日志文件保留天數(shù)，默認(rèn)30天-->
            <maxHistory>${LOG_FILE_MAX_HISTORY:-30}</maxHistory>
        </rollingPolicy>
    </appender>

    <!--DEBUG日志輸出到LogStash-->
    <appender name="LOG_STASH_DEBUG" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
        <destination>${LOG_STASH_HOST}:4560</destination>
        <encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
            <providers>
                <timestamp>
                    <timeZone>Asia/Shanghai</timeZone>
                </timestamp>
                <!--自定義日志輸出格式-->
                <pattern>
                    <pattern>
                        {
                        "project": "mall-tiny",
                        "level": "%level",
                        "service": "${APP_NAME:-}",
                        "pid": "${PID:-}",
                        "thread": "%thread",
                        "class": "%logger",
                        "message": "%message",
                        "stack_trace": "%exception{20}"
                        }
                    </pattern>
                </pattern>
            </providers>
        </encoder>
        <!--當(dāng)有多個(gè)LogStash服務(wù)時(shí)，設(shè)置訪問策略為輪詢-->
        <connectionStrategy>
            <roundRobin>
                <connectionTTL>5 minutes</connectionTTL>
            </roundRobin>
        </connectionStrategy>
    </appender>

    <!--ERROR日志輸出到LogStash-->
    <appender name="LOG_STASH_ERROR" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <destination>${LOG_STASH_HOST}:4561</destination>
        <encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
            <providers>
                <timestamp>
                    <timeZone>Asia/Shanghai</timeZone>
                </timestamp>
                <!--自定義日志輸出格式-->
                <pattern>
                    <pattern>
                        {
                        "project": "mall-tiny",
                        "level": "%level",
                        "service": "${APP_NAME:-}",
                        "pid": "${PID:-}",
                        "thread": "%thread",
                        "class": "%logger",
                        "message": "%message",
                        "stack_trace": "%exception{20}"
                        }
                    </pattern>
                </pattern>
            </providers>
        </encoder>
        <!--當(dāng)有多個(gè)LogStash服務(wù)時(shí)，設(shè)置訪問策略為輪詢-->
        <connectionStrategy>
            <roundRobin>
                <connectionTTL>5 minutes</connectionTTL>
            </roundRobin>
        </connectionStrategy>
    </appender>

    <!--業(yè)務(wù)日志輸出到LogStash-->
    <appender name="LOG_STASH_BUSINESS" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
        <destination>${LOG_STASH_HOST}:4562</destination>
        <encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
            <providers>
                <timestamp>
                    <timeZone>Asia/Shanghai</timeZone>
                </timestamp>
                <!--自定義日志輸出格式-->
                <pattern>
                    <pattern>
                        {
                        "project": "mall-tiny",
                        "level": "%level",
                        "service": "${APP_NAME:-}",
                        "pid": "${PID:-}",
                        "thread": "%thread",
                        "class": "%logger",
                        "message": "%message",
                        "stack_trace": "%exception{20}"
                        }
                    </pattern>
                </pattern>
            </providers>
        </encoder>
        <!--當(dāng)有多個(gè)LogStash服務(wù)時(shí)，設(shè)置訪問策略為輪詢-->
        <connectionStrategy>
            <roundRobin>
                <connectionTTL>5 minutes</connectionTTL>
            </roundRobin>
        </connectionStrategy>
    </appender>

    <!--接口訪問記錄日志輸出到LogStash-->
    <appender name="LOG_STASH_RECORD" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
        <destination>${LOG_STASH_HOST}:4563</destination>
        <encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
            <providers>
                <timestamp>
                    <timeZone>Asia/Shanghai</timeZone>
                </timestamp>
                <!--自定義日志輸出格式-->
                <pattern>
                    <pattern>
                        {
                        "project": "mall-tiny",
                        "level": "%level",
                        "service": "${APP_NAME:-}",
                        "class": "%logger",
                        "message": "%message"
                        }
                    </pattern>
                </pattern>
            </providers>
        </encoder>
        <!--當(dāng)有多個(gè)LogStash服務(wù)時(shí)，設(shè)置訪問策略為輪詢-->
        <connectionStrategy>
            <roundRobin>
                <connectionTTL>5 minutes</connectionTTL>
            </roundRobin>
        </connectionStrategy>
    </appender>

    <!--控制框架輸出日志-->
    <logger name="org.slf4j" level="INFO"/>
    <logger name="springfox" level="INFO"/>
    <logger name="io.swagger" level="INFO"/>
    <logger name="org.springframework" level="INFO"/>
    <logger name="org.hibernate.validator" level="INFO"/>

    <root level="DEBUG">
        <appender-ref ref="CONSOLE"/>
        <!--<appender-ref ref="FILE_DEBUG"/>-->
        <!--<appender-ref ref="FILE_ERROR"/>-->
        <appender-ref ref="LOG_STASH_DEBUG"/>
        <appender-ref ref="LOG_STASH_ERROR"/>
    </root>

    <logger name="com.macro.mall.tiny.component" level="DEBUG">
        <appender-ref ref="LOG_STASH_RECORD"/>
    </logger>

    <logger name="com.macro.mall" level="DEBUG">
        <appender-ref ref="LOG_STASH_BUSINESS"/>
    </logger>
</configuration>

配置要點(diǎn)解析

使用默認(rèn)的日志配置

一般我們不需要自定義控制臺(tái)輸出，可以采用默認(rèn)配置，具體配置參考console-appender.xml，該文件在spring-boot-${version}.jar下面。

<!--引用默認(rèn)日志配置-->
<include resource="org/springframework/boot/logging/logback/defaults.xml"/>
<!--使用默認(rèn)的控制臺(tái)日志輸出實(shí)現(xiàn)-->
<include resource="org/springframework/boot/logging/logback/console-appender.xml"/>

springProperty

該標(biāo)簽可以從SpringBoot的配置文件中獲取配置屬性，比如說在不同環(huán)境下我們的Logstash服務(wù)地址是不一樣的，我們就可以把該地址定義在application.yml來使用。

例如在application-dev.yml中定義了這些屬性：

logstash:
  host: localhost

在logback-spring.xml中就可以直接這樣使用：

<!--應(yīng)用名稱-->
<springProperty scope="context" name="APP_NAME" source="spring.application.name" defaultValue="springBoot"/>
<!--LogStash訪問host-->
<springProperty name="LOG_STASH_HOST" scope="context" source="logstash.host" defaultValue="localhost"/>

filter

在Logback中有兩種不同的過濾器，用來過濾日志輸出。

ThresholdFilter：臨界值過濾器，過濾掉低于指定臨界值的日志，比如下面的配置將過濾掉所有低于INFO級(jí)別的日志。

<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
    <level>INFO</level>
</filter>

LevelFilter：級(jí)別過濾器，根據(jù)日志級(jí)別進(jìn)行過濾，比如下面的配置將過濾掉所有非ERROR級(jí)別的日志。

<filter class="ch.qos.logback.classic.filter.LevelFilter">
    <level>ERROR</level>
    <onMatch>ACCEPT</onMatch>
    <onMismatch>DENY</onMismatch>
</filter>

appender

Appender可以用來控制日志的輸出形式，主要有下面三種。

• ConsoleAppender：控制日志輸出到控制臺(tái)的形式，比如在console-appender.xml中定義的默認(rèn)控制臺(tái)輸出。

<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
	<encoder>
		<pattern>${CONSOLE_LOG_PATTERN}</pattern>
	</encoder>
</appender>

• RollingFileAppender：控制日志輸出到文件的形式，可以控制日志文件生成策略，比如文件名稱格式、超過多大重新生成文件以及刪除超過多少天的文件。

<!--ERROR日志輸出到文件-->
<appender name="FILE_ERROR"
          class="ch.qos.logback.core.rolling.RollingFileAppender">
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <!--設(shè)置文件命名格式-->
        <fileNamePattern>${LOG_FILE_PATH}/error/${APP_NAME}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
        <!--設(shè)置日志文件大小，超過就重新生成文件，默認(rèn)10M-->
        <maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>
        <!--日志文件保留天數(shù)，默認(rèn)30天-->
        <maxHistory>${LOG_FILE_MAX_HISTORY:-30}</maxHistory>
    </rollingPolicy>
</appender>

• LogstashTcpSocketAppender：控制日志輸出到Logstash的形式，可以用來配置Logstash的地址、訪問策略以及日志的格式。

<!--ERROR日志輸出到LogStash-->
<appender name="LOG_STASH_ERROR" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
    <destination>${LOG_STASH_HOST}:4561</destination>
    <encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
        <providers>
            <timestamp>
                <timeZone>Asia/Shanghai</timeZone>
            </timestamp>
            <!--自定義日志輸出格式-->
            <pattern>
                <pattern>
                    {
                    "project": "mall-tiny",
                    "level": "%level",
                    "service": "${APP_NAME:-}",
                    "pid": "${PID:-}",
                    "thread": "%thread",
                    "class": "%logger",
                    "message": "%message",
                    "stack_trace": "%exception{20}"
                    }
                </pattern>
            </pattern>
        </providers>
    </encoder>
    <!--當(dāng)有多個(gè)LogStash服務(wù)時(shí)，設(shè)置訪問策略為輪詢-->
    <connectionStrategy>
        <roundRobin>
            <connectionTTL>5 minutes</connectionTTL>
        </roundRobin>
    </connectionStrategy>
</appender>

logger

只有配置到logger節(jié)點(diǎn)上的appender才會(huì)被使用，logger用于配置哪種條件下的日志被打印，root是一種特殊的appender，下面介紹下日志劃分的條件。

• 調(diào)試日志：所有的DEBUG級(jí)別以上日志；
• 錯(cuò)誤日志：所有的ERROR級(jí)別日志；
• 業(yè)務(wù)日志：com.macro.mall包下的所有DEBUG級(jí)別以上日志；
• 記錄日志：com.macro.mall.tiny.component.WebLogAspect類下所有DEBUG級(jí)別以上日志，該類是統(tǒng)計(jì)接口訪問信息的AOP切面類。

控制框架輸出日志

還有一些使用框架內(nèi)部的日志，DEBUG級(jí)別的日志對(duì)我們并沒有啥用處，都可以設(shè)置為了INFO以上級(jí)別。

<!--控制框架輸出日志-->
<logger name="org.slf4j" level="INFO"/>
<logger name="springfox" level="INFO"/>
<logger name="io.swagger" level="INFO"/>
<logger name="org.springframework" level="INFO"/>
<logger name="org.hibernate.validator" level="INFO"/>

Logstash配置詳解

接下來我們需要配置下Logstash，讓它可以分場(chǎng)景收集不同的日志，下面詳細(xì)介紹下使用到的配置。

完全配置

input {
  tcp {
    mode => "server"
    host => "0.0.0.0"
    port => 4560
    codec => json_lines
    type => "debug"
  }
  tcp {
    mode => "server"
    host => "0.0.0.0"
    port => 4561
    codec => json_lines
    type => "error"
  }
  tcp {
    mode => "server"
    host => "0.0.0.0"
    port => 4562
    codec => json_lines
    type => "business"
  }
  tcp {
    mode => "server"
    host => "0.0.0.0"
    port => 4563
    codec => json_lines
    type => "record"
  }
}
filter{
  if [type] == "record" {
    mutate {
      remove_field => "port"
      remove_field => "host"
      remove_field => "@version"
    }
    json {
      source => "message"
      remove_field => ["message"]
    }
  }
}
output {
  elasticsearch {
    hosts => ["es:9200"]
    action => "index"
    codec => json
    index => "mall-tiny-%{type}-%{+YYYY.MM.dd}"
    template_name => "mall-tiny"
  }
}

配置要點(diǎn)

• input：使用不同端口收集不同類型的日志，從4560~4563開啟四個(gè)端口；
• filter：對(duì)于記錄類型的日志，直接將JSON格式的message轉(zhuǎn)化到source中去，便于搜索查看；
• output：按類型、時(shí)間自定義索引格式。

SpringBoot配置

在SpringBoot中的配置可以直接用來覆蓋Logback中的配置，比如logging.level.root就可以覆蓋<root>節(jié)點(diǎn)中的level配置。

• 開發(fā)環(huán)境配置：application-dev.yml

logstash:
  host: localhost
logging:
  level:
    root: debug

• 測(cè)試環(huán)境配置：application-test.yml

logstash:
  host: 192.168.3.101
logging:
  level:
    root: debug

• 生產(chǎn)環(huán)境配置：application-prod.yml

logstash:
  host: logstash-prod
logging:
  level:
    root: info

Kibana進(jìn)階使用

進(jìn)過上面ELK環(huán)境的搭建和配置以后，我們的日志收集系統(tǒng)終于可以用起來了，下面介紹下在Kibana中的使用技巧！

• 首先啟動(dòng)我們的測(cè)試Demo，然后通用調(diào)用接口（可以使用Swagger），產(chǎn)生一些日志信息；

• 調(diào)用完成后在Management->Kibana->Index Patterns中可以創(chuàng)建Index Patterns，Kibana服務(wù)訪問地址：http://192.168.3.101:5601

• 創(chuàng)建完成后可以在Discover中查看所有日志，調(diào)試日志只需直接查看mall-tiny-debug*模式的日志即可；

• 對(duì)于日志搜索，kibana有非常強(qiáng)大的提示功能，可以通過搜索欄右側(cè)的Options按鈕打開；

• 記錄日志只需直接查看mall-tiny-record*模式的日志即可，如果我們想要搜索uri為/brand/listAll的記錄日志，只需在搜索欄中輸入uri : "/brand/listAll"；

• 錯(cuò)誤日志，只需直接查看mall-tiny-error*模式的日志即可；

• 業(yè)務(wù)日志，只需直接查看mall-tiny-business*模式的日志即可，這里我們可以查看一些SQL日志的輸出；

• 如果日志太大了，可以通過Elasticsearch->Index Management選擇刪除即可。

項(xiàng)目源碼地址

github.com/macrozheng/…

作者：MacroZheng

鏈接：
https://juejin.im/post/5eef217d51882565d74fb4eb

來源：掘金