Spring Boot Actuator实现应用监控

news/2024/5/19 0:21:48 标签: prometheus, spring boot

1、Spring Boot Actuator实现应用监控

前面的例子中，我们学习的都是 Prometheus 自身的内容，即监控的都是机器或者系统层面的指标。那么如果我

们需要对 Java 应用做监控，例如：监控 JVM 的信息，监控 Spring Bean 的信息。那我们应该怎么实现呢？

从这篇文章开始，我们就开始学习如何去监控 Java 应用的状态信息，并且最终实现自定义业务监控指标的监控。

1.1 Spring 监控机制

在学习如何监控 Java 应用之前，我们需要先了解下 SpringBoot 的监控机制。在 Spring 2.x 之前，SpringBoot 使

用 Actuator 模块进行监控，而在 Spring 2.x 之后，SpringBoot 使用了 Micrometer 进行监控。

Spring Boot Actuator 模块提供了生产级别的功能，比如健康检查，审计，指标收集，HTTP 跟踪等，帮助我们监

控和管理 Spring Boot 应用。这个模块是一个采集应用内部信息暴露给外部的模块，上述的功能都可以通过 HTTP

和 JMX 访问。

在 Spring 2.x 之后，Actuator 使用 Micrometer 与这些外部应用程序监视系统集成。这样一来，只需很少的配置

即可轻松集成外部的监控系统。

那什么是 Micrometer 呢？

Micrometer 为 Java 平台上的性能数据收集提供了一个通用的 API，应用程序只需要使用 Micrometer 的通用 API

来收集性能指标即可。Micrometer 会负责完成与不同监控系统的适配工作。这就使得切换监控系统变得很容易。

简单地说，actuator 是真正去采集数据的模块，而 Micrometer 更像是一个适配器，将 actuator 采集到的数据适

合给各种监控工具。

1.2 Spring Actuator 快速入门

接下来我们快速创建一个简单的项目，来让你明白 Spring Boot Actuator 能做什么。

我们到 Spring Initializr 创建一个名为 spring-web-actuator-demo 的项目，配置maven依赖：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.6.RELEASE</version>
        <relativePath/>
    </parent>

    <groupId>com.example</groupId>
    <artifactId>spring-web-actuator-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-web-actuator-demo</name>
    <description>Spring Actuator 快速入门</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>

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

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>2.4.5</version>
        </dependency>

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

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

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

启动文件：

package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SpringWebActuatorDemoApplication {

    public static void main(String[] args) {

        SpringApplication.run(SpringWebActuatorDemoApplication.class, args);
    }

}

打开项目后，直接运行 SpringWebActuatorDemoApplication.java 文件，正常情况下会使用 8080 端口作为服

务端口。

访问 localhost:8080/actuator/health 查看应用的健康状态，正常情况下会返回 UP 信息。

在这里插入图片描述

除了提供最基本的健康检查外，actuator 还提供了许多其他的端点（Endpoints）信息。通过这些端点信息，我们

可以掌握 99% 的应用状态信息。

1.3 端点暴露配置

不同于 Actuator 1.x，Actuator 2.x 的大多数端点默认被禁掉。所以在查看对应端点之前，我们需要做好配置，否

则我们是无法访问对应端点的。

我们可以通过以下配置，来配置通过 JMX 和 HTTP 暴露的端点。

属性默认值
management.endpoints.jmx.exposure.exclude
management.endpoints.jmx.exposure.include*
management.endpoints.web.exposure.exclude
management.endpoints.web.exposure.includeinfo, health

我们可以选择打开所有的监控点，例如：

# 配置
management.endpoints.web.exposure.include=*

也可以选择打开部分端点，例如下面的配置打开 beans 和 trace 两个端点。

management.endpoints.web.exposure.exclude=beans,trace

Actuator 默认所有的监控点路径都在 /actuator/*，当然如果有需要这个路径也支持定制。例如下面的配置将前

缀改成了 monitor，那么访问路径就变成了 /monitor/*。

management.endpoints.web.base-path=/monitor

这里我们在 application.properties 中加入如下配置，默认打开所有端点。

management.endpoints.web.exposure.include=*

接着我们访问地址：localhost:8080/actuator/metrics，可以看到所有的指标地址。

在这里插入图片描述

如果我们要查看 process.uptime 指标，那么我们只需要访问

localhost:8080/actuator/metrics/process.uptime，就可以看到具体的信息。

在这里插入图片描述

1.4 常用端点介绍

Spring Boot Actuator 提供了 Endpoints（端点）给外部来与应用程序进行访问和交互。

例如 /health 端点提供了关于应用健康情况的一些基础信息，/metrics 端点提供了一些有用的应用程序指标

（JVM 内存使用、系统 CPU 使用等）。

一般来说，端点可以分为几类：

  • 应用配置类：获取应用程序中加载的应用配置、环境变量、自动化配置报告等与 Spring Boot 应用密切相关的

    配置类信息。

  • 度量指标类：获取应用程序运行过程中用于监控的度量指标，比如：内存信息、线程池信息、HTTP 请求统计

    等。

  • 操作控制类：提供了对应用的关闭等操作类功能。详细的原生端点介绍，请以官网为准，这里就不赘述徒增篇

    幅。

1.4.1 health 端点

/health 端点会聚合你程序的健康指标，来检查程序的健康情况。端点公开的应用健康信息取决于参数

management.endpoint.health.show-details，该属性值可选项为：

属性值描述
never不展示详细信息，up 或者 down 的状态，默认配置
when-authorized详细信息将会展示给通过认证的用户。授权的角色可以通过 management.endpoint.health.roles 配置
always对所有用户暴露详细信息

接着在 application.properties 中增加如下参数，允许对所有用户暴露详细信息：

# 配置
management.endpoint.health.show-details=always

配置成 always 之后，启动应用，访问 localhost:8080/actuator/health 查看应用的健康状态，正常情况下

会返回 UP 信息。

在这里插入图片描述

在这里我们看到除了 status 状态之外，并没有其他信息。

这是因为我们应用中并没有其他依赖。当你的项目有依赖对应组件的时候，这些健康指示器就会被自动装配，继而

采集对应的信息。

现在我们在 pom.xml 文件中增加 redis 依赖：

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

先启动redis，最终我们再次访问地址：localhost:8080/actuator/health。从图中我们可以看到 redis 的信息

了。
在这里插入图片描述

我们也可以通过配置禁用某个组件的健康监测，例如下面的配置禁用了 mongodb 的组件健康监测。

management.health.mongo.enabled: false

或者我们可以禁用所有自动配置的健康指示器：

management.health.defaults.enabled: false

例如在application.properties文件中配置：

# 配置
management.health.redis.enabled=false

在这里插入图片描述

常见的指示器有下面这些：

名称描述
CassandraHealthIndicator检查Cassandra数据库是否已启动。
CouchbaseHealthIndicator检查Couchbase群集是否启动。
DiskSpaceHealthIndicator检查磁盘空间是否不足。
DataSourceHealthIndicator检查是否可以获取到DataSource的连接。
ElasticsearchHealthIndicator检查Elasticsearch群集是否启动。
InfluxDbHealthIndicator检查InfluxDB服务器是否启动。
JmsHealthIndicator检查JMS代理是否启动。
MailHealthIndicator检查邮件服务器是否启动。
MongoHealthIndicator检查Mongo数据库是否已启动。
Neo4jHealthIndicator检查Neo4j服务器是否启动。
RabbitHealthIndicator检查Rabbit服务器是否启动。
RedisHealthIndicator检查Redis服务器是否启动。
SolrHealthIndicator检查Solr服务器是否启动。

除了使用自动引入的健康指示器之外，我们也可以自定义一个 Health Indicator，只需要实现 HealthIndicator 接

口或者继承 AbstractHealthIndicator 类。

例如下面我们创建了一个 CustomHealthIndicator 类，继承了 AbstractHealthIndicator 类，并返回了一些健康信

息。

package com.example;

import org.springframework.boot.actuate.health.AbstractHealthIndicator;
import org.springframework.boot.actuate.health.Health;
import org.springframework.stereotype.Component;

/**
 * @author zhangshixing
 * @date 2022年03月16日 12:30
 */
@Component
public class CustomHealthIndicator extends AbstractHealthIndicator {
    @Override
    protected void doHealthCheck(Health.Builder builder) throws Exception {
        // 使用 builder 来创建健康状态信息
        // 如果你throw 了一个 exception，那么status 就会被置为DOWN，异常信息会被记录下来
        builder.up()
                .withDetail("app", "向你报告：项目很健康哦！")
                .withDetail("error", "向你报告：项目有点问题哦！");
    }
}

我们重启应用并访问地址：localhost:8080/actuator/health，我们可以看到自定义的健康信息。

在这里插入图片描述

1.4.2 metrics 端点

/metrics 端点用来返回当前应用的各类重要度量指标，比如：内存信息、线程信息、垃圾回收信息、tomcat、

数据库连接池等。当我们访问：localhost:8080/actuator/metrics 时，会返回 SpringBoot Actuator 的所有

可查看端点信息。

在这里插入图片描述

我们可以进一步使用如下格式的 URL 访问到对应的信息：

http://localhost:8080/actuator/metrics/{MetricName}

例如我想访问 system.cpu.count 这个指标，那么我访问这个链接即可：

localhost:8080/actuator/metrics/system.cpu.count，返回值为：

在这里插入图片描述

1.4.3 loggers 端点

/loggers 端点暴露了我们程序内部配置的所有 logger 的信息，我们访问这个链接就可以看到：

localhost:8080/actuator/loggers。

在这里插入图片描述

我们也可以通过下述方式访问某一个 logger

http://localhost:8080/actuator/loggers/{name}

例如我想访问 Root Logger，就可以访问这个链接：localhost:8080/actuator/loggers/ROOT，返回信息

如下：
在这里插入图片描述

1.4.4 info 端点

/info 端点可以用来查看配置文件 application.properties 中 info 节点下的配置信息，默认情况下

application.properties 中并没有 info 节点配置，所以当我们访问 localhost:8080/actuator/info 时

会访问空 JSON 串。

接下来我们在 application.properties 中增加了如下配置：

# 配置
info.app.name=actuator-test-demo
info.app.encoding=UTF-8
info.app.java.source=1.8
info.app.java.target=1.8

再次访问localhost:8080/actuator/info 会返回 info 节点的信息：

在这里插入图片描述

同时我们还可以这么配置 info 端点，而不是硬编码这些值，我们就可以按照如下所示的配置：

# 配置
info.app.encoding=@project.build.sourceEncoding@
info.app.java.source=@java.version@
info.app.java.target=@java.version@

在这里插入图片描述

要注意，info 端点只会返回 info 节点下的信息，而不会返回其他节点下的信息。例如我在配置文件中添加如下配

置：

student.name=ronald

这时候通过 info 端点是访问不到该配置信息的。

1.4.5 beans 端点

/beans 端点会返回 Spring 容器中所有 bean 的别名、类型、是否单例、依赖等信息。

当我们访问 localhost:8080/actuator/beans 时，会返回如下信息：

在这里插入图片描述

1.4.6 heapdump 端点

访问 http://localhost:8080/actuator/heapdump 会自动生成一个 JVM 的堆文件 heapdump。

在这里插入图片描述

我们可以使用 JDK 自带的 JVM 监控工具 VisualVM 打开此文件查看内存快照。

1.4.7 threaddump 端点

访问 localhost:8080/actuator/threaddump 会返回应用的线程信息，包括线程名、线程 ID、线程的状态、

是否等待锁资源、线程堆栈等信息。

在这里插入图片描述

1.4.8 shutdown 端点

这个端点属于操作控制类端点，可以优雅关闭 Spring Boot 应用。要使用这个功能首先需要在配置文件中开启：

# 配置
management.endpoint.shutdown.enabled=true

由于 shutdown 接口默认只支持 POST 请求，我们启动 Demo 项目，向

http://localhost:8080/actuator/shutdown 发起 POST 请求。

在这里插入图片描述

远程操作相对来说比较危险，所以一般在线上都不会开启这个端点。

1.5 总结

通过这篇文章，我们了解到 Spring 是利用 Spring Boot Actuator 进行监控指标收集的。与此同时，我们用一个极

简单的例子讲解了如何进行应用监控。最后我们讲解了 Spring Boot Actuator 的端点暴露配置以及常见的端点信

息。


http://www.niftyadmin.cn/n/1005621.html

相关文章

手写vue-diff算法（三）updateChildren

手写vue-diff算法（三）updateChildren

前文回顾 上一篇提到&#xff0c;新老儿子节点比对可能存在的 3 种情况及对应的处理方法&#xff1a; 情况 1&#xff1a;老的有儿子&#xff0c;新的没有儿子 处理方法&#xff1a;直接将多余的老dom元素删除即可&#xff1b; 情况 2&#xff1a;老的没有儿子&#xff0c;…
阅读更多...
加载Bert预训练模型时报错：huggingface_hub.utils._validators.HFValidationError

加载Bert预训练模型时报错：huggingface_hub.utils._validators.HFValidationError

具体报错情况如下&#xff1a; huggingface_hub.utils._validators.HFValidationError: Repo id must be in the form repo_name or namespace/repo_name: ./bert/bert_base_cased_ICEWS14. Userepo_typeargument if needed. 很简单&#xff0c;我download下来的代码没有并没有…
阅读更多...
【opencv】目标跟踪函数调用报错

【opencv】目标跟踪函数调用报错

报错内容 AttributeError: module cv2.cv2 has no attribute TrackerKCF_create或 AttributeError: module cv2.cv2 has no attribute TrackerCSRT_create或 AttributeError: module cv2.cv2 has no attribute TrackerMOSSE_create解决方法 将现有的opencv-python和opencv-…
阅读更多...
科技资讯|2023Q1中国电动汽车销量增长 29%，充电桩市场持续增长

科技资讯|2023Q1中国电动汽车销量增长 29%，充电桩市场持续增长

根据市场调查机构公布的 2023 年第 1 季度中国国内电动汽车市场报告&#xff0c;比亚迪继续引领竞争日益激烈的电动汽车市场。 报告称 2023 年第 1 季度中国乘用电动汽车销量同比增长 29%&#xff0c;其中纯电动汽车&#xff08;BEV&#xff09;占销售额的近 70%、插电式混合…
阅读更多...
4.HiveSQL 数据操作、查询语言（DML、DQL）

4.HiveSQL 数据操作、查询语言（DML、DQL）

1.Hive SQL-DML-Load加载数据 功能 Load&#xff0c;加载是指将我呢见移动到与Hive表对应的位置&#xff0c;移动时是纯复制、移动操作 语法规则 LOAD DATA [LOCAL] INPATH filepath [OVERWRITE] INTO TABLE tablename [PARTITION (partcol1val1, partcol2val2 ...)]LOAD DA…
阅读更多...
Spring Boot 中的 @Query 注解是什么，原理，如何使用

Spring Boot 中的 @Query 注解是什么，原理，如何使用

Spring Boot 中的 Query 注解是什么&#xff0c;原理&#xff0c;如何使用 在 Spring Boot 中&#xff0c;Query 注解是一个非常常用的注解&#xff0c;用于定义自定义查询语句。本文将介绍 Query 注解的作用、原理和使用方法。 1. Query 注解的作用 在 Spring Boot 中&#…
阅读更多...
【单片机】STM32F103C8T6单片机，OLED 1.3寸 IIC OLED，STM32F103单片机，I2C OLED

【单片机】STM32F103C8T6单片机，OLED 1.3寸 IIC OLED，STM32F103单片机，I2C OLED

文章目录 main.coled.coled.hOLED_Font.h 效果&#xff1a; main.c #include "sys.h" #include "usart.h" #include "OLED.h"int main(void) {NVIC_PriorityGroupConfig(NVIC_PriorityGroup_2); /* 设置NVIC中断分组2:2位抢占优…
阅读更多...
python爬虫怎么解决超时timeou错误

python爬虫怎么解决超时timeou错误

爬虫在运行过程会出现各种报错的问题&#xff0c;比如当我们在进行网络爬虫的时候&#xff0c;一般都是先进行网站的访问才能够正常的进行数据的获取&#xff0c;但是有的时候进行网站的访问的时候&#xff0c;总是会出现请求超时的情况。这个就可能是因为网络状况不好或者是服…
阅读更多...
最新文章

Copyright @ 2022~2023