Spring Boot 提供了所谓的 endpoints (下文翻译为端点)给外部来与应用程序进行访问和交互。
打比方来说,/health
端点 提供了关于应用健康情况的一些基础信息。metrics
端点提供了一些有用的应用程序指标(JVM 内存使用、系统CPU使用等)。
这些 Actuator 模块本来就有的端点我们称之为原生端点。根据端点的作用的话,我们大概可以分为三大类:
-
应用配置类:获取应用程序中加载的应用配置、环境变量、自动化配置报告等与Spring Boot应用密切相关的配置类信息。
-
度量指标类:获取应用程序运行过程中用于监控的度量指标,比如:内存信息、线程池信息、HTTP请求统计等。
-
操作控制类:提供了对应用的关闭等操作类功能。
详细的原生端点介绍,请以官网为准,这里就不赘述徒增篇幅。
需要注意的就是:
-
每一个端点都可以通过配置来单独禁用或者启动
-
不同于Actuator 1.x,Actuator 2.x 的大多数端点默认被禁掉。Actuator 2.x 中的默认端点增加了
/actuator
前缀。默认暴露的两个端点为/actuator/health
和/actuator/info
四、端点暴露配置
我们可以通过以下配置,来配置通过JMX 和 HTTP 暴露的端点。
| Property | Default |
| — | — |
| management.endpoints.jmx.exposure.exclude
|
|
| management.endpoints.jmx.exposure.include
| *
|
| management.endpoints.web.exposure.exclude
|
|
| management.endpoints.web.exposure.include
| info, healt
|
可以打开所有的监控点
management.endpoints.web.exposure.include=*
也可以选择打开部分,“*” 代表暴露所有的端点,如果指定多个端点,用","分开
management.endpoints.web.exposure.exclude=beans,trace
Actuator 默认所有的监控点路径都在/actuator/*
,当然如果有需要这个路径也支持定制。
management.endpoints.web.base-path=/minitor
设置完重启后,再次访问地址就会变成/minitor/*
。
现在我们按照如下配置:
# “*” 代表暴露所有的端点 如果指定多个端点,用","分开
management.endpoints.web.exposure.include=*
# 赋值规则同上
management.endpoints.web.exposure.exclude=
启动DEMO程序,访问http://localhost:8080/actuator
,查看暴露出来的端点:
上面这样显示是因为chrome 浏览器安装了 JSON-handle 插件,实际上就是返回一大段json
下面,我会着重介绍几个比较重要的端点。
五、重要端点解析
5.1 /health
端点
/health
端点会聚合你程序的健康指标,来检查程序的健康情况。端点公开的应用健康信息取决于:
management.endpoint.health.show-details=always
该属性可以使用以下值之一进行配置:
| Name | Description |
| — | — |
| never
| 不展示详细信息,up或者down的状态