云计算、AI、云原生、大数据等一站式技术学习平台

网站首页 > 教程文章 正文

如何在Spring Boot中整合Spring Boot Actuator进行服务应用监控?

jxf315 2025-01-20 14:07:04 教程文章 43 ℃

监控是确保系统稳定性和性能的关键组成部分,而在Spring Boot中就提供了默认的应用监控方案Spring Boot Actuator,通过Spring Boot Actuator提供了开箱即用的应用监控功能,我们就可以实现对于Spring Boot应用的高效监控操作。下面我们就来详细介绍Spring Boot Actuator如何与Spring Boot集成。

Spring Boot Actuator介绍

Spring Boot Actuator是Spring Boot中的一个子模块,用来提供对Spring Boot应用的监控和管理操作功能,可以帮助开发者监控应用程序的内部状态,检查应用程序中潜在的问题来提高系统的可维护性。

在Spring Boot Actuator中暴露了很多的端口,开发者可以通过这些端点获取到应用的健康状况、应用的环境信息、系统统计信息等内容。帮助开发者能够快速的找到系统瓶颈对系统性能做好提升。

添加Spring Boot Actuator依赖

要在Spring Boot项目中使用Spring Boot Actuator,首先就需要在POM文件中添加Spring Boot Actuator相关的依赖,如下所示。

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

Spring Boot Actuator提供了一些默认配置,但是我们还是可以通过配置文件来定义一些自定义的配置,如下所示。

配置Spring Boot Actuator

配置暴露的端点

默认情况下,Spring Boot Actuator会暴露一些常见的端点,例如/actuator/health和/actuator/info等,当然在Spring Boot的配置文件中,我们可以通过management.endpoints.web.exposure.include来配置暴露端点。

management.endpoints.web.exposure.include=health,info,metrics

当然也可以通过如下的配置来暴露所有的端点。

management.endpoints.web.exposure.include=*

如果只是想暴露一些健康检查端点和自定义的信息端点,可以通过如下的配置来实现。

management.endpoints.web.exposure.include=health,info

配置Actuator端点的访问权限

有时候,我们还需要对不同的端点设置不同的访问策略,这个时候,我们可以通过management.endpoints.web.exposure和management.endpoint.<endpoint-name>.enabled来控制端点的访问权限控制。

例如,禁用/actuator/metrics端点

management.endpoint.metrics.enabled=false

配置端点的路径前缀

默认情况下,Actuator的端点都以/actuator为前缀,例如/actuator/health。这里我们可以通过management.endpoints.web.base-path来修改访问的前缀,如下所示。

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

这个时候,上面的连接就会变成/manage/health。

使用Spring Boot Actuator端点

下面,我们就来介绍一下在实际开发中的一些比较常用的端点信息。

/actuator/health:健康检查

这是最常用的端点之一,返回了关于应用健康的简报信息。在默认情况下,会检查应用的数据库信息、磁盘空间信息等,如下所示。

{
  "status": "UP"
}

状态值如下所示。

  • UP:应用健康状态正常
  • DOWN:应用有问题
  • OUT_OF_SERVICE:应用处于暂停服务状态
  • UNKNOWN:无法确定应用健康状态

/actuator/info:应用信息

/actuator/info端点默认情况下暴露了应用元数据相关的信息,例如版本号、构建时间等等,当然我们可以通过配置文件来对这些信息进行修改,如下所示。

info.app.name=Spring Boot Demo
info.app.version=1.0.0
info.app.description=Spring Boot Actuator Demo Application

这样当我们在访问该端点的时候,我们就会看到如下的信息。

{
  "app": {
    "name": "Spring Boot Demo",
    "version": "1.0.0",
    "description": "Spring Boot Actuator Demo Application"
  }
}

/actuator/metrics:性能指标

/actuator/metrics端点主要是展示了应用程序中的各种性能信息的统计,例如内存的使用情况、JVM垃圾回收情况、线程池的使用情况等等,当我们访问该端点的时候,会看到如下的信息。

{
  "names": [
    "jvm.memory.used",
    "jvm.gc.pause",
    "system.cpu.usage",
    "http.server.requests"
  ]
}

例如,可以通过如下的接口来访问内存使用情况,如下所示。

GET http://localhost:8080/actuator/metrics/jvm.memory.used

反馈结果如下所示。

{
  "name": "jvm.memory.used",
  "description": "Used JVM memory",
  "measurements": [
    {
      "statistic": "VALUE",
      "value": 1234567890
    }
  ],
  "availableTags": [
    {
      "tag": "area",
      "values": ["heap", "non-heap"]
    }
  ]
}

/actuator/loggers:日志管理

/actuator/loggers端点,主要的功能是提供动态调整日志级别的操作,我们可以通过该端点来查询日志的级别并且还可以通过该端点来修改日志记录器的级别,如下所示。

GET http://localhost:8080/actuator/loggers

可以通过如下的操作来修改日志记录器的日志级别如下。

POST http://localhost:8080/actuator/loggers/org.springframework.web
Content-Type: application/json

{
  "configuredLevel": "DEBUG"
}

安全性与认证

当然在很多场景中Actuator端点的暴露会引起安全漏洞,所以我们需要为Actuator设置一定的安全授权访问机制来保证端口接口的安全性,我们可以通过Spring Security来保护这些端点信息,如下所示,可以在配置文件中添加如下的信息来添加Spring Security的配置。

management.endpoints.web.exposure.include=health,info,metrics
management.endpoints.web.exposure.exclude=loggers
management.security.enabled=true

或者我们可以通过基本身份认证操作来控制权限访问。

management.endpoints.web.exposure.include=*
spring.security.user.name=admin
spring.security.user.password=admin123

这时候,当我们访问Actuator的端点的时候,就需要通过用户名和密码进行访问了,但是需要注意这里的用户名和密码的保护。

总结

在Spring Boot Actuator中提供了非常丰富的应用监控和管理的功能,可以帮助开发者实时的对应用的运行情况进行监控有助于构建强大的实时监控系统,当然暴露Spring Boot Actuator中的端点可能会带来各种的安全漏洞的问题,所以在实现的时候需要注意安全以及系统的稳定性。

最近发表
标签列表