前置条件

• 安装linux虚拟机
• 了解docker
• 了解springboot

ELK的含义及其作用

ELK为以下三者单词首字母，除了有ELK还有EFK。这里主要介绍ELK日志系统的搭建

• Elasticsearch:用于存储收集到的日志信息；
• Logstash:用于收集日志，SpringBoot应用整合了Logstash以后会把日志发送给ogstash,Logstash再把日志转发给Elasticsearch；
• Kibana:通过Web端的可视化界面来查看日志。

准备工作=》 拉取需要的镜像

docker pull elasticsearch:7.7.0
docker pull logstash:7.7.0
docker pull kibana:7.7.0

开始搭建

• 创建目录
  mkdir /usr/local/docker/elk
• 创建docker-compose.yml文件

vi docker-compose.yml

version: '3'
services:
  elasticsearch:
    image: elasticsearch:7.7.0
    container_name: elasticsearch
    environment:
      - "cluster.name=elasticsearch" #设置集群名称为elasticsearch
      - "discovery.type=single-node" #以单一节点模式启动
      - "ES_JAVA_OPTS=-Xms512m -Xmx512m" #设置使用jvm内存大小
    volumes:
      - /usr/local/docker/elk/elasticsearch/plugins:/usr/share/elasticsearch/plugins #插件文件挂载
      - /usr/local/docker/elk/elasticsearch/data:/usr/share/elasticsearch/data #数据文件挂载
    ports:
      - 9200:9200
  kibana:
    image: kibana:7.7.0
    container_name: kibana
    depends_on:
      - elasticsearch #kibana在elasticsearch启动之后再启动
    environment:
      - ELASTICSEARCH_URL=http://elasticsearch:9200 #设置访问elasticsearch的地址
    ports:
      - 5601:5601
  logstash:
    image: logstash:7.7.0
    container_name: logstash
    volumes:
      - /usr/local/docker/elk/logstash/logstash-springboot.conf:/usr/share/logstash/pipeline/logstash.conf #挂载logstash的配置文件
    depends_on:
      - elasticsearch #kibana在elasticsearch启动之后再启动
    links:
      - elasticsearch:es #可以用es这个域名访问elasticsearch服务
    ports:
      - 4560:4560

• 创建 logstash目录
  mkdir /usr/local/docker/elk/logstash
• 进入logstash 目录
  cd logstash
• 创建logstash-springboot.conf配置文件

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

• 返回上一级目录
  cd ..

启动项目:
docker-compose up

• 访问Kibana(访问地址：http://ip:5601),返回异常解决方案

异常信息：

Cannot connect to the Elasticsearch cluster currently configured for Kibana.
异常，有可能是elasticsearch启动不成功，可以查看启动日志是否报差错

docker logs -f elasticsearch

• 解决方法 => 提权

看错误我们会以为是es容器里的 /usr/share/elasticsearch/data/nodes 文件夹目录没有读写权限，其实给提示误导了，实际是挂载的目录没有读写权限。比如我们宿主主机的配置目录为:/usr/local/es/data，那么我们需要赋予它读写权限：

chmod 777 /usr/local/docker/elk/elasticsearch/data(宿主机目录)

然后重启 docker-compose restart

• 启动成功后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 汉化

交互式进入kibana容器

• docker exec -it kibana /bin/bash

在该镜像中编辑该配置文件

• vi /opt/kibana/config/kibana.yml

修改该文件 在文件最后加上一行配置

• i18n.locale: zh-CN
• 注意：zhe-CN和:号之间必须有个空格，否则kibana无法启动

重启，即可看到访问的 kibana已汉化。

image

SpringBoot集成Logstash

• 在项目的pom.xml中添加logstash-logback-encoder依赖

<!--集成logstash-->
<dependency>
    <groupId>net.logstash.logback</groupId>
    <artifactId>logstash-logback-encoder</artifactId>
    <version>4.11</version>
</dependency>

• 新建日志配置文件 logback-spring.xml 并添加配置文件logback-spring.xml让logback的日志输出到logstash

注意appender节点下的destination需要改成自己的logstash服务地址，比如我的是：192.168.118.131: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="myshop-demo-elk"/>
    <!--日志文件保存路径-->
    <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.118.131: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 查看日志信息

• 创建索引

image

image

image

image

• 查看日志收集

image

项目地址： shop-demo-elk

总结

有了ELK日志收集系统之后，我们就可以直接在kibana中查看springboot应用的日志情况了。