SpringBoot Admin 详解

SpringBoot Admin 详解

  • 一、Actuator 详解
    • 1.Actuator原生端点
      • 1.1 监控检查端点:health
      • 1.2 应用信息端点:info
      • 1.3 http调用记录端点:httptrace
      • 1.4 堆栈信息端点:heapdump
      • 1.5 线程信息端点:threaddump
      • 1.6 获取全量Bean的端点:beans
      • 1.7 条件自动配置端点:conditions
      • 1.8 配置属性端点:configprops
      • 1.9 追踪度量端点:metrics
      • 1.10 根据名称追踪度量端点:metrics/{name}
      • 1.11 获取全部环境端点:env
      • 1.12 根据名称获取环境属性端点:env/{name}
      • 1.13 审计事件端点:auditevents
      • 1.14 停止Actuator端点:shutdown
    • 2.使用Actuator
      • 2.1 引入依赖
      • 2.2 增加配置信息
      • 2.3 验证端点
      • 2.5 自定义根路径
  • 二、SpringBoot Admin 详解
    • 1.服务端搭建
      • 1.1 引入依赖
      • 1.2 启动类增加注解
      • 1.3 启动服务
    • 2.客户端搭建
      • 2.1 引入依赖
      • 2.2 增加application.yml配置
      • 2.3 启动客户端
  • 三、SpringBoot Admin功能展示
    • 1.功能介绍-细节
    • 2.功能介绍-环境
    • 3.功能介绍-类
    • 4.功能介绍-配置属性
    • 5.功能介绍-日志配置
    • 6.功能介绍-JVM
    • 7.功能介绍-映射

SpringBoot Admin是一个三方的监控和服务管理组件,常用于服务监控的检查,服务元信息获取,是一个轻量且简单的组件。他依赖于Actuator暴漏的接口完成大部分功能,Actuator是一个用于提供服务多种监控接口的组件。这里先总结Actuator的用法,再介绍SpringBoot Admin集成Actuator以后如何使用。

一、Actuator 详解

Actuator是一个可以快速集成在SpringBoot项目中的组件,他支持对单个项目暴露监控接口,同时还支持自定义的监控接口,方便我们进行自定义的一些信息监控,比如说health这个是用途最广范的接口,经常被用来做服务的健康检查,企业中有各种各样的监控组件,但无论使用何种监控组件都需要有一个接口对外提供健康信息展示,那health就可以做这个事情。

1.Actuator原生端点

所谓原生端点(Endpoint)就是指Actuator自带的监控接口,这些接口是最常用、最普遍的监控类接口,适用于大多数场景,一般这些场景是完全够用的了,除非有特殊场景,否则是无需自己定义端点信息的。下面根据这些监控接口的常用频率来由高到底进行说明。

1.1 监控检查端点:health

接口地址:/health
请求方式:GET
端点作用:验证服务是否健康,是否在线的接口,这个也是最常用的接口,一般对服务的监控监控都是使用该接口,SpringBoot项目基本都会使用该接口做健康监控。

1.2 应用信息端点:info

接口地址:/info
请求方式:GET
端点作用:获取自定义的info信息,使用时需要在配置文件增加info开头的配置信息,比如如下:

1.3 http调用记录端点:httptrace

接口地址:/httptrace
请求方式:GET
端点作用:默认显示最近100次的http调用记录,包含请求和响应

1.4 堆栈信息端点:heapdump

接口地址:/heapdump
请求方式:GET
端点地址:可以返回一份jvm的堆信息,这个功能和jvm参数的堆转存储快照类似

1.5 线程信息端点:threaddump

接口地址:/threaddump
请求方式:GET
端点作用:获取线程活动的信息

1.6 获取全量Bean的端点:beans

接口地址:/beans
请求方式:GET
端点作用:获取服务中全部的Bean的信息

1.7 条件自动配置端点:conditions

接口地址:/conditions
请求方式:GET
端点作用:用于显示系统中使用条件进行装配的信息的情况,常见的有ConditionalOnProperty等,只有满足某些条件才会进行操作,此端点用于显示此类的条件满足情况。

1.8 配置属性端点:configprops

接口地址:/configprops
请求方式:GET
端点作用:描述的是属性被Bean加载的信息

1.9 追踪度量端点:metrics

接口地址:/metrics
请求方式:GET
端点作用:内存、http等信息的追踪展示

1.10 根据名称追踪度量端点:metrics/{name}

接口地址:/metrics/{name}
请求方式:GET
端点作用:指定名称的展示

1.11 获取全部环境端点:env

接口地址:/env
请求方式:GET
端点作用:获取服务的全部环境信息

1.12 根据名称获取环境属性端点:env/{name}

接口地址:/env/{name}
请求方式:GET
端点作用:指定名称获取对应环境属性的值

1.13 审计事件端点:auditevents

接口地址:/auditevents
请求方式:GET
端点作用:显示应用的审计事件,比如认证失败等

1.14 停止Actuator端点:shutdown

接口地址:/shutdown
请求方式:POST
端点作用:用以关闭Actuator所在的应用服务,注意只有这个是POST,使用他可以不用进入服务器就实现应用的关闭,比如某个服务异常了,想要将这个服务从集群中剔除出去,就可以使用这个功能。

2.使用Actuator

这里使用一个SpringBoot项目进行测试Actuator的提供的这些接口。注意这个项目得是web项目。

2.1 引入依赖

这里需要至少引入web和Actuator的依赖


<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId><version>2.5.4</version>
</dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><version>2.6.11</version></dependency>

2.2 增加配置信息

如果不增加配置信息,上面的这些监控接口就只有个别的开启了,大部分是不可用的,比如health是开启的但也只展示在线信息,所以我们需要开启其他端点。下面的配置信息都有详细的注解,这里不做多余的解释了,解释详见配置上的注释,正常生产使用这些配置也完全够用了:

server:port: 8093#  配置应用名称, 方便监控使用
spring:application:name: test-actuatorversion: 1.0.0# 暴露监控端点
management:endpoints:web:exposure:# 配置需要暴露出去的端点,一般直接*暴露全部就行include: "*"endpoint:health:# health 默认只展示 是否在线,增加该配置后会展示更多信息show-details: ALWAYSshutdown:# 启用关闭应用的功能,不启用则无法关闭应用enabled: trueinfo:env:# 开启info端点的配置支持,不开启info将无信息返回,即使配置了info也无信息enabled: true
# 自定义info端点信息,info端点获取的就是这里的信息
info:title: ${spring.application.name}服务version: ${spring.application.name}-${spring.application.version}description: ${spring.application.name}服务监控

2.3 验证端点

上面配置增加完以后就可以启动服务了,这里基本不会有任何意外,然后开始验证接口。

  • 验证health端点
    注意这里actuator是固定前缀,支持更改(生产如果处于安全考虑可以更改):

    http://localhost:8093/actuator/health
    

    health端点的信息如下,这里包含了在线状态服务器的ping状态,服务器的磁盘信息等。在这里插入图片描述

  • 验证info端点
    info端点的信息是自定义信息,这里验证是否返回的是我们自定义的信息

    http://localhost:8093/actuator/info
    

    可以看到返回的正式我们自定义的信息,这里信息可以随便指定,title、version等名称都是随便指定的。
    在这里插入图片描述

  • 验证beans端点
    这个是获取全量bean信息的端点

    http://localhost:8093/actuator/beans
    

    结果如下图,也没啥问题
    在这里插入图片描述

  • 验证shutdown端点
    这个接口需要使用POST方式进行调用

    http://localhost:8093/actuator/shutdown
    

    然后借助postman进行调用测试,结果如下:
    在这里插入图片描述
    然后观察应用程序,发现确实已经被关闭了:
    在这里插入图片描述

  • 验证jvm端快照端点
    这个可以用来观察生产实时的堆信息,还是有一些作用的。

    http://localhost:8093/actuator/heapdump
    

    请求后会直接下载一份堆信息,需要我们使用对应工具才可以打开,网上一堆这种在线工具,下面是执行截图:
    在这里插入图片描述
    可以随便找个在线工具打开看看,这里笔者用的是这个:https://heaphero.io/heap-index.jsp#header
    分析结果如下,这里不做jvm知识的拓展了,从下图可以看到已经正常分析出了堆的信息了,说明我们拿到的dump文件时可用的:
    在这里插入图片描述
    端点验证就不一一验证了。

2.5 自定义根路径

上面也提到过,Actuator是支持自定义根路径的,如果使用根路径会有一些安全隐患,比如别人通过抓包知道了你的接口地址,就可以使用Actuator的接口使用DOS进行攻击你的系统,这是有安全隐患的,解决这个办法有的是去集成认证,有的是更改默认地址,默认地址更改后就很难猜出来真正的端点地址了。所以这里建议生产更改默认的接口地址,如下:

# 暴露监控端点
management:endpoints:web:# 这是监控的默认根路径,支持自定义base-path: /observe

重启服务进行验证,如下,可见地址更改生效:
在这里插入图片描述

二、SpringBoot Admin 详解

SpringBoot Admin是一个在github上开元的社区项目,通过使用Actuator暴漏的端点来是实现项目的可视化监控和管理。SpringBoot Admin是一个简单易用的小组件,易上手,可以作为中小公司健康监控系统的使用是没有太大问题的。
SpringBoot Admin是一个BS架构,分为客户端和服务端,这里分别就进行介绍。

1.服务端搭建

服务端搭建也比较简单,只需要少量的配置就可以运行,首先我们需要导入所需服务端的依赖

1.1 引入依赖

这里需要引入web和admin-server两个依赖,admin监控的肯定是web服务,所以这里引入web依赖。

<!-- 版本保持与springboot统一即可 -->
<dependency><groupId>de.codecentric</groupId><artifactId>spring-boot-admin-starter-server</artifactId><version>2.6.11</version>
</dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><version>2.6.11</version>
</dependency>

1.2 启动类增加注解

这个也比较简单,直接启动类上增加一个注解即可,用以表示admin的服务端。

@EnableAdminServer

如下:
在这里插入图片描述

1.3 启动服务

只需要简单的两步导入依赖和增加注解即可开启一个服务端,服务启动基本不会有任何异常,服务启动完成以后,然后打开如下地址:

# applications 是默认地址
http://localhost:8094/applications

然后展示如下,此时没有客户端,所有目前这里没有任何信息,信息的展示需要等到客户端同样启动以后才会有展示:
在这里插入图片描述

2.客户端搭建

客户端搭建也很简单,只需要引入web依赖和admin的客户端依赖就行,注意客户端不需要重复引入Actuator的依赖,因为Admin的客户端已经默认引入了这个依赖。

2.1 引入依赖

<!-- 客户端依赖版本保持和服务端一致 -->
<dependency><groupId>de.codecentric</groupId><artifactId>spring-boot-admin-starter-client</artifactId><version>2.6.11</version>
</dependency>
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><version>2.6.11</version>
</dependency>

2.2 增加application.yml配置

客户端因为默认是集成了Actuator的,所以我们上面使用的Actuator的配置依然是可用的,只需要在原有的Actuator的配置基础上增加服务端地址的信息指定即可,客户端全部配置信息如下:

server:port: 8093#  配置应用名称, 方便监控使用
spring:application:name: test-actuatorversion: 1.0.0boot:admin:client:# 指定admin-server的地址url:  http://localhost:8094# 暴露监控端点
management:endpoints:web:exposure:# 配置需要暴露出去的端点,一般直接*暴露全部就行include: "*"# 这是监控的默认根路径,支持自定义base-path: /observeendpoint:health:# health 默认只展示 是否在线,增加该配置后会展示更多信息show-details: ALWAYSshutdown:# 启用关闭应用的功能,不启用则无法关闭应用enabled: trueinfo:env:# 开启info端点的配置支持,即使配置了info也无信息enabled: true
# 自定以info端点信息,info端点获取的就是这里的信息
info:title: ${spring.application.name}服务version: ${spring.application.name}-${spring.application.version}description: ${spring.application.name}服务监控

2.3 启动客户端

添加完配置以后直接启动客户端服务就行了,客户端服务启动完成后就可以导服务端的页面中查看信息了,服务端地址:http://localhost:8094/applications
信息展示如下:
在这里插入图片描述
到这里客户端和服务端的搭建就全部完成了,以下介绍下admin的使用。

三、SpringBoot Admin功能展示

SpringBoot Admin其实就是将Actuator暴露的端点进行了可视化,这里大部分的接口都是Actuator提供的。
在admin-server的首页点击服务名,如下
在这里插入图片描述
然后会弹出如下的服务信息,这里继续点击服务名,即可进入到当前服务的监控页面了
在这里插入图片描述
点击后进入到下面的页面,几乎主要的功能都在这里了:
在这里插入图片描述
或者也可以从如下位置直接点击进入到上图的页面:
在这里插入图片描述

1.功能介绍-细节

细节这块的信息,仔细一看就会比较熟悉了,基础展示如下:
信息:展示的是info端点的信息。
监控:展示的就是health的信息
元数据:项目的启动时间
进程:项目的进程id使用的cpu等信息
线程:线程的总数与当前系统使用的线程数
垃圾回收:jvm垃圾回收的次数与耗时
内存heap:jvm堆使用信息
non heap:jvm栈的使用信息
在这里插入图片描述
在这里插入图片描述

2.功能介绍-环境

这里展示的是项目加载和使用的各种环境变量信息的key和value,使用的就是env端点,没啥特别需要说的
在这里插入图片描述

3.功能介绍-类

这里展示的是spring容器加载的类信息,其实就是beans端点,用来查看所有的加载的bean信息。
在这里插入图片描述

4.功能介绍-配置属性

这里其实就configprops端点在这里插入图片描述

5.功能介绍-日志配置

这里可以动态调整系统各个目录的日志级别,这个还是有用的,调整后实时生效

在这里插入图片描述

6.功能介绍-JVM

这里是heapdump和threaddump的信息,在这里可以看到线程和jvm堆的信息
在这里插入图片描述

7.功能介绍-映射

这个是mappings端点,用于展示接口和类之间的关系
在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/701152.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

4、全球资产配置策略

2022年06月23日 传统的资产配置就是在债券类资产和国内股票类资产间以一定的比例进行调整。但是这类资产配置模式往往缺乏一类风险收益特征和国内资产接近但相关性较低、并且还可以有效分散国内市场风险的资产&#xff0c;而进行境外资产投资则可以很好地弥补这一空缺。实际上全…

Java学习——正则表达式

正则表达式是一种强大的文本处理工具&#xff0c;用于搜索、匹配、替换文本。它们定义了字符串的搜索模式&#xff0c;可以快速地检查一个字符串是否与某个模式匹配&#xff0c;提取匹配字符串&#xff0c;或者执行替换操作。正则表达式在文本编辑器、编程语言和数据库管理中广…

R3F(React Three Fiber)基础篇

之前一直在做ThreeJS方向&#xff0c;整理了两篇R3F&#xff08;React Three Fiber&#xff09;的文档&#xff0c;这是基础篇&#xff0c;如果您的业务场景需要使用R3F&#xff0c;您又对R3F不太了解&#xff0c;或者不想使用R3F全英文文档&#xff0c;您可以参考一下这篇&…

【Python笔记-设计模式】享元模式

一、说明 享元模式是一种结构型设计模式&#xff0c;它摒弃了在每个对象中保存所有数据的方式&#xff0c;通过共享多个对象所共有的相同状态&#xff0c;让你能在有限的内存容量中载入更多对象。 (一) 解决问题 旨在减少大量相似对象创建时的内存开销 (二) 使用场景 大量…

AI:136-基于深度学习的图像生成与风格迁移

🚀点击这里跳转到本专栏,可查阅专栏顶置最新的指南宝典~ 🎉🎊🎉 你的技术旅程将在这里启航! 从基础到实践,深入学习。无论你是初学者还是经验丰富的老手,对于本专栏案例和项目实践都有参考学习意义。 ✨✨✨ 每一个案例都附带关键代码,详细讲解供大家学习,希望…

github 笔记: fatal: Could not read from remote repository.

git clone 包时出现这两行报错 gitgithub.com: Permission denied (publickey). fatal: Could not read from remote repository.这意味着 SSH 认证失败了&#xff0c;通常是因为本地机器的 SSH 密钥未被 GitHub 账户识别/未正确设置。在终端中使用 ssh -T gitgithub.com 可以…

微服务三十五关

1.微服务有什么好处&#xff1f; 微服务优点很多&#xff0c;但是我们通常说一个东西好肯定会跟另一个东西比较&#xff0c; 通常说微服务好会和单体项目进行比较。以下是微服务相对于单体项目的一些显著好处&#xff1a; 首先&#xff0c;让我们讨论单体项目的一些主要缺点&a…

STM32_LCD1602_2_液晶屏初始化

HD44780的指令集及其设置说明 共11条指令&#xff1a; 清屏指令 指令功能指令编码执行时间/msRSR/WDB7DB6DB5DB4DB3DB2DB1DB0清屏00000000011.64 功能&#xff1a; 清除液晶屏&#xff0c;即将DDRAM的所有内容都写为“空”的ASCII的20H&#xff1b;光标归位&#xff0c;即将光…

多态与代码屎山

到底什么是多态呢?多态是面向未来的,比如企业采购为例: 一般分为线上合线下两种, 我们设计一个父类叫做"采购", 里面做一些共通的处理: 申请, 承认, 支付, 购买方式. 然后让各自的子类(线上,线下)实现自己的方法.实际调用过程中传入不同的对象就可以.到此为止项目开…

在线程调用的函数中使用pthread_exit同样会将线程退出

如上图所示&#xff0c;在func()函数中调用pthread_exit&#xff0c;同样可以退出当前线程&#xff1b; 类似的&#xff0c;如果func&#xff08;&#xff09;函数中调用exit&#xff0c;可以直接退出整个进程。 return 是返回到函数调用处&#xff1b; pthread_exit是退出…

KTV点歌系统vue+springboot音乐歌曲播放器系统

目前现有的KTV点歌系统对于用户而言其在线点歌流程仍然过于繁琐&#xff0c;对于歌曲而言其系统安全性并不能保障。同时整套系统所使用的技术相对较为落后&#xff0c;界面不能动态化展示。相比较于其它同类型网站而言不能体现技术先进性。 1.2 项目目标 KTV点歌系统的后台开发…

wpf 3d 后台加载模型和调整参数

下载了一个代码&#xff0c;加载obj模型&#xff1b;它的参数在xaml里&#xff0c;模型加载出来刚好&#xff1b; 然后加载另一个obj模型&#xff1b;加载出来之后大&#xff0c;偏到很高和左的位置&#xff1b; 它之前的摄像机位置&#xff0c; Position"9.94759830064…

Apache celeborn 安装及使用教程

1.下载安装包 https://celeborn.apache.org/download/ 测0.4.0时出现https://github.com/apache/incubator-celeborn/issues/835 2.解压 tar -xzvf apache-celeborn-0.3.2-incubating-bin.tgz 3.修改配置文件 cp celeborn-env.sh.template celeborn-env.shcp log4j2.xml.…

前后端分离Vue+nodejs校园论坛bbs系统x450z

开发语言 node.js 框架&#xff1a;Express 前端:Vue.js 数据库&#xff1a;mysql 数据库工具&#xff1a;Navicat 开发软件&#xff1a;VScode本论文拟采用计算机技术设计并开发的论坛bbs系统&#xff0c;主要是为用户提供服务。使得用户可以在系统上查看帖子信息、签到积分等…

jQuery中的事件与DOM操作

jQuery事件 jQuery事件是对JavaScript事件的封装,常用事件分类 基础事件 鼠标事件键盘事件window事件表单事件绑定事件与移除事件复合事件 鼠标光标悬停鼠标连续点击jQuery基础事件 鼠标事件 鼠标事件是当用户在文档上移动或单击鼠标时而产生的事件 下面是一个使用 Markdow…

大厂嵌入式公司面试真题

面试题&#xff1a; 基础知识题 请解释C语言中的指针是什么以及它们如何工作&#xff1f;描述C语言中的动态内存分配。malloc、calloc、realloc和free这些函数有何区别&#xff1f;C语言中的宏&#xff08;macro&#xff09;和函数之间有什么不同&#xff1f;代码理解题 #incl…

详解Megatron中的数据混合算法(BlendableDataset)

&#x1f9d1;‍&#x1f4bb; 本文主要讲解Megatron早期版本中的数据混合算法。 目录 1. 数据混合2. 源码解析3. 证明部分&讨论4. 进一步优化 1. 数据混合 在谈源码之前&#xff0c;我们有必要先了解一下Megatron中的数据混合思想。 给定 n n n 个数据集 D 1 , D 2 , …

给定一个边与边可能相交的多边形,求它的轮廓线

大家好&#xff0c;我是前端西瓜哥。 最近遇到一个需求&#xff0c;给定一个多边形&#xff08;边与边可能相交&#xff09;&#xff0c;求这个多边形的轮廓线。 需要注意的是&#xff0c;轮廓线多边形内不能有空洞&#xff0c;使用的不是常见的非零绕数规则&#xff08;nonze…

Java+SpringBoot,打造极致申报体验

✍✍计算机编程指导师 ⭐⭐个人介绍&#xff1a;自己非常喜欢研究技术问题&#xff01;专业做Java、Python、微信小程序、安卓、大数据、爬虫、Golang、大屏等实战项目。 ⛽⛽实战项目&#xff1a;有源码或者技术上的问题欢迎在评论区一起讨论交流&#xff01; ⚡⚡ Java实战 |…

2024全国水科技大会暨流域水环境治理与水生态修复论坛(六)

论坛召集人 冯慧娟 中国环境科学研究院流域中心研究员 刘 春 河北科技大学环境与工程学院院长、教授 一、会议背景 为深入贯彻“山水林田湖是一个生命共同体”的重要指示精神&#xff0c;大力实施生态优先绿色发展战略&#xff0c;积极践行人、水、自然和谐共生理念&…