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。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
流媒体平台/视频监控/安防视频汇聚EasyCVR播放暂停后视频画面黑屏是什么原因？

流媒体平台/视频监控/安防视频汇聚EasyCVR播放暂停后视频画面黑屏是什么原因？

视频智能分析/视频监控/安防监控综合管理系统EasyCVR视频汇聚融合平台，是TSINGSEE青犀视频垂直深耕音视频流媒体技术、AI智能技术领域的杰出成果。该平台以其强大的视频处理、汇聚与融合能力，在构建全栈视频监控系统中展现出了独特的优势。视频监控管理系统EasyCVR平台内置了强大的视频解码、转码、压缩等技术，能够处理多种视频流格式，并以多种格式（RTMP、RTSP、HTTP-FLV、WebS
阅读更多...
中文分词jieba库的使用与实景应用（一）

中文分词jieba库的使用与实景应用（一）

知识星球：https://articles.zsxq.com/id_fxvgc803qmr2.html 目录 一.定义： 精确模式（默认模式）： 全模式： 搜索引擎模式： paddle 模式（基于深度学习的分词模式）： 二 自定义词典 三.文本解析   调整词出现的频率 四. 关键词提取 A. 基于TF-IDF算法的关键词提取 B. 基于TextRank算法的关键词提取
阅读更多...
水位雨量在线监测系统概述及应用介绍

水位雨量在线监测系统概述及应用介绍

在当今社会，随着科技的飞速发展，各种智能监测系统已成为保障公共安全、促进资源管理和环境保护的重要工具。其中，水位雨量在线监测系统作为自然灾害预警、水资源管理及水利工程运行的关键技术，其重要性不言而喻。 一、水位雨量在线监测系统的基本原理 水位雨量在线监测系统主要由数据采集单元、数据传输网络、数据处理中心及用户终端四大部分构成，形成了一个完整的闭环系统。 数据采集单元：这是系统的“眼睛”，
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2