SpringBoot整合ELK教程

2023-11-20

SpringBoot整合ELK教程

1 基础概念

ELK 即 Elasticsearch、Logstash、Kibana,组合起来可以搭建线上日志系统,本文主要讲解使用 ELK 来收集测试框架产生的日志。

在这里插入图片描述

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

2 通过docker compose搭建ELK环境

需要有docker环境:
docker安装教程

2.1 前置环境

  1. 下载docker compose

Docker Compose是一个用于定义和运行多个docker容器应用的工具。使用Compose你可以用YAML文件来配置你的应用服务,然后使用一个命令,你就可以部署你配置的所有服务了。管理docker的工具

curl -L https://get.daocloud.io/docker/compose/releases/download/1.24.0/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
  1. 修改文件为可执行
chmod +x /usr/local/bin/docker-compose
  1. 查看是否安装成功
docker-compose --version

在这里插入图片描述
4. 下载docker有关镜像

docker pull elasticsearch:7.6.2
docker pull logstash:7.6.2
docker pull kibana:7.6.2

2.2 正式搭建(docker)

①创建配置文件

  • 创建文件夹
mkdir -p /mydata/logstash
cd /mydata/logstash
  • 编写配置文件logstash-springboot.conf
vim 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}"
  }
}

②创建脚本启动ELK

vim docker-compose.yml
version: '3'
services:
  elasticsearch:
    image: elasticsearch:7.6.2
    container_name: elasticsearch
    user: root
    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
      - 9300:9300
  logstash:
    image: logstash:7.6.2
    container_name: logstash
    environment:
      - TZ=Asia/Shanghai
    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
  kibana:
    image: kibana:7.6.2
    container_name: kibana
    links:
      - elasticsearch:es #可以用es这个域名访问elasticsearch服务
    depends_on:
      - elasticsearch #kibana在elasticsearch启动之后再启动
    environment:
      - "elasticsearch.hosts=http://es:9200" #设置访问elasticsearch的地址
    ports:
      - 5601:5601

③启动脚本

docker-compose up -d

如果启动时出错,没有权限,添加权限执行权限即可

chmod 777 /mydata/elasticsearch/data/

在这里插入图片描述
如果elasticsearch如上图一样没有启动起来,重启即可,因为启动时间需要比较久

docker restart 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

访问地址:

# ip改成自己的即可
http://192.168.145.13:5601/

bug:

  • 如果访问kibana地址出现如下错误:

Kibana server is not ready yet

解决方法:

方法一:

将配置文件kibana.yml中的elasticsearch.url改为正确的链接,默认为: http://elasticsearch:9200,改为http://自己的IP地址:9200【改成自己的ip】

# 查看本机ip
ip address

在这里插入图片描述
①查看es内部容器ip

# 查看elasticsearch内部容器ip
docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' elasticsearch
# 172.18.0.4

在这里插入图片描述
②进入kibana容器,修改配置文件

# 进入 Kibana 容器内部,修改 kibana.yml 中的ip
# docker ps 查看kibana容器名
docker exec -it kibana容器id /bin/bash
# docker exec -it 8db0dd14cd59_kibana /bin/bash

在这里插入图片描述

# 修改配置文件
cd config
vi kibana.yml
# 只需要将上面的 "http://elasticsearch:9200"中的 
#elasticsearch 替换成上一步的es容器内部ip就可以了。

在这里插入图片描述
③退出kibana容器,并重启kibana

exit
docker restart kibana容器名
# docker restart 8db0dd14cd59_kibana

方法二:

关闭防火墙

systemctl stop firewalld
# 查看防火墙状态:是否关闭成功
systemctl status firewalld

#永久关闭防火墙
# systemctl disable firewalld.service

# 重启docker
systemctl restart docker
#重启docker服务
docker-compose up -d

方法三:

服务器内存不够

# 查看内存使用情况
free -h 

在这里插入图片描述
设置swap

  1. 创建swapfile:# dd if=/dev/zero of=swapfile bs=1024 count=500000 (of是空间名称,count是空间大小,bs是单位,这里是kb,你可以将bs=1024改为bs=1G,后面的count就可以改为count=2,就是创建2G大小的swap文件)
  2. 将swapfile设置为swap空间:# mkswap swapfile
  3. 启用交换空间: # swapon swapfile (删除交换空间命令 swapoff swapfile)

如果提示不安全,则使用sudo chmod 600 swapfile

  1. 再用free -h命令查看内存情况,就会发现Swap中的内存增加了,

在这里插入图片描述
方法四:

看自己是否开启了VPN或者代理,关闭之后,重新打开浏览器访问即可

最后,测试:

# 输入自己服务器的ip(我的是192.168.145.13:5601)
http://192.168.145.13:5601/

成功访问:
在这里插入图片描述

2.3 SpringBoot框架集成logstash

项目结构:
在这里插入图片描述

①pom.xml添加依赖
<!--集成logstash-->
<dependency>
    <groupId>net.logstash.logback</groupId>
    <artifactId>logstash-logback-encoder</artifactId>
    <version>5.3</version>
</dependency>

完整pom文件:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.11</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.zi</groupId>
    <artifactId>elk-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>elk-demo</name>
    <description>elk-demo</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--引入logstash收集日志-->
        <dependency>
            <groupId>net.logstash.logback</groupId>
            <artifactId>logstash-logback-encoder</artifactId>
            <version>5.3</version>
        </dependency>

        <dependency>
            <!--方便打印日志-->
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.12</version>
        </dependency>

        <dependency>
            <!--方便测试-->
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>
②添加配置文件 logback-spring.xml

让 logback 的日志输出到 logstash

注意 appender 节点下的 destination 需要改成你自己的 logstash 服务地址,比如我的是:192.168.145.13: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="springboot-logback-elk-demo"/>
    <!--日志文件保存路径-->
    <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.145.13: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>
③运行测试

测试类:

@SpringBootTest
@Slf4j
public class LogbackdemoApplicationTests {

    @Test
    public void contextLoads() {
        log.info("输出info");
        log.debug("输出debug");
        log.error("输出error");
    }
}

在这里插入图片描述

2.4 使用kibana

  1. 创建 index pattern
    在这里插入图片描述
    在这里插入图片描述
    在这里插入图片描述
    成功创建:
    在这里插入图片描述

  2. 查看收集的日志
    在这里插入图片描述

  3. 筛选日志
    在这里插入图片描述

  4. 查看日志详情
    在这里插入图片描述

搭建了 ELK 日志收集系统之后,我们如果要查看测试框架的日志信息,就不需要查看日志文件了,直接 在Kibana 中查看即可。

参考文章:
https://cloud.tencent.com/developer/article/1704647?from=article.detail.1468662

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

SpringBoot整合ELK教程 的相关文章

随机推荐

  • 《深入理解计算机系统》实验四Architecture Lab

    前言 深入理解计算机系统 实验四Architecture Lab下载和官方文档机翻请看 深入理解计算机系统 实验四Architecture Lab下载和官方文档机翻 我觉得这个文档对整个实验很有帮助 如果你的Y86 64环境还没安装好可以看
  • 一个互联网研发团队的标准配置

    做一件大事 通常会产生一个组织 对于一个组织来说 确定了梦想和目标之后 首要的事情是 组织分工和明确 权责 权利和责任分不清楚 效率必定低下 读书阶段的时候 无论是学习 还是做事 从来没有深刻地感受过 事倍功半 和 事半功倍 工作之后 经历
  • JavaEE简单示例——在使用Tomcat的时候可能出现的一些报错

    简单介绍 在我们之前使用Tomcat的时候 经常会出现在启动的时候因为一些报错导致项目无法正常的启动 我们就对一些比较常见的报错来看一下可能导致的原因 以及出现报错之后如何去解决 严重 Failed to initialize end po
  • 汇率之谜:揭秘黄金折算与真实人民币汇率的神秘差距

    导言 人民币是中国的官方货币 其汇率在国际贸易和金融市场中扮演着至关重要的角色 然而 观察到黄金折算的人民币汇率与真实人民币汇率之间存在显著差距 本文将探讨这一差距的原因以及它所暗示的经济现象 汇率基础知识 首先 让我们了解一下汇率的基础知
  • Linux服务器远程访问通过Tomcat部署的静态资源

    一 安装Java和Tomcat 1 1 安装Java 下载jdk8 切换到root用户 创建文件夹 usr local java 将下载的jdk压缩包上传到该目录下 解压 mkdir usr local java cd usr local
  • 8、配置多生成树技术(MSTP协议)

    什么是生成树技术 在局域网通信中 为了能确保网络连接的可靠性和稳定性 常常需要网络提供冗余链路 而所谓的 冗余链路 就是当一条通信信道遇到堵塞或者不通畅时 就启用别的通信信道 冗余就是准备两条以上的链路 如果主链路不通了 就启用备用链路 什
  • 树梅派应用19:树莓派安装OpenWRT做路由器图文详解

    在玩OP之前 你需要一个靠谱的以太网卡 一个型号为RTL8192CU AR9271的无线网卡 官方芯片的无线网卡都可以 随便大小的SD卡或者TF卡 都是可以的 由于没有高手指导 我算是走了不少弯路 废话不多说 首先 下载OpenWRT的系统
  • 若依单体版添加免密登录

    若依单体版添加 免密登录 的流程在其官网有流程 若依常见问题地址 可以查询到 如何实现用户免密登录配置方法 具体代码官网都有 记录一下实际操作部分细节 1 LoginService添加login方法 去掉密码验证 可能是若依框架更新频繁 网
  • mysql8.0.18数据恢复方法-ibd文件恢复(innodb引擎)

    1 创建同名数据库 2 创建相同的表 3 使用ALTER TABLE 数据库名 表名 DISCARD TABLESPACE 4 将ibd文件拷贝到数据库的数据目录下 5 使用ALTER TABLE 数据库名 表名 IMPORT TABLES
  • apt-get: command not found

    CentOS5 4 apt get install gcc bash apt get command not found 解答 CentOS的软件安装工具不是apt get 是yum yum y install gcc 在ubuntu下安装
  • 检索 COM 类工厂中 CLSID 为 {} 的组件时失败,原因是出现以下错误: 80040154没有注册类.(注册组件的方法)

    执行程序报错如下 原因 没有注册rmReport组件 解决办法 注册组件 注册组件方法如下 首先你要知道你要注册哪个文件 并且找到它 上图报错位置那个变量是我要注册的文件 并且我在自己的项目中找到了它 之后打开C Windows Syste
  • 仅需一个样本即可定制个性化的SAM

    Personalize Segment Anything Model with One Shot https arxiv org pdf 2305 03048 pdf https github com ZrrSkywalker Person
  • shell脚本之循环语句

    for循环 语法1 for i in 集合 do 程序 done 语法2 for i 0 i lt 100 i do 程序 done eg 批量压缩文件 bin bash 批量压缩文件 cd root ls tar gz gt ls log
  • Flutter屏幕适配之二:Image资源assets的使用,实现不同分辨率图片的适配

    这两天在研究Flutter的屏幕适配方案 关于尺寸大小已经有点眉目了 初步定了利用等比例缩放 感兴趣的朋友可移步Flutter屏幕大小适配 但是还是不清楚怎么进行图片分辨率适配的 在百度了之后 仍然有点云里雾里 罢了 直接上官网看吧 果然
  • 【机器学习】入门:为什么梯度下降算法这么有效?

    译者 张雨佳 人们很难真正通过数学理解东西 你只需要去习惯并使用它 约翰 冯 诺伊曼 在机器学习中 我们已经习惯了使用梯度下降法解决问题 以至于没人去质疑它为什么有效 大家经常将梯度下降法模拟为爬山 要想找到崎岖地形中的顶峰 或低谷 就必须
  • Unity之获取游戏物体对象或组件的几个方法

    文章目录 前言 通过物体名称获取对象 GameObject Find Transform Find 通过物体标签获取对象 GameObject FindWithTag GameObject FindGameObjectWithTag Gam
  • 使用SVD求最小二乘刚性转置

    参见文章 Least Squares Rigid Motion Using SVD 一 问题描述 假设P p1 p2 pn 和Q q1 q2 qn 是两组Rd空间中的对应点集 现在想要根据这个两个点集的数据来计算出它们之间的刚性转置信息 可
  • LINUX下安装软件命令详解

    一 解析Linux应用软件安装包 通常Linux应用软件的安装包有三种 1 tar包 如software 1 2 3 1 tar gz 它是使用UNIX系统的打包工具tar打包的 2 rpm包 如software 1 2 3 1 i386
  • QT遍历文件夹下的所有文件

    文章目录 方法一 代码 方法二 需要注意的地方 代码 技巧 代码 方法一 使用类QDirIterator来进行遍历 简介 大概是说 适合于大目录遍历 支持递归但是不支持排序 QDirIterator NoIteratorFlags默认值 没
  • SpringBoot整合ELK教程

    SpringBoot整合ELK教程 1 基础概念 ELK 即 Elasticsearch Logstash Kibana 组合起来可以搭建线上日志系统 本文主要讲解使用 ELK 来收集测试框架产生的日志 Elasticsearch 用于存储