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,查看暴露出来的端点:

spring boot 健康检测类 springboot健康检查地址_后端


上面这样显示是因为chrome 浏览器安装了 JSON-handle 插件,实际上就是返回一大段json

下面,我会着重介绍几个比较重要的端点。

五、重要端点解析


5.1 /health端点

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

management.endpoint.health.show-details=always

该属性可以使用以下值之一进行配置:

| Name | Description |

| — | — |

| never | 不展示详细信息,up或者down的状态,默认配置 |

| when-authorized | 详细信息将会展示给通过认证的用户。授权的角色可以通过management.endpoint.health.roles配置 |

| always | 对所有用户暴露详细信息 |

按照上述配置,配置成always之后,我们启动项目,访问http://localhost:8080/actuator/health端口,可以看到这样的信息:

spring boot 健康检测类 springboot健康检查地址_spring boot 健康检测类_02

是不是感觉好像健康信息有点少?先别急,那是因为我们创建的是一个最基础的Demo项目,没有依赖很多的组件。Spring Boot 学习笔记分享给你看下。

/health端点有很多自动配置的健康指示器:如redis、rabbitmq、db等组件。当你的项目有依赖对应组件的时候,这些健康指示器就会被自动装配,继而采集对应的信息。如上面的 diskSpace 节点信息就是DiskSpaceHealthIndicator 在起作用。

上述截图取自官方文档

这是我另一个项目的/health端点信息。

spring boot 健康检测类 springboot健康检查地址_spring boot_03

当如上的组件有一个状态异常,应用服务的整体状态即为down。我们也可以通过配置禁用某个组件的健康监测。另外,Spring Boot 系列面试题和答案全部整理好了,微信搜索Java技术栈,在后台发送:面试,可以在线阅读。

management.health.mongo.enabled: false

或者禁用所有自动配置的健康指示器:

management.health.defaults.enabled: false

⭐自定义 Health Indicator

当然你也可以自定义一个Health Indicator,只需要实现HealthIndicator 接口或者继承AbstractHealthIndicator类。

/** * @author Richard_yyf * @version 1.0 2020/1/16 */@Componentpublic class CustomHealthIndicator extends AbstractHealthIndicator {    @Override    protected void doHealthCheck(Health.Builder builder) throws Exception {        // 使用 builder 来创建健康状态信息        // 如果你throw 了一个 exception,那么status 就会被置为DOWN,异常信息会被记录下来        builder.up()                .withDetail(“app”, “这个项目很健康”)                .withDetail(“error”, “Nothing, I’m very good”);    }}

最终效果:

spring boot 健康检测类 springboot健康检查地址_后端_04

5.2 /metrics端点

/metrics端点用来返回当前应用的各类重要度量指标,比如:内存信息、线程信息、垃圾回收信息、tomcat、数据库连接池等。

点击关注公众号,Java干货****及时送达

spring boot 健康检测类 springboot健康检查地址_后端_05

{    “names”: [        “tomcat.threads.busy”,        “jvm.threads.states”,        “jdbc.connections.active”,        “jvm.gc.memory.promoted”,        “http.server.requests”,        “hikaricp.connections.max”,        “hikaricp.connections.min”,        “jvm.memory.used”,        “jvm.gc.max.data.size”,        “jdbc.connections.max”,         …    ]}

不同于1.x,Actuator在这个界面看不到具体的指标信息,只是展示了一个指标列表。为了获取到某个指标的详细信息,我们可以请求具体的指标信息,像这样:

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

比如我访问/actuator/metrics/jvm.memory.max,返回信息如下:

spring boot 健康检测类 springboot健康检查地址_spring boot_06

你也可以用query param的方式查看单独的一块区域。比如你可以访问/actuator/metrics/jvm.memory.max?tag=id:Metaspace。结果就是:

spring boot 健康检测类 springboot健康检查地址_Java_07

5.3/loggers端点

/loggers 端点暴露了我们程序内部配置的所有logger的信息。我们访问/actuator/loggers可以看到,

spring boot 健康检测类 springboot健康检查地址_Java_08

你也可以通过下述方式访问单独一个logger,

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

比如我现在访问 root logger,http://localhost:8080/actuator/loggers/root

{    “configuredLevel”: “INFO”,    “effectiveLevel”: “INFO”}

⭐改变运行时的日志等级

/loggers端点我最想提的就是这个功能,能够动态修改你的日志等级。

比如,我们可以通过下述方式来修改 root logger的日志等级。我们只需要发起一个URL 为http://localhost:8080/actuator/loggers/rootPOST请求,POST报文如下:

{   “configuredLevel”: “DEBUG”}

spring boot 健康检测类 springboot健康检查地址_spring boot 健康检测类_09

仔细想想,这个功能是不是非常有用。如果在生产环境中,你想要你的应用输出一些Debug信息以便于你诊断一些异常情况,你你只需要按照上述方式就可以修改,而不需要重启应用。

如果想重置成默认值,把value 改成 null

5.4 /info端点

/info端点可以用来展示你程序的信息。我理解过来就是一些程序的基础信息。并且你可以按照自己的需求在配置文件application.properties中个性化配置(默认情况下,该端点只会返回一个空的json内容。):

info.app.name=actuator-test-demoinfo.app.encoding=UTF-8info.app.java.source=1.8info.app.java.target=1.8# 在 maven 项目中你可以直接用下列方式引用 maven properties的值# info.app.encoding=@project.build.sourceEncoding@# info.app.java.source=@java.version@# info.app.java.target=@java.version@

启动项目,访问http://localhost:8080/actuator/info

{    “app”: {        “encoding”: “UTF-8”,        “java”: {            “source”: “1.8.0_131”,            “target”: “1.8.0_131”        },        “name”: “actuator-test-demo”    }}

5.5 /beans端点

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

访问http://localhost:8080/actuator/beans,返回如下:

spring boot 健康检测类 springboot健康检查地址_Java_10

5.6 /heapdump 端点

访问:http://localhost:8080/actuator/heapdump会自动生成一个 Jvm 的堆文件 heapdump。我们可以使用 JDK 自带的 Jvm 监控工具 VisualVM 打开此文件查看内存快照。46 张 PPT 弄懂 JVM 性能调优推荐看下。

spring boot 健康检测类 springboot健康检查地址_后端_11

5.7 /threaddump 端点

这个端点我个人觉得特别有用,方便我们在日常定位问题的时候查看线程的情况。主要展示了线程名、线程ID、线程的状态、是否等待锁资源、线程堆栈等信息。就是可能查看起来不太直观。访问http://localhost:8080/actuator/threaddump返回如下:

spring boot 健康检测类 springboot健康检查地址_spring boot 健康检测类_12

5.8 /shutdown端点

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