乐趣区

关于java:你居然还去服务器上捞日志搭个日志收集系统难道不香么

jiezi

SpringBoot 实战电商我的项目 mall（35k+star）地址：https://github.com/macrozheng/mall

摘要

ELK 日志收集零碎进阶应用，本文次要解说如何打造一个线上环境实在可用的日志收集零碎。有了它，你就能够和去服务器上捞日志说再见了！

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/dat a 目录的权限，再重新启动；
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 中定义了这些属性：

logstash:
  host: localhost

在 logback-spring.xml 中就能够间接这样应用：

<!-- 利用名称 -->
<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 级别的日志。

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

LevelFilter：级别过滤器，依据日志级别进行过滤，比方上面的配置将过滤掉所有非 ERROR 级别的日志。

<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…

公众号

mall 我的项目全套学习教程连载中，关注公众号 第一工夫获取。

退出移动版