SpringBoot 2.0 + Actuator 应用健康监控管理

2024-05-26 19:38
文章标签 java springboot 应用 spring 管理 监控 健康 2.0 actuator

本文主要是介绍SpringBoot 2.0 + Actuator 应用健康监控管理，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

springboot的Actuator提供了运行状态监控的功能，可以通过REST、远程Shell和JMX方式来查看。

 

引入Actuator

添加jar包依赖

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

添加配置信息

# 访问： localhost:8081/monitor/{name}
management:# actuator端口server:port: 8081endpoints:web:# 修改访问路径，2.0之前默认是/，2.0默认是/actuatorbase-path: /monitor# 开放所有页面节点 ，默认只开启了health、info两个节点exposure:include: "*"endpoint:health:# 显示健康具体信息，默认不会显示详细信息show-details: always

访问： http://localhost:8081/monitor 获取所有的健康监控接口地址

 

自定义api的访问路径

management:endpoints:web:path-mapping:health: /sys-healthinfo: /sys-info

 

自定义info接口信息

info:name:'@project.name@'encoding:'@project.build.sourceEncoding@'description:'@project.description@'version:'@java.version@'

访问： http://localhost:8310/actuator/info

pom文件中需添加如下依赖， 否则application.yaml使用**@XXX@**是无法获取pom中变量值的

<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-resources-plugin</artifactId><version>2.6</version><configuration><delimiters><delimiter>@</delimiter></delimiters><useDefaultDelimiters>false</useDefaultDelimiters></configuration></plugin></plugins>
</build>

 

自定义端点

自定义健康监测的端点

在原来内置的端点进行添加，访问的路径还是内置的路径

// 这里的name 就是默认健康节点的名称了
@Component("jaemon")
public class CustomHealthIndicator extends AbstractHealthIndicator {@Overrideprotected void doHealthCheck(Health.Builder builder) throws Exception {builder// 设置健康信息.withDetail("name", "jaemon").withDetail("version", "1.0.0").up().build();}
}

访问： http://localhost:8310/actuator/health

自定义健康端点方式

  • 继承AbstractHealthIndicator类
  • 实现 HealthIndicator接口

自定义全新端点

@Endpoint(id = "custom-endpoint")
@Configuration
public class CustomEndpoint {/** 计算单位换算类型 */private static final Map<String, Long> UNIT_TYPE = Maps.newHashMap();static {UNIT_TYPE.put("K", 1024L);UNIT_TYPE.put("M", 1024 * 1024L);UNIT_TYPE.put("G", 1024 * 1024 * 1024L);}@ReadOperationpublic Map<String, Object> endpoint() {Map<String, Object> map = Maps.newHashMap();MemoryMXBean memorymbean = ManagementFactory.getMemoryMXBean();map.put("堆内存", memorymbean.getHeapMemoryUsage());map.put("方法区内存", memorymbean.getNonHeapMemoryUsage());List<String> inputArgs = ManagementFactory.getRuntimeMXBean().getInputArguments();map.put("运行时设置的JVM参数", inputArgs);// 总的内存量long totle = Runtime.getRuntime().totalMemory();// 空闲的内存量long free = Runtime.getRuntime().freeMemory();// 最大的内存量long max = Runtime.getRuntime().maxMemory();Map<String, Long> params = ImmutableMap.of("totalMemory", totle,"freeMemory", free,"maxMemory", max);map.put("运行时内存情况", params);return map;}/*** @Selector 会将路径上的参数作为变量传递给操作方法** init约等于xms的值，max约等于xmx的值。used是已经被使用的内存大小，committed是当前可使用的内存大小（包括已使用的），committed >= used。committed不足时jvm向系统申请，若超过max则发生OutOfMemoryError错误*/@ReadOperationpublic Map<String, Object> select(@Selector String unitType) {long conversion = UNIT_TYPE.getOrDefault(unitType.toUpperCase(), 1L);Map<String, Object> map = Maps.newHashMap();// 堆内存MemoryMXBean memorymbean = ManagementFactory.getMemoryMXBean();// 方法区内存MemoryUsage heapMemoryUsage = memorymbean.getHeapMemoryUsage();long heapInit = heapMemoryUsage.getInit() / conversion;long heapCommitted = heapMemoryUsage.getCommitted() / conversion;long heapUsed = heapMemoryUsage.getUsed() / conversion;long heapMax = heapMemoryUsage.getMax() / conversion;Map<String, Long> heapMap = Maps.newHashMap();heapMap.put("init", heapInit);heapMap.put("committed", heapCommitted);heapMap.put("used", heapUsed);heapMap.put("max", heapMax);map.put("堆内存", heapMap);MemoryUsage nonHeapMemoryUsage = memorymbean.getNonHeapMemoryUsage();long noHeapInit = nonHeapMemoryUsage.getInit() / conversion;long noHeapCommitted = nonHeapMemoryUsage.getCommitted() / conversion;long noHeapUsed = nonHeapMemoryUsage.getUsed() / conversion;long noHeapMax = nonHeapMemoryUsage.getMax() / conversion;Map<String, Long> noHeapMap = Maps.newHashMap();noHeapMap.put("init", noHeapInit);noHeapMap.put("committed", noHeapCommitted);noHeapMap.put("used", noHeapUsed);noHeapMap.put("max", noHeapMax);map.put("方法区内存", noHeapMap);List<String> inputArgs = ManagementFactory.getRuntimeMXBean().getInputArguments();map.put("运行时设置的JVM参数", inputArgs);// 总的内存量long totle = Runtime.getRuntime().totalMemory();// 空闲的内存量long free = Runtime.getRuntime().freeMemory();// 最大的内存量long max = Runtime.getRuntime().maxMemory();Map<String, Long> params = ImmutableMap.of("totalMemory", totle / conversion,"freeMemory", free / conversion,"maxMemory", max / conversion);map.put("运行时内存情况", params);return map;}
}

访问地址：

http://localhost:8310/actuator/custom-endpoint

http://localhost:8310/actuator/custom-endpoint/{unitType}

注意

  • @EndPoint中的id不能使用驼峰法，需要以-分割
  • @Spring Boot会去扫描@EndPoint注解下的@ReadOperation, @WriteOperation, @DeleteOperation注解，分别对应生成Get/Post/Delete的Mapping。注解中有个produces参数，可以指定media type, 如：application/json等

 

metrics接口指标说明

JVM指标

参数参数说明是否监控监控手段重要度
jvm.memory.maxJVM最大内存
jvm.memory.committedJVM可用内存是展示并监控堆内存和Metaspace重要
jvm.memory.usedJVM已用内存是展示并监控堆内存和Metaspace重要
jvm.buffer.memory.usedJVM缓冲区已用内存
jvm.buffer.count当前缓冲区数
jvm.threads.daemonJVM守护线程数是显示在监控页面
jvm.threads.liveJVM当前活跃线程数是显示在监控页面；监控达到阈值时报警重要
jvm.threads.peakJVM峰值线程数是显示在监控页面
jvm.classes.loaded加载classes数
jvm.classes.unloaded未加载的classes数
jvm.gc.memory.allocatedGC时，年轻代分配的内存空间
jvm.gc.memory.promotedGC时，老年代分配的内存空间
jvm.gc.max.data.sizeGC时，老年代的最大内存空间
jvm.gc.live.data.sizeFullGC时，老年代的内存空间
jvm.gc.pauseGC耗时是显示在监控页面

TOMCAT指标

参数参数说明是否监控监控手段重要度
tomcat.sessions.createdtomcat已创建session数
tomcat.sessions.expiredtomcat已过期session数
tomcat.sessions.active.currenttomcat活跃session数
tomcat.sessions.active.maxtomcat最多活跃session数是显示在监控页面，超过阈值可报警或者进行动态扩容重要
tomcat.sessions.alive.max.secondtomcat最多活跃session数持续时间
tomcat.sessions.rejected超过session最大配置后，拒绝的session个数是显示在监控页面，方便分析问题
tomcat.global.error错误总数是显示在监控页面，方便分析问题
tomcat.global.sent发送的字节数
tomcat.global.request.maxrequest最长时间
tomcat.global.request全局request次数和时间
tomcat.global.received全局received次数和时间
tomcat.servlet.requestservlet的请求次数和时间
tomcat.servlet.errorservlet发生错误总数
tomcat.servlet.request.maxservlet请求最长时间
tomcat.threads.busytomcat繁忙线程是显示在监控页面，据此检查是否有线程夯住
tomcat.threads.currenttomcat当前线程数（包括守护线程）是显示在监控页面重要
tomcat.threads.config.maxtomcat配置的线程最大数是显示在监控页面重要
tomcat.cache.accesstomcat读取缓存次数
tomcat.cache.hittomcat缓存命中次数

CPU指标

参数参数说明是否监控监控手段重要度
system.cpu.countCPU数量
system.load.average.1mload average是超过阈值报警重要
system.cpu.usage系统CPU使用率
process.cpu.usage当前进程CPU使用率是超过阈值报警
http.server.requestshttp请求调用情况是显示10个请求量最大，耗时最长的URL；统计非200的请求量重要
process.uptime应用已运行时间是显示在监控页面
process.files.max允许最大句柄数是配合当前打开句柄数使用
process.start.time应用启动时间点是显示在监控页面
process.files.open当前打开句柄数是监控文件句柄使用率，超过阈值后报警重要

 

接口端点说明

ID描述
auditevents公开当前应用程序的审核事件信息。需要AuditEventRepository bean
beans显示应用程序中所有spring bean的完整列表
caches公开可用的缓存
conditions显示在配置和自动配置类上评估的条件，以及它们匹配或不匹配的原因
configprops显示所有@ConfigurationProperties的整理列表
env显示Spring的可配置环境中公开属性。 ConfigurableEnvironment
flyway显示已应用的所有Flyway数据库迁移。需要一个或多个Flyway beans
health显示应用程序运行状况信息
httptrace显示HTTP跟踪信息（默认情况下，最后100个HTTP请求-响应交换）。需要HttpTraceRepository bean
info显示任意应用程序信息
integrationgraph显示了Spring集成图。需要依赖于spring集成核心
loggers显示并修改应用程序中记录器的配置
liquibase显示已应用的任何Liquibase数据库迁移，至少需要一个 Liquibase bean
metrics显示当前应用程序的“指标”信息
mappings显示所有@RequestMapping路径的整理列表
scheduledtasks显示应用程序中的计划任务
sessions允许从支持Spring会话的会话存储中检索和删除用户会话。需要使用Spring Session对响应式Web应用程序的支持时不可用
shutdown允许应用程序正常关闭。默认情况下禁用
threaddump执行线程转储
# 开启或关闭指定接口端点： management.endpoint.<id>.enabled
management:endpoint:shutdown:enabled: true

开启后， 访问： http://localhost:8310/actuator/shutdown 进行关闭应用程序(POST请求)

如果您的应用程序是web应用程序（Spring MVC、Spring WebFlux或Jersey），则可以使用以下附加端点：

ID描述
heapdump返回hprof堆转储文件
jolokia通过HTTP公开jmxbean（当Jolokia位于类路径上时，WebFlux不可用）。需要依赖jolokia core
logfile返回日志文件的内容（如果logging.file.name日志或者logging.file.path属性已设置）。支持使用HTTP范围头来检索日志文件的部分内容
prometheus以Prometheus服务器可以擦除的格式公开度量。需要micrometer-registry-prometheus`依赖

 

Reference

  • Spring Boot Actuator: Production-ready Features
  • SpringBoot2.0 Actuator 监控参数说明

这篇关于SpringBoot 2.0 + Actuator 应用健康监控管理的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1005399。

相关文章

Java实现字节字符转bcd编码

Java实现字节字符转bcd编码

《Java实现字节字符转bcd编码》BCD是一种将十进制数字编码为二进制的表示方式,常用于数字显示和存储,本文将介绍如何在Java中实现字节字符转BCD码的过程,需要的小伙伴可以了解下... 目录前言BCD码是什么Java实现字节转bcd编码方法补充总结前言BCD码（Binary-Coded Decima
阅读更多...
SpringBoot全局域名替换的实现

SpringBoot全局域名替换的实现

《SpringBoot全局域名替换的实现》本文主要介绍了SpringBoot全局域名替换的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一... 目录 项目结构⚙️ 配置文件application.yml️ 配置类AppProperties.Ja
阅读更多...
Java使用Javassist动态生成HelloWorld类

Java使用Javassist动态生成HelloWorld类

《Java使用Javassist动态生成HelloWorld类》Javassist是一个非常强大的字节码操作和定义库,它允许开发者在运行时创建新的类或者修改现有的类,本文将简单介绍如何使用Javass... 目录1. Javassist简介2. 环境准备3. 动态生成HelloWorld类3.1 创建CtC
阅读更多...
JavaScript中的高级调试方法全攻略指南

JavaScript中的高级调试方法全攻略指南

《JavaScript中的高级调试方法全攻略指南》什么是高级JavaScript调试技巧,它比console.log有何优势,如何使用断点调试定位问题,通过本文,我们将深入解答这些问题,带您从理论到实... 目录观点与案例结合观点1观点2观点3观点4观点5高级调试技巧详解实战案例断点调试：定位变量错误性能分
阅读更多...
Java实现将HTML文件与字符串转换为图片

Java实现将HTML文件与字符串转换为图片

《Java实现将HTML文件与字符串转换为图片》在Java开发中,我们经常会遇到将HTML内容转换为图片的需求,本文小编就来和大家详细讲讲如何使用FreeSpire.DocforJava库来实现这一功... 目录前言核心实现：html 转图片完整代码场景 1：转换本地 HTML 文件为图片场景 2：转换 H
阅读更多...
Java使用jar命令配置服务器端口的完整指南

Java使用jar命令配置服务器端口的完整指南

《Java使用jar命令配置服务器端口的完整指南》本文将详细介绍如何使用java-jar命令启动应用,并重点讲解如何配置服务器端口,同时提供一个实用的Web工具来简化这一过程,希望对大家有所帮助... 目录1. Java Jar文件简介1.1 什么是Jar文件1.2 创建可执行Jar文件2. 使用java
阅读更多...
PHP应用中处理限流和API节流的最佳实践

PHP应用中处理限流和API节流的最佳实践

《PHP应用中处理限流和API节流的最佳实践》限流和API节流对于确保Web应用程序的可靠性、安全性和可扩展性至关重要,本文将详细介绍PHP应用中处理限流和API节流的最佳实践,下面就来和小编一起学习... 目录限流的重要性在 php 中实施限流的最佳实践使用集中式存储进行状态管理（如 Redis）采用滑动
阅读更多...
SpringBoot实现不同接口指定上传文件大小的具体步骤

SpringBoot实现不同接口指定上传文件大小的具体步骤

《SpringBoot实现不同接口指定上传文件大小的具体步骤》：本文主要介绍在SpringBoot中通过自定义注解、AOP拦截和配置文件实现不同接口上传文件大小限制的方法,强调需设置全局阈值远大于... 目录一  springboot实现不同接口指定文件大小1.1 思路说明1.2 工程启动说明二 具体实施2
阅读更多...
Java实现在Word文档中添加文本水印和图片水印的操作指南

Java实现在Word文档中添加文本水印和图片水印的操作指南

《Java实现在Word文档中添加文本水印和图片水印的操作指南》在当今数字时代,文档的自动化处理与安全防护变得尤为重要,无论是为了保护版权、推广品牌,还是为了在文档中加入特定的标识,为Word文档添加... 目录引言Spire.Doc for Java：高效Word文档处理的利器代码实战：使用Java为Wo
阅读更多...
SpringBoot日志级别与日志分组详解

SpringBoot日志级别与日志分组详解

《SpringBoot日志级别与日志分组详解》文章介绍了日志级别（ALL至OFF）及其作用,说明SpringBoot默认日志级别为INFO,可通过application.properties调整全局或... 目录日志级别1、级别内容2、调整日志级别调整默认日志级别调整指定类的日志级别项目开发过程中，利用日志
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2