SpringBoot Actuator和Spring boot Admin工具

news2024/10/9 4:18:23

目录

一、Spring Boot Actuator

1、简介

2、访问方式

3、端点

4、SpringBoot项目引入actuator

端点

①health

②beans

③configprops

④env

⑤loggers

⑥heapdump

⑦threaddump

⑧metrics

⑨scheduledtasks

⑩mappings

⑪shutdown

定制端点

一、定制health端点

二、自定义info端点

三、自定义metrics端点

四、自定义Endpoint

二、Spring Boot Admin

1、简介

2、搭建SpringBootAdmin

①、搭建服务端

②、搭建客户端

③、安全防护

④、邮件通知

一、Spring Boot Actuator

1、简介

官方介绍，为生产环境准备的特性。可以用来监控和管理发布到生产环境下的应用。比如，应用的健康状态、日志信息、内存占用、线程信息、Bean加载信息等等。

官网地址：

Spring Boot Actuator: Production-ready Featuresicon-default.png?t=N7T8https://docs.spring.io/spring-boot/docs/2.5.6/reference/html/actuator.html

2、访问方式

  • http
  • JMX

3、端点

端点就是SpringBoot Actuator对外暴露的一系列接口，actuator服务端可以通过这些接口获得对应的信息，比如日志、内存、线程等等。

Spring Boot Actuator: Production-ready Featuresicon-default.png?t=N7T8https://docs.spring.io/spring-boot/docs/2.5.6/reference/html/actuator.html#actuator.endpoints端点有actuator提供的原生的，也可以用户自定义端点。

原生端点是在应用程序里提供众多 Web 接口，通过它们了解应用程序运行时的内部状况。原生端点可以分成三类：

  • 应用配置类：可以查看应用在运行期的静态信息：例如自动配置信息、加载的 springbean 信息、yml 文件配置信息、环境信息、请求映射信息；
  • 度量指标类：主要是运行期的动态信息，例如堆栈、请求连、一些健康指标、metrics 信息等；
  • 操作控制类：主要是指 shutdown,用户可以发送一个请求将应用的监控功能关闭。

原生自带的端点有以下这些：也可以参考官网说明，只不过官网是英文。

每一个端点是可以设置启动或禁用的，Spring Boot 2.x版本默认是只启用了health 和 info两个端点，其他默认是关闭的。

4、SpringBoot项目引入actuator

创建SpringBoot项目，引入actuator依赖

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

启动SpringBoot项目，访问 localhost:8080/actuator ，只要项目引入actuator依赖，就可以访问默认的health和info端点。

如果想开启所有的端点，将配置为 '*' 即可。如果配置多个用 , 分割

management.endpoints.web.exposure.include=*
management.endpoints.web.exposure.exclude=env,beans

端点

①health

health端点是显示服务或应用健康状态的接口，默认只显示状态，不显示详情，health有三种状态配置never、when-authorized、always，默认是never。

官网描述：Spring Boot Actuator: Production-ready Features

可以配置成always,则会显示状态详情，配置属性是management.endpoint.health.show-details，效
果如下：status是总的状态，其中有一个子节点的状态变为down的话，总的status也会变为down。

②beans

beans端点是注册进容器中的对象实例

③configprops

配置属性的信息

④env

配置的环境相关的变量属性

⑤loggers

各个包下的类对应的日志级别及其对应的信息展示。级别是可调的。调日志级别需要发送post请求，网页是无法发送的。

如果要远程查看日志信息，则需要将日志存储在文件中。配置属性logging.file.name,配置完以后会多一个端点 /logfile,存储日志信息。

⑥heapdump

容器运行时的jvm信息，比如堆栈占用信息等等，可以结合jdk自带的java VisualVM来分析。

⑦threaddump

线程的一些信息

⑧metrics

各个指标、http请求数，jdbc连接数，gc次数，cpu使用情况等等。

⑨scheduledtasks

任务调度

⑩mappings

映射信息

⑪shutdown

优雅关闭

优雅关闭就是如果在关闭容器的时候，还有请求任务未处理完成，则等待这些任务处理完成并返回以后才会关闭容器。

容器需要先配置优雅关闭开启，server.shutdown = graceful

容器支持优雅关闭以后，就可以发送post请求到shutdown端点来优雅关闭容器。

定制端点

一、定制health端点

@Component
public class CustomHealthIndicator extends AbstractHealthIndicator {
    @Override
    protected void doHealthCheck(Health.Builder builder) throws Exception {
        boolean res = check();
        if (res) {
            builder.up();
        } else {
            builder.down();
        }
    }

    private boolean check() {
        return true;
    }
}

实现抽象类，其中的doHealthCheck是检查端点是否健康的方法，在这里可以实现自定义。

访问 localhost:8080/actuator/health 效果如下：

二、自定义info端点

默认的info端点没有任何信息。

方式一：通过yml配置文件的方式实现

info:
  app-name: test
  version: 3.0.0
  mavenversion: @project.artifactId@   # @@可以获取pom配置文件的属性值

效果：localhost:8080/actuator/info

方式二：编写代码的方式实现

@Component
public class CustomInfo implements InfoContributor {
    @Override
    public void contribute(Info.Builder builder) {
        builder.withDetail("k1", "v1")
                .withDetail("hello", "world")
                .withDetails(Collections.singletonMap("kkk", "vvv"));
    }
}

效果：

配置文件和编写代码的方式可以同时使用，最终会汇集所有的信息。

三、自定义metrics端点

默认的metrics端点提供了jvm、数据库连接信息、cpu、进程相关的一些信息。

counter

计数器，一个简单的Meter，可以用来记录请求次数、支付订单次数等增长类的统计。

//定制metrics counter指标
Metrics.counter("count","tags").increment();

查看metrics端点，发现自定义的counter指标也出现了。

访问接口counter会增加，实现计数器的效果。

查看指标的具体数据，在http://localhost:8080/actuator/metrics/ 后面跟上对应的指标即可。

Timer

定时器指标，用来记录一些代码执行的时间计算。

Guage

一般用来记录有浮动值的数据，例如积压的消息，任务，集合、数组等等。

Summary

可以记录命中率的一些doble值。

四、自定义Endpoint

官网描述戳这里：Spring Boot Actuator: Production-ready Features

@Component
@Endpoint(id = "wjPoint")
public class CustomPoint {
    Map<String,Object> map = new HashMap();
    {
        Map<String,String> m1 = new HashMap<>();
        m1.put("k1","v1");
        m1.put("k2","v2");
        Map<String,String> m2 = new HashMap<>();
        m2.put("k3","v3");
        m2.put("k4","v4");
        map.put("m1",m1);
        map.put("m2",m2);
    }

    @ReadOperation
    public Map getOperation(){
        return map;
    }
}

二、Spring Boot Admin

1、简介

基于SpringBoot Actuator的可视化的监控平台，是一个vue程序。

官方地址：

GitHub - codecentric/spring-boot-admin: Admin UI for administration of spring boot applicationsAdmin UI for administration of spring boot applications - codecentric/spring-boot-adminicon-default.png?t=N7T8https://github.com/codecentric/spring-boot-admin文档说明地址：

Spring Boot Admin Reference Guideicon-default.png?t=N7T8https://docs.spring-boot-admin.com/2.5.1/#getting-started

2、搭建SpringBootAdmin

SpringBootAdmin分为服务端和客户端

服务端：即SpringBootAdmin这个监控平台

客户端：即被监控平台监控的后台应用或者容器服务

①、搭建服务端

第一步：创建SpringBoot服务作为admin服务端，服务端需要引入依赖(用到的SpringBoot的版本是2.5.6)

<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-server</artifactId>
    <version>2.5.1</version>
</dependency>

第二步：启动类加注解@EnableAdminServer

第三步，直接启动

浏览器可以访问，但是目前只有服务端，没有客户端的效果。

②、搭建客户端

第一步：创建SpringBoot应用程序作为客户端，引入依赖

<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-client</artifactId>
    <version>2.5.1</version>
</dependency>

第二步：yml中配置服务端的地址和要暴露的端点

spring.boot.admin.client.url=http://localhost:8080  
management.endpoints.web.exposure.include=*

第三步：启动客户端

这时候服务端的监控页面就会出现一个刚刚启动的客户端实例，绿色就是正常的，如果显示红色或者灰色就需要查看客户端服务的健康状态了。

所有暴露的端点中的信息都可以在监控平台页面上面查看。

③、安全防护

SpringBootAdmin结合SpringSecurity做了登录的用户身份的校验，在进入监控页面之前需要先登录的功能。

Spring Boot Admin Reference Guideicon-default.png?t=N7T8https://docs.spring-boot-admin.com/2.5.1/#_securing_spring_boot_admin_server第一步：在服务端引入依赖

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

第二步：配置SecureConfig配置类

官方有详细的说明，不懂Spring Security问题不大。

@Configuration(proxyBeanMethods = false)
public class SecuritySecureConfig extends WebSecurityConfigurerAdapter {

  private final AdminServerProperties adminServer;

  private final SecurityProperties security;

  public SecuritySecureConfig(AdminServerProperties adminServer, SecurityProperties security) {
    this.adminServer = adminServer;
    this.security = security;
  }

  @Override
  protected void configure(HttpSecurity http) throws Exception {
    SavedRequestAwareAuthenticationSuccessHandler successHandler = new SavedRequestAwareAuthenticationSuccessHandler();
    successHandler.setTargetUrlParameter("redirectTo");
    successHandler.setDefaultTargetUrl(this.adminServer.path("/"));

    http.authorizeRequests(
        (authorizeRequests) -> authorizeRequests.antMatchers(this.adminServer.path("/assets/**")).permitAll() 
            .antMatchers(this.adminServer.path("/actuator/info")).permitAll()
            .antMatchers(this.adminServer.path("/actuator/health")).permitAll()
            .antMatchers(this.adminServer.path("/login")).permitAll().anyRequest().authenticated() 
    ).formLogin(
        (formLogin) -> formLogin.loginPage(this.adminServer.path("/login")).successHandler(successHandler).and() 
    ).logout((logout) -> logout.logoutUrl(this.adminServer.path("/logout"))).httpBasic(Customizer.withDefaults()) 
        .csrf((csrf) -> csrf.csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse()) 
            .ignoringRequestMatchers(
                new AntPathRequestMatcher(this.adminServer.path("/instances"),
                    HttpMethod.POST.toString()), 
                new AntPathRequestMatcher(this.adminServer.path("/instances/*"),
                    HttpMethod.DELETE.toString()), 
                new AntPathRequestMatcher(this.adminServer.path("/actuator/**")) 
            ))
        .rememberMe((rememberMe) -> rememberMe.key(UUID.randomUUID().toString()).tokenValiditySeconds(1209600));
  }

  // Required to provide UserDetailsService for "remember functionality"
  @Override
  protected void configure(AuthenticationManagerBuilder auth) throws Exception {
    auth.inMemoryAuthentication().withUser(security.getUser().getName())
        .password("{noop}" + security.getUser().getPassword()).roles("USER");
  }

}

第三步：服务端的yml配置文件配置admin登录页面的用户名和密码

spring.security.user.name=123456
spring.security.user.password=123456

第四步：注册到服务端的客户端配置文件也需要配置登录的用户名和密码，格式如下

spring.boot.admin.client:
   username: 123456
   password: 123456

这样就算是实现了安全防护。

当然，SpringBoot除了可以注册单个客户端，也可以注册注册中心的客户端，就可以监控整个注册中心中的应用和服务。

④、邮件通知

SpringBootAdmin支持客户端服务发生异常时的通知，包括邮箱通知，钉钉或者其他的方式，具体参考官网：

Spring Boot Admin Reference Guideicon-default.png?t=N7T8https://docs.spring-boot-admin.com/2.5.1/#_notifications第一步：引入依赖（服务端）

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

第二步：配置邮箱信息，发件人和收件人

#发件人用qq邮箱服务，发件人的用户名和密码，密码是授权码
spring.mail.host=smtp.qq.com
spring.mail.username=123456789@qq.com
spring.mail.password=1234567889

#收件人,多个人用，分割
spring.boot.admin.notify.mail.from=123456789@qq.com
spring.boot.admin.notify.mail.to=123456789@qq.com

上面的邮箱使用实际的邮箱，邮箱密码其实是qq邮箱是授权码

授权获取方式在qq邮箱后台设置里面获取：

根据指引获取授权码即可。

当服务挂了(或者重启)以后，就会有邮件发送出来

练习源码已上传：https://download.csdn.net/download/ywanju/89053368icon-default.png?t=N7T8https://download.csdn.net/download/ywanju/89053368

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

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

【Spring Cache】基于注解的缓存框架 简化redis代码

【Spring Cache】基于注解的缓存框架 简化redis代码

文章目录 一、介绍二、常用注解三、快速入门3.1 EnableCaching3.2 CachePut3.3 Cacheable3.4 CacheEvict 一、介绍 Spring Cache 是一个框架&#xff0c;实现了基于注解的缓存功能&#xff0c;只需要简单地加一个注解&#xff0c;就能实现缓存功能。 Spring Cache 提供了一层…
阅读更多...
产品经理与产品原型

产品经理与产品原型

点击下载《产品经理与产品原型》 1. 前言 互联网产品经理在向技术部门递交产品策划方案时，除了详尽的需求阐述，一份清晰易懂的产品原型设计方案同样不可或缺。一份出色的原型设计，不仅能促进前期的深入讨论，更能让美工和开发人员更直观地理解产品特性，进而优化工作流程，…
阅读更多...
Java代码基础算法练习-求偶数和-2024.03.29

Java代码基础算法练习-求偶数和-2024.03.29

任务描述&#xff1a; 编制程序&#xff0c;输入n个整数&#xff08;n从键盘输入&#xff0c;n>0&#xff0c;整数取值范围&#xff1a;0~1000&#xff09;&#xff0c;输出这n个 数当中的偶数和。 任务要求&#xff1a; 代码示例&#xff1a; package M0317_0331;import…
阅读更多...
金三银四面试题（七）：JVM常见面试题(1)

金三银四面试题（七）：JVM常见面试题(1)

JVM会有许多零碎但是却很高频的基础考题。牢记这些&#xff0c;才能保证不在面试中落后于人。 说说对象分配规则 这也是之前面试腾讯时候被问到的问题&#xff1a;请介绍JVM如何分配对象&#xff1f; 对象优先分配在Eden 区&#xff0c;如果Eden 区没有足够的空间时&#xf…
阅读更多...
软件测试基础理论、测试用例及设计方法、易混淆概念总结【软件测试】

软件测试基础理论、测试用例及设计方法、易混淆概念总结【软件测试】

一.软件测试基础理论 1.软件定义 软件是计算机系统中与硬件相互依存的一部分&#xff0c;包括程序、数据以及与其相关文档 的完整集合。 程序是按事先设计的功能和性能要求执行的指令序列&#xff1b; 数据是使程序能正常操作信息的数据结构&#xff1b; 文档是与程序开发、维…
阅读更多...
TR2 - Transformer模型的复现

TR2 - Transformer模型的复现

目录 理论知识模型结构结构分解黑盒两大模块块级结构编码器的组成解码器的组成 模型实现多头自注意力块前馈网络块位置编码编码器解码器组合模型最后附上引用部分 模型效果总结与心得体会 理论知识 Transformer是可以用于Seq2Seq任务的一种模型&#xff0c;和Seq2Seq不冲突。 …
阅读更多...
开源免费软件推荐PhotoPrism：一款基于TensorFlow的开源照片管理工具，实现自动图像分类与本地化部署

开源免费软件推荐PhotoPrism：一款基于TensorFlow的开源照片管理工具，实现自动图像分类与本地化部署

引言&#xff1a; PhotoPrism&#xff0c;这款基于机器学习软件Google TensorFlow的开源照片管理工具&#xff0c;不仅实现了自动图像分类&#xff0c;更能够精准检测图片的颜色、色度、亮度、质量等属性。无论是全景照片还是地理位置信息&#xff0c;它都能轻松识别。更重要的…
阅读更多...
k8s-jenkins安装与流水线

k8s-jenkins安装与流水线

k8s-jenkins安装与流水线 一、环境安装1.创建目录2.后台启动服务3.浏览器访问4.修改密码 二、流水线1.新建流水线任务2.运行流水线3.安装插件4.安装Kubernetes CLI 三、总结 一、环境安装 如果使用的是阿里云Kubernetes集群 &#xff0c;可以安装其 ack-jenkins应用。 5分钟在…
阅读更多...
KVM：尝试安装windows2008

KVM：尝试安装windows2008

最终目的是在lxd部署windows2008镜像 WindowsServer2008镜像&#xff1a; cn_windows_server_2008_r2_standard_enterprise_datacenter_and_web_with_sp1_x64_dvd_617598.iso 镜像参考链接&#xff1a; https://discussion.scottibyte.com/t/migrate-a-hyper-v-windows-vir…
阅读更多...
on-my-zsh 命令自动补全插件 zsh-autosuggestions 安装和配置

on-my-zsh 命令自动补全插件 zsh-autosuggestions 安装和配置

首先 Oh My Zsh 是什么? Oh My Zsh 是一款社区驱动的命令行工具&#xff0c;正如它的主页上说的&#xff0c;Oh My Zsh 是一种生活方式。它基于 zsh 命令行&#xff0c;提供了主题配置&#xff0c;插件机制&#xff0c;已经内置的便捷操作。给我们一种全新的方式使用命令行。…
阅读更多...
【unity】unity安装及路线图

【unity】unity安装及路线图

学习路线图 二、有关unity的下载 由于unity公司是在国外&#xff0c;所以.com版&#xff08;https://developer.unity.cn/&#xff09;不一定稳定&#xff0c;学习时推荐从.cn国内版&#xff08;https://developer.unity.cn/&#xff09;前往下载&#xff0c;但是后期仍需回…
阅读更多...
【全套源码教程】基于SpringBoot+MyBatis框架的智慧生活商城系统的设计与实现

【全套源码教程】基于SpringBoot+MyBatis框架的智慧生活商城系统的设计与实现

目录 前言 需求分析 可行性分析 技术实现 后端框架&#xff1a;Spring Boot 持久层框架&#xff1a;MyBatis 前端框架&#xff1a;Vue.js 数据库&#xff1a;MySQL 功能介绍 前台功能拓展 商品详情单管理 个人中心 秒杀活动 推荐系统 评论与评分系统 后台功能拓…
阅读更多...
桌面/WEB端3D开发工具HOOPS SDK简介

桌面/WEB端3D开发工具HOOPS SDK简介

Tech Soft 3D在长达25年的时间内&#xff0c;一直通过卓越的3D技术帮助全球超过600家客户推动创新&#xff0c;这些客户包括HEXAGON、SolidWorks、SIEMENS、Aras、ANSYS、AVEVA等各个行业的领军者。 Tech Soft 3D旗下拥有4款原生产品&#xff0c;分别是&#xff1a;HOOPS Excha…
阅读更多...
docker-compose mysql

docker-compose mysql

使用docker-compose 部署 MySQL&#xff08;所有版本通用&#xff09; 一、拉取MySQL镜像 我这里使用的是MySQL8.0.18&#xff0c;可以自行选择需要的版本。 docker pull mysql:8.0.18二、创建挂载目录 mkdir -p /data/mysql8/log mkdir -p /data/mysql8/data mkdir -p /dat…
阅读更多...
浏览器工作原理与实践--块级作用域：var缺陷以及为什么要引入let和const

浏览器工作原理与实践--块级作用域：var缺陷以及为什么要引入let和const

在前面《07 | 变量提升&#xff1a;JavaScript代码是按顺序执行的吗&#xff1f;》这篇文章中&#xff0c;我们已经讲解了JavaScript中变量提升的相关内容&#xff0c;正是由于JavaScript存在变量提升这种特性&#xff0c;从而导致了很多与直觉不符的代码&#xff0c;这也是Jav…
阅读更多...
【YOLOv5改进系列(8)】高效涨点----添加yolov7中Aux head 辅助训练头

【YOLOv5改进系列(8)】高效涨点----添加yolov7中Aux head 辅助训练头

文章目录 &#x1f680;&#x1f680;&#x1f680;前言一、1️⃣ Auxiliary head辅助头简单介绍二、2️⃣从损失函数和标签分配分析三、3️⃣正负样本标签分配四、4️⃣如何添加Aux head辅助训练头五、5️⃣实验部分(后续添加&#xff0c;还是跑模型&#xff0c;辅助头真是太慢…
阅读更多...
Chrome 插件各模块使用 Fetch 进行接口请求

Chrome 插件各模块使用 Fetch 进行接口请求

Chrome 插件各模块使用 Fetch 进行接口请求 常规网页可以使用 fetch() 或 XMLHttpRequest API 从远程服务器发送和接收数据&#xff0c;但受到同源政策的限制。 内容脚本会代表已注入内容脚本的网页源发起请求&#xff0c;因此内容脚本也受同源政策的约束&#xff0c;插件的来…
阅读更多...
Arduino IDE导出esp8266工程编译后的bin文件

Arduino IDE导出esp8266工程编译后的bin文件

一、导出bin文件的方法一 1.通过IDE直接导出&#xff0c;选择 项目 --> 导出已编译的二进制文件&#xff0c;会在工程下生成 build 文件夹&#xff0c;里面有导出的bin文件。 一、导出bin文件的方法二 通过临时文件&#xff0c;找到生成的bin文件。 临时文件的位置&#…
阅读更多...
MES系统怎么解决车间生产调度难的问题？

MES系统怎么解决车间生产调度难的问题？

MES系统三个层次 1、MES决定了生产什么&#xff0c;何时生产&#xff0c;也就是说它使公司保证按照订单规定日期交付准确的产品&#xff1b; 2、MES决定谁通过什么方式&#xff08;流程&#xff09;生产&#xff0c;即通过优化资源配置&#xff0c;最有效运用资源&#xff1b; …
阅读更多...
1500㎡全新展厅升级 无锡冠珠瓷砖旗舰店举行盛大开业典礼

1500㎡全新展厅升级 无锡冠珠瓷砖旗舰店举行盛大开业典礼

3月23日&#xff0c;无锡冠珠旗舰店重装升级&#xff0c;举行盛大的开业典礼&#xff01;截止到当天18时&#xff0c;本次开业活动共计成交近300单&#xff0c;收款超300万。新明珠集团董事兼常务副总裁梁旺娟、新明珠集团副总裁兼营销管理中心总经理邓勇、新明珠集团副总经理兼…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023