你竟然還去服務器上撈日誌，搭個日誌收集系統難道不香麼！

時間  2020-07-21
標籤 竟然 還去 服務器 日誌 收集 系統 難道 简体版
原文   原文鏈接
SpringBoot實戰電商項目mall（35k+star）地址： https://github.com/macrozheng/mall

摘要

ELK日誌收集系統進階使用，本文主要講解如何打造一個線上環境真實可用的日誌收集系統。有了它，你就能夠和去服務器上撈日誌說再見了！java

ELK環境安裝

ELK是指Elasticsearch、Kibana、Logstash這三種服務搭建的日誌收集系統，具體搭建方式能夠參考 《SpringBoot應用整合ELK實現日誌收集》。這裏僅提供最新版本的docker-compose腳本和一些安裝要點。

docker-compose腳本

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內存大小
      - TZ=Asia/Shanghai
    volumes:
      - /mydata/elasticsearch/plugins:/usr/share/elasticsearch/plugins #插件文件掛載
      - /mydata/elasticsearch/data:/usr/share/elasticsearch/data #數據文件掛載
    ports:
      - 9200:9200
      - 9300:9300
  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的地址
      - 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啓動以後再啓動
    links:
      - elasticsearch:es #能夠用es這個域名訪問elasticsearch服務
    ports:
      - 4560:4560
      - 4561:4561
      - 4562:4562
      - 4563:4563

安裝要點

  • 使用docker-compose命令運行全部服務：
docker-compose up -d
  • 第一次啓動可能會發現Elasticsearch沒法啓動，那是由於/usr/share/elasticsearch/data目錄沒有訪問權限，只須要修改/mydata/elasticsearch/data目錄的權限，再從新啓動；
chmod 777 /mydata/elasticsearch/data/
  • Logstash須要安裝json_lines插件。
logstash-plugin install logstash-codec-json_lines

分場景收集日誌

這裏爲了方便咱們查看日誌，提出一個分場景收集日誌的概念，把日誌分爲如下四種。
  • 調試日誌：最全日誌，包含了應用中全部DEBUG級別以上的日誌，僅在開發、測試環境中開啓收集；
  • 錯誤日誌：只包含應用中全部ERROR級別的日誌，全部環境只都開啓收集；
  • 業務日誌：在咱們應用對應包下打印的日誌，可用於查看咱們本身在應用中打印的業務日誌；
  • 記錄日誌：每一個接口的訪問記錄，能夠用來查看接口執行效率，獲取接口訪問參數。

Logback配置詳解

要實現上面的分場景收集日誌，主要經過Logback的配置來實現，咱們先來了解下Logback的配置吧！

徹底配置

在SpringBoot中，若是咱們想要自定義Logback的配置，須要自行編寫 logback-spring.xml文件，下面是咱們此次要使用的徹底配置。 
<?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"/>
    <!--應用名稱-->
    <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以上級別日誌-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
        <encoder>
            <!--設置爲默認的文件日誌格式-->
            <pattern>${FILE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--設置文件命名格式-->
            <fileNamePattern>${LOG_FILE_PATH}/debug/${APP_NAME}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!--設置日誌文件大小，超過就從新生成文件，默認10M-->
            <maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>
            <!--日誌文件保留天數，默認30天-->
            <maxHistory>${LOG_FILE_MAX_HISTORY:-30}</maxHistory>
        </rollingPolicy>
    </appender>

    <!--ERROR日誌輸出到文件-->
    <appender name="FILE_ERROR"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--只輸出ERROR級別的日誌-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder>
            <!--設置爲默認的文件日誌格式-->
            <pattern>${FILE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--設置文件命名格式-->
            <fileNamePattern>${LOG_FILE_PATH}/error/${APP_NAME}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!--設置日誌文件大小，超過就從新生成文件，默認10M-->
            <maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>
            <!--日誌文件保留天數，默認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>
        <!--當有多個LogStash服務時，設置訪問策略爲輪詢-->
        <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>
        <!--當有多個LogStash服務時，設置訪問策略爲輪詢-->
        <connectionStrategy>
            <roundRobin>
                <connectionTTL>5 minutes</connectionTTL>
            </roundRobin>
        </connectionStrategy>
    </appender>

    <!--業務日誌輸出到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>
        <!--當有多個LogStash服務時，設置訪問策略爲輪詢-->
        <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>
        <!--當有多個LogStash服務時，設置訪問策略爲輪詢-->
        <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>

配置要點解析

使用默認的日誌配置

通常咱們不須要自定義控制檯輸出，能夠採用默認配置，具體配置參考 console-appender.xml，該文件在 spring-boot-${version}.jar下面。 
<!--引用默認日誌配置-->
<include resource="org/springframework/boot/logging/logback/defaults.xml"/>
<!--使用默認的控制檯日誌輸出實現-->
<include resource="org/springframework/boot/logging/logback/console-appender.xml"/>

springProperty

該標籤能夠從SpringBoot的配置文件中獲取配置屬性，好比說在不一樣環境下咱們的Logstash服務地址是不同的，咱們就能夠把該地址定義在 application.yml來使用。

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

logstash:
  host: localhost

在logback-spring.xml中就能夠直接這樣使用：git

<!--應用名稱-->
<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級別的日誌。github

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

LevelFilter：級別過濾器，根據日誌級別進行過濾，好比下面的配置將過濾掉全部非ERROR級別的日誌。spring

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

appender

Appender能夠用來控制日誌的輸出形式，主要有下面三種。
  • ConsoleAppender：控制日誌輸出到控制檯的形式，好比在console-appender.xml中定義的默認控制檯輸出。
<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">
        <!--設置文件命名格式-->
        <fileNamePattern>${LOG_FILE_PATH}/error/${APP_NAME}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
        <!--設置日誌文件大小，超過就從新生成文件，默認10M-->
        <maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>
        <!--日誌文件保留天數，默認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>
    <!--當有多個LogStash服務時，設置訪問策略爲輪詢-->
    <connectionStrategy>
        <roundRobin>
            <connectionTTL>5 minutes</connectionTTL>
        </roundRobin>
    </connectionStrategy>
</appender>

logger

只有配置到logger節點上的appender纔會被使用，logger用於配置哪一種條件下的日誌被打印，root是一種特殊的appender，下面介紹下日誌劃分的條件。
  • 調試日誌：全部的DEBUG級別以上日誌；
  • 錯誤日誌：全部的ERROR級別日誌；
  • 業務日誌：com.macro.mall包下的全部DEBUG級別以上日誌；
  • 記錄日誌：com.macro.mall.tiny.component.WebLogAspect類下全部DEBUG級別以上日誌，該類是統計接口訪問信息的AOP切面類。

控制框架輸出日誌

還有一些使用框架內部的日誌，DEBUG級別的日誌對咱們並無啥用處，均可以設置爲了INFO以上級別。 
<!--控制框架輸出日誌-->
<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，讓它能夠分場景收集不一樣的日誌，下面詳細介紹下使用到的配置。

徹底配置

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"
  }
}

配置要點

  • input：使用不一樣端口收集不一樣類型的日誌，從4560~4563開啓四個端口；
  • filter：對於記錄類型的日誌，直接將JSON格式的message轉化到source中去，便於搜索查看；
  • output：按類型、時間自定義索引格式。

SpringBoot配置

在SpringBoot中的配置能夠直接用來覆蓋Logback中的配置，好比 logging.level.root就能夠覆蓋 <root>節點中的 level配置。
  • 開發環境配置：application-dev.yml
logstash:
  host: localhost
logging:
  level:
    root: debug
  • 測試環境配置：application-test.yml
logstash:
  host: 192.168.3.101
logging:
  level:
    root: debug
  • 生產環境配置：application-prod.yml
logstash:
  host: logstash-prod
logging:
  level:
    root: info

Kibana進階使用

進過上面ELK環境的搭建和配置之後，咱們的日誌收集系統終於能夠用起來了，下面介紹下在Kibana中的使用技巧！
  • 首先啓動咱們的測試Demo，而後通用調用接口（可使用Swagger），產生一些日誌信息；

  • 調用完成後在Management->Kibana->Index Patterns中能夠建立Index Patterns，Kibana服務訪問地址：http://192.168.3.101:5601

  • 建立完成後能夠在Discover中查看全部日誌，調試日誌只需直接查看mall-tiny-debug*模式的日誌便可；

  • 對於日誌搜索，kibana有很是強大的提示功能，能夠經過搜索欄右側的Options按鈕打開；

  • 記錄日誌只需直接查看mall-tiny-record*模式的日誌便可，若是咱們想要搜索uri爲/brand/listAll的記錄日誌，只需在搜索欄中輸入uri : "/brand/listAll"；

  • 錯誤日誌，只需直接查看mall-tiny-error*模式的日誌便可；

  • 業務日誌，只需直接查看mall-tiny-business*模式的日誌便可，這裏咱們能夠查看一些SQL日誌的輸出；

  • 若是日誌太大了，能夠經過Elasticsearch->Index Management選擇刪除便可。

項目源碼地址

https://github.com/macrozheng...docker

公衆號

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

公衆號圖片

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程