使用Actuator通过HTTP监控Spring Boot应用(附源码)

本文涉及的产品
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云数据库 RDS MySQL,集群系列 2核4GB
推荐场景:
搭建个人博客
云数据库 RDS MySQL,高可用系列 2核4GB
简介: 使用Actuator通过HTTP监控Spring Boot应用(附源码)

Spring Boot提供了Actuator功能,完成运行时的应用监控和管理功能。可以通过HTTP,JMX(Java管理扩展)以及SSH(远程脚本)来进行Spring Boot的应用监控和管理功能。

通过HTTP使用Actuator的监控和管理功能,那么要在pom.xml文件中引入以下依赖

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

一、端点的分类与测试

Spring  Boot提供了许多监控和管理功能的端点。根据端点的作用,可以将Spring Boot提供 的原生端点分为三大类。应用配置端点、度量指标端点、操作控制端点

1:端点的开启与暴露

新建一个Spring Boot Web应用 运行主程序 然后通过访问http://localhost:8080/acutator来查看默认暴露的端点

发现Spring Boot默认暴露了health和info两个端点

在配置文件application.properties中添加以下代码可以查看所有暴露的端点

management.endpoints.web.exposure.include=*

二、应用配置端点的测试

1:conditions

用于获取应用的自动化配置报告,其中包括所有自动化配置的候选项,同时还列出了每个候选项自动化配置的各个先决条件是否满足

访问http://localhost:8080/acutator/conditions即可测试

2:beans

该端点用来获取应用上下文中创建的所有Bean,启动并暴露该端点后。可通过http://localhost:8080/beans访问

3:configprops

该端点用来获取应用中配置的属性信息报告,prefix属性代表属性的配置前缀,properties代表各个属性的名称和值 通过http://localhost:8080/acutator/configprops测试访问

4:env

该端点用于获取应用所有可用的环境属性报告。

通过http://localhost:8080/acutato/env访问

5:mappings

该端点用来返回所有Spring MVC的控制器映射关系报告 可通过

http://localhost:8080/acutator/mappings访问

6:info

该端点用来返回一些自定义的信息,在默认情况下,该端点只会返回一个空的json内容

通过http://localhost:8080/acutator/info测试访问

三、度量指标端点的测试

通过度量指标端点可获取应用程序运行过程中用于监控的度量指标

1:metrics

该端点用来返回当前应用的各类重要度量指标

通过http://localhost:8080/acutator/metrics访问

2:health

该端点哦你过来获取应用的各类健康指标信息。通过

http://localhost:8080/acutator/health访问 up表示健康 down表示异常

3:threaddump

该端点用来暴露程序运行中的线程信息。 通过

http://localhost:8080/acutator/threaddump测试访问

4:httptrace

该端点用来返回基本的HTTP跟踪信息。可通过

http://localhost:8080/acutator/httptrace访问 保留最近的100条请求信息

5:scheduledtasks

该端点统计应用程序中调度的任务 可通过

http://localhost:8080/acutator/scheduledtasks访问测试

四、操作控制端点的测试

操作控制类端点拥有更强大的控制能力,如果使用它们,需要通过属性来配置开启,在原生端点中,只提供了一个用来关闭应用的端点:shutdown 可以通过如下配置开启它

management.endpoint.shutdown.enabled=true

五、自定义端点

当Spring Boot提供的端点不能满足我们的需求时,就需要自定义 一个端点对应用进行监控

Spring Boot提供了注解@Endpoint定义一个端点类,并在端点类的方法上使用@ReadOperation注解来显示监控信息,使用@WriteOperation来动态更新监控信息

下面通过实战讲解如何自定义一个端点,并且显示数据源相关信息

1:创建Spring Boot Web应用

2:修改pom.xml

<?xml version="1.0" encoding="UTF-8"?>
-<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0">
<modelVersion>4.0.0</modelVersion>
-<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.8.RELEASE</version>
<relativePath/>
<!-- lookup parent from repository -->
</parent>
<groupId>com.ch</groupId>
<artifactId>ch10_2</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>ch10_2</name>
<description>Demo project for Spring Boot</description>
-<properties>
<java.version>11</java.version>
</properties>
-<dependencies>
-<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
-<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
-<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.45</version>
</dependency>
-<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
-<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
-<build>
-<plugins>
-<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>

3:配置数据源

修改application.properties文件

###
##数据源信息配置
###
#数据库地址
spring.datasource.url=jdbc:mysql://localhost:3306/springbootjpa?characterEncoding=utf8
#数据库用户名
spring.datasource.username=root
#数据库密码
spring.datasource.password=root
#数据库驱动
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
#输出的JSON字符串格式更美观
spring.jackson.serialization.indent-output=true
#暴露所有端点,当然包括data-source,我们也可以只暴露data-source端点
management.endpoints.web.exposure.include=*
#将详细健康信息显示给所有用户
management.endpoint.health.show-details=always

4:自定义端点

package com.ch.ch10_2.endPoint;
import java.util.HashMap;
import java.util.Map;
import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.boot.actuate.endpoint.annotation.WriteOperation;
import org.springframework.stereotype.Component;
import com.zaxxer.hikari.HikariConfigMXBean;
import com.zaxxer.hikari.HikariDataSource;
import com.zaxxer.hikari.HikariPoolMXBean;
//注册为端点,id不能使用驼峰法(dataSource),需要以-分割
@Endpoint(id = "data-source")
@Component
public class DataSourceEndpoint {
  //HikariDataSource提供多个监控信息
  HikariDataSource ds;
    public DataSourceEndpoint(HikariDataSource ds) {
      this.ds = ds;
    }
    @ReadOperation
    public Map<String, Object> info() {
      Map<String, Object> map = new HashMap<String, Object>();
      //连接池配置
      HikariConfigMXBean configBean = ds.getHikariConfigMXBean();
      map.put("max", configBean.getMaximumPoolSize());
      //连接池运行状态
      HikariPoolMXBean mxBean = ds.getHikariPoolMXBean();
      map.put("active", mxBean.getActiveConnections());
      map.put("idle", mxBean.getIdleConnections());
      //连接池无连接时,等待获取连接的线程个数
      map.put("wait", mxBean.getThreadsAwaitingConnection());
        return map;
    }
    @WriteOperation
    public void setMax(int max) {
      ds.getHikariConfigMXBean().setMaximumPoolSize(max);
    }
}

5:暴露端点

在application.properties中添加以下代码

management.endpoints.web.exposure.include=*

6:测试端点

运行主类 然后访问http://localhost:8080/actuator/date-source即可

相关实践学习
如何快速连接云数据库RDS MySQL
本场景介绍如何通过阿里云数据管理服务DMS快速连接云数据库RDS MySQL,然后进行数据表的CRUD操作。
全面了解阿里云能为你做什么
阿里云在全球各地部署高效节能的绿色数据中心,利用清洁计算为万物互联的新世界提供源源不断的能源动力,目前开服的区域包括中国(华北、华东、华南、香港)、新加坡、美国(美东、美西)、欧洲、中东、澳大利亚、日本。目前阿里云的产品涵盖弹性计算、数据库、存储与CDN、分析与搜索、云通信、网络、管理与监控、应用服务、互联网中间件、移动服务、视频服务等。通过本课程,来了解阿里云能够为你的业务带来哪些帮助 &nbsp; &nbsp; 相关的阿里云产品:云服务器ECS 云服务器 ECS(Elastic Compute Service)是一种弹性可伸缩的计算服务,助您降低 IT 成本,提升运维效率,使您更专注于核心业务创新。产品详情: https://www.aliyun.com/product/ecs
相关文章
|
3月前
|
监控 Java 应用服务中间件
高级java面试---spring.factories文件的解析源码API机制
【11月更文挑战第20天】Spring Boot是一个用于快速构建基于Spring框架的应用程序的开源框架。它通过自动配置、起步依赖和内嵌服务器等特性,极大地简化了Spring应用的开发和部署过程。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,特别是spring.factories文件的解析源码API机制。
133 2
|
3月前
|
JSON Java Apache
非常实用的Http应用框架,杜绝Java Http 接口对接繁琐编程
UniHttp 是一个声明式的 HTTP 接口对接框架,帮助开发者快速对接第三方 HTTP 接口。通过 @HttpApi 注解定义接口,使用 @GetHttpInterface 和 @PostHttpInterface 等注解配置请求方法和参数。支持自定义代理逻辑、全局请求参数、错误处理和连接池配置,提高代码的内聚性和可读性。
268 3
|
26天前
|
监控 运维
HTTPS 证书自动化运维:https证书管理系统- 自动化监控
本文介绍如何设置和查看域名或证书监控。步骤1:根据证书状态选择新增域名或证书监控,线上部署推荐域名监控,未部署选择证书监控。步骤2:查询监控记录详情。步骤3:在详情页查看每日定时检测结果或手动测试。
HTTPS 证书自动化运维:https证书管理系统- 自动化监控
|
1月前
|
监控 JavaScript 数据可视化
建筑施工一体化信息管理平台源码,支持微服务架构,采用Java、Spring Cloud、Vue等技术开发。
智慧工地云平台是专为建筑施工领域打造的一体化信息管理平台,利用大数据、云计算、物联网等技术,实现施工区域各系统数据汇总与可视化管理。平台涵盖人员、设备、物料、环境等关键因素的实时监控与数据分析,提供远程指挥、决策支持等功能,提升工作效率,促进产业信息化发展。系统由PC端、APP移动端及项目、监管、数据屏三大平台组成,支持微服务架构,采用Java、Spring Cloud、Vue等技术开发。
|
2月前
|
存储 缓存 Java
Spring面试必问:手写Spring IoC 循环依赖底层源码剖析
在Spring框架中,IoC(Inversion of Control,控制反转)是一个核心概念,它允许容器管理对象的生命周期和依赖关系。然而,在实际应用中,我们可能会遇到对象间的循环依赖问题。本文将深入探讨Spring如何解决IoC中的循环依赖问题,并通过手写源码的方式,让你对其底层原理有一个全新的认识。
74 2
|
2月前
|
Prometheus 监控 Java
如何全面监控所有的 Spring Boot 微服务
如何全面监控所有的 Spring Boot 微服务
131 3
|
3月前
|
前端开发 UED 开发者
CSS Sprites和图标字体在网页图标加载优化中的应用。CSS Sprites通过合并多图标减少HTTP请求,提升加载速度
本文探讨了CSS Sprites和图标字体在网页图标加载优化中的应用。CSS Sprites通过合并多图标减少HTTP请求,提升加载速度;图标字体则以字体形式呈现图标,便于调整样式。文章分析了两者的优缺点及应用场景,并提供了应用技巧和注意事项,旨在帮助开发者提升页面性能,改善用户体验。
48 5
|
3月前
|
监控 安全 Java
Spring Boot 中的 Actuator 是什么?
Spring Boot 中的 Actuator 是什么?
599 6
|
3月前
|
缓存 安全 网络安全
HTTP/2与HTTPS在Web加速中的应用
HTTP/2与HTTPS在Web加速中的应用
118 11
|
3月前
|
安全 Java 测试技术
如何在 Spring Boot 中禁用 Actuator 端点安全?
如何在 Spring Boot 中禁用 Actuator 端点安全?
327 1