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

最新推荐文章于 2023-07-12 09:28:48 发布
最新推荐文章于 2023-07-12 09:28:48 发布
阅读量673 收藏
点赞数 1
分类专栏： Spring-WEB Spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u010979642/article/details/106261040
版权

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: 8081
  endpoints:
    web:
      # 修改访问路径，2.0之前默认是/，2.0默认是/actuator
      base-path: /monitor
      # 开放所有页面节点 ，默认只开启了health、info两个节点
      exposure:
        include: "*"
  endpoint:
    health:
      # 显示健康具体信息，默认不会显示详细信息
      show-details: always

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

 

自定义api的访问路径

management:
  endpoints:
    web:
      path-mapping:
        health: /sys-health
        info: /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 {
    @Override
    protected 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);
    }

    @ReadOperation
    public 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错误
     */
    @ReadOperation
    public 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

Jaemon
关注
专栏目录
SpringBoot实战教程-监控管理
鸟哥哥的专栏
07-05 775
Actuator是spring boot的一个附加功能，能够对应用自身进行监控，以及查看应用的配置等。可帮助我们在应用程序生产环境时监视和管理应用程序。
SpringBoot2.0-Actuator监控参数说明 - 最全文档.docx
07-09
在springboot2.0中如何使用prometheus插件，及对springboor2.0-actuator包的介绍，以及如何扩展promehtues里的监控指标。
Spring Boot2.0之 监控管理
art_code的博客
10-20 296
Spring Boot2.0之 监控管理 Spring boot监控中心： 针对微服务的服务状态，服务器的内存变化（内存、线程、日志管理等）检测服务配置连接地址是否有用(有些懒加载的情况下，用的时候发现卧槽不能用)模拟访问，懒加载。统计有多少个bean（Spring 容器中的bean）、统计Spring MVC 中@RequestMapping（统计接口数） Actuator监控应用（无界...
Spring Boot 2.0官方文档之 Actuator
wessiyear的博客
07-13 895
业务需要，随来学习springboot的actuator，以下是看到的几篇好的博文，多谢分享。先记录好的博文内容，后面会继续完善自己的博客。https://blog.csdn.net/alinyua/article/details/80009435官方文档：https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/...
SpringBoot2.0中的监控
tom和cat的博客
11-06 234
Spring Boot 2.0官方文档之 Actuator https://blog.csdn.net/alinyua/article/details/80009435 SpringBoot2.x中的应用监控：Actuator+Prometheus+Grafana https://blog.csdn.net/MyHerux/article/details/80667524 SpringBo...
SpringBoot2.0+Vue3.0前后端分离wiki文件管理系统源码.zip
05-23
此外，测试也是项目开发中的重要环节，可以利用JUnit和Mockito进行单元测试，SpringBoot的Actuator模块则提供了健康检查和监控功能。 总结来说，"SpringBoot2.0+Vue3.0前后端分离wiki文件管理系统源码"是一个综合性...
SpringBoot2.0+mybatis3.0+redis+lombok
03-01
在SpringBoot 2.0中，引入了一些新特性，例如对Java 9的支持、Spring Framework 5.0的集成、WebFlux非阻塞式Web开发的支持以及改进的Actuator监控和健康检查功能。 **MyBatis 3.0** MyBatis是一个优秀的持久层框架...
SpringBoot2.0-Actuator监控参数说明
07-10
SpringBoot2.0-Actuator是Spring Boot框架中的一个强大组件，主要负责提供应用程序的监控和管理能力。在Spring Boot应用中，Actuator通过暴露一系列的端点（endpoints），使得开发者可以方便地查看和操作应用程序的...
springboot2.0
07-30
4. **Actuator**：提供健康检查、审计、指标、日志和端点监控等功能，帮助开发者了解应用的运行状态。 5. **YAML/Properties 配置**：支持 YAML 或 Properties 文件进行配置，增强了配置的可读性和灵活性。 **...
基于springboot的中医健康管理系统
m0_67392811的博客
04-28 4201
中医健康管理系统 介绍 中医健康管理系统是基于springboot开发的一个系统，包含用户信息管理、体检菜单、健康诊断、统计分析和医患沟通等功能。 系统有三个角色 管理员：管理用户（医患账号都由管理员添加）和诊疗记录、体检清单、留言板、健康诊断等功能管理 医生：添加诊疗记录、确认体检记录、和患者沟通、进行健康诊断等功能 病患：查看自己的诊疗记录、发起体检、已医生沟通、进行健康诊断等功能 功能介绍 管理员 1、统计分析 包含如下口径的统计 2、系统管理 用户管理 管理维护医生和病患信息
SpringBoot2.0（十七）：Actuator:健康检查、审计、统计和监控
小飞技术
07-12 401
文章目录定时任务： 定时任务： 创建定时器
springboot+mysql健康与营养管理信息系统-计算机毕业设计源码46923
最新发布
vx1_Biye_Design的博客
07-12 158
修改密码：管理员可以随时修改自己进入系统的登录密码，以保证系统的安全性。 用户管理：对注册的用户信息进行维护管理等。 营养师信息管理：对营养师信息进行维护，添加、删除、修改信息。 公告信息管理：对系统公告信息进行发布。 营养方案管理：对营养方案进行管理。 评价管理：对用户的评价信息进行管理。 健身视频管理：对健身视频有增删改查权限。 系统管理，模块管理等。
springboot+vue健康管理小项目（四）完成登录和重置
qq_42321069的博客
04-05 276
完成登录和重置 一、 login登录校验 添加校验属性 编写校验规则 校验标签进行绑定 login.vue <template> <div class="login_container"> <!--登录块--> <div class="login_box"> <!--头像--> <div class="avatar_box"> <img src="../assets/
sheng的学习笔记-Actuator健康监控
coldstarry的专栏
03-06 553
springcloud actuator
springboot 配置文件中属性变量引用方式@@解析
tianqiuhao的博客
03-01 1315
spring配置文件中的“@@”表达式出问题了怎么办？为什么要用“@@”表达式
Spring-boot 添加自定义健康检测 /actuator/health
killgodaa的专栏
03-16 2495
spring健康检测体系，通过请求/actuator/health,返回程序的健康指标，也可以自定义健康检测指标
MemoryMXBean
liuwei_csd的专栏
12-25 1795
  本文来源：jdk1.6中文文档 java.lang.management 接口 MemoryMXBean public interface MemoryMXBean Java 虚拟机内存系统的管理接口。 Java 虚拟机具有此接口的实现类的单一实例。实现此接口的实例是一个 MXBean ，可以通过调用 ManagementFactory.g...
批量修改pom.xml 中project.name的方法
中国资深步行专家 CSDNBLog
09-01 4158
## POM.xml中的项目。名需要带上路径名称最后加上project.artifactId pom.xml的名字属性都是存在，只是内容不合适，首先想到的是用python来写个脚本，但是感觉还是太麻烦，写下了如下shell脚本，但是出现异常 $ find . -type f -name 'pom.xml' -exec sed -i -e 's/&amp;lt;name&amp;gt;.*&amp;lt;\/nam...
SpringBoot2.0-Actuator与Prometheus监控集成指南
SpringBoot 2.0引入了Actuator模块，它为应用程序提供了健康检查、性能监控和管理等强大的功能。Actuator的目的是帮助开发者更好地了解和控制他们的生产环境中的应用。在2.0.2.RELEASE版本中，通过引入`spring-boot-...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Jaemon

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值