不知道大家在写 Spring Boot
项目的过程中,使用过 Spring Boot Actuator
吗?知道 Spring Boot Actuator
是什么,干什么的吗?今天就要来给大家介绍一下 Spring Boot Actuator
,学习如何在 Spring Boot 2.x
中使用、配置和扩展这个监控工具。Spring Boot 1.x
的使用就不再这边介绍了。相信大家平时使用的框架基本上都要升级到 2.x了吧。
什么是 Actuator ?
从本质上讲,Spring Boot Actuator
为我们的应用程序带来了生产就绪的功能。监控我们的应用程序,收集指标,了解流量,或者是数据库的状态。有了它,我们就可以很简单的监控应用程序的各种指标数据。
Spring Boot Actuator
使用 http 或者 JMX 的方式来公开运行中的应用程序的操作信息--健康、指标、信息、转储、环境等,我们能够方便的与它互动。只要添加Spring Boot Actuator
依赖到 classpath 中,就有几个指标路径可供我们开箱使用。与大多数 Spring boot
模块一样,我们可以很容易地以多种方式配置或扩展它。
快速入门
要想启用 Spring Boot Actuator
,我们只需在软件包管理器中添加 spring-boot-starter-actuator
依赖项。在 pom.xml
文件添加如下代码即可:
是吧,很简单就添加好了。有的小朋友可能会有疑问了,为什么没有添加 version
节点呢?那是因为 Spring Boot
的 parent pom
会制定版本号,所以这里无需再次指定了。
Spring Boot 2.x Actuator
在 2.x
版本中,Spring Boot Actuator
保持了 1.x
的基本操作,但简化了它的模型,扩展了它的能力,并加入了更好的默认值。这个版本变得与技术无关。它还简化了其安全模型,将其与应用程序模型合并。最新版本现在支持CRUD模型,而不是旧的读写模型。
技术支持
在 2.x
中,Spring Boot Actuator
将其模型定义为可插拔和可扩展的,而不依赖于 MVC。通过这个新的模型,我们能够利用 MVC 以及 WebFlux 作为底层 Web 技术的优势。此外,可以通过实现正确的适配器来添加即将到来的技术。不过 JMX 仍然被支持,无需任何额外的代码就可以暴露路径。
重要变化
与以前的版本不同,Spring Boot Actuator
的大多数路径都是禁用的。默认情况下,只有 /health
和 /info
两个可用。如果我们想启用所有的路径,可以设置 management.endpoints.web.exposure.include=*
来实现。Actuator
现在与常规的 App
安全规则共享安全配置,所以安全模型被大大简化。要调整 Actuator
的安全规则,我们可以只添加一个 /actuator/**
的条目。
我们可以在全新的 Actuator
官方文档中找到进一步的细节。另外,在默认情况下,所有的 Actuator
路径现在都被放在 /actuator
路径下。和以前的版本一样,我们可以使用新的属性management.endpoints.web.base-path
来调整这个路径。
预定义的路径
让我们看看一些可用的路径,其中大部分在1.x中已经可用。另外,有些路径被添加了,有些被删除了,有些被重组了。
- /auditevents 列出了安全审计相关的事件,如用户登录/注销。此外,我们还可以通过本金或类型以及其他字段进行过滤。
- /beans 返回我们BeanFactory中所有可用的bean。与/auditevents不同,它不支持过滤。
- /conditions,以前被称为/autoconfig,围绕自动配置建立一个条件报告。
- /configprops 允许我们获取所有@ConfigurationProperties。
- /env 返回当前的环境属性。此外,我们还可以检索单个属性。
- /flyway 提供了关于我们Flyway数据库迁移的细节。
- /health 总结了我们应用程序的健康状态。
- /heapdump 构建并返回我们应用程序使用的 JVM 的堆存储。
- /info 返回一般信息。它可能是自定义数据、构建信息或关于最新提交的细节。
- /liquibase 的行为类似于/flyway,但针对Liquibase。
- /logfile 返回普通的应用程序日志。
- /loggers 使我们能够查询和修改我们应用程序的日志级别。
- /metrics 详细说明我们应用程序的指标。这可能包括通用指标和自定义指标。
- /prometheus 返回与前面一样的指标,但格式化为与Prometheus服务器一起工作。
- /scheduledtasks 提供了关于我们应用程序中每个计划任务的细节。
- /sessions 列出HTTP会话,因为我们使用的是Spring Session。
- /shutdown 执行应用程序的优雅关闭。
- /threaddump 转储底层JVM的线程信息。
执行器路径的超媒体
Spring Boot
增加了一个所有路径的集合入口,可以返回所有可用的执行器路径的链接。这将有助于发现执行器路径及其相应的URL。默认情况下,这个集合入口可以通过 /actuator
路径访问。因此,如果我们向这个URL发送一个GET请求,它将返回各种路径的执行器链接。
如上所示,/actuator
路径在 _links
字段下报告所有可用的执行器路径。如果我们配置了一个自定义的管理基础路径,那么我们应该能使用该集合入口发现URL。例如,如果我们将management.endpoints.web.base-path
设置为 /mgmt
,那么我们应该向 /mgmt
路径发送请求,以查看链接列表。但是如果当管理集合入口被设置为 / 时,集合入口被禁用,以防止与其他映射发生冲突的可能性。
健康指示器
就像以前的版本一样,我们可以很容易地添加自定义指标。与其他 API 相反,用于创建自定义健康路径的抽象概念保持不变。然而,一个新的接口,即 ReactiveHealthIndicator
,已经被添加到实现反应式健康检查。让我们来看看一个简单的自定义反应式健康检查。
健康指标的一个方便的特点是,我们可以把它们作为一个层次结构的一部分进行汇总。因此,按照前面的例子,我们可以把所有的下游服务归入一个下游服务类别。只要每个嵌套的服务都是可以到达的,这个类别就会是健康的。
健康组
从 Spring Boot 2.2
开始,我们可以将健康指标组织成组,并对所有组员应用相同的配置。例如,我们可以通过在 application.properties
中添加以下内容来创建一个名为 custom
的健康组。
这样,自定义组包含 diskSpace
和 ping
健康指标。现在,如果我们调用 /actuator/health
路径,它将在 JSON
响应中告诉我们关于新的健康组。