29. Spring Boot Actuator

Spring Boot Actuator 在Spring Boot第一个版本发布的时候就有了,它为Spring Boot提供了一系列产品级的特性:监控应用程序,收集元数据,运行情况或者数据库状态等。

使用Spring Boot Actuator我们可以直接使用这些特性而不需要自己去实现,它是用HTTP或者JMX来和外界交互。

开始使用Spring Boot Actuator

要想使用Spring Boot Actuator,需要添加如下依赖:

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

开始使用Actuator

配好上面的依赖之后,我们使用下面的主程序入口就可以使用Actuator了:

@SpringBootApplication
public class ActuatorApp {
    public static void main(String[] args) {
        SpringApplication.run(ActuatorApp.class, args);
    }
}

启动应用程序,访问http://localhost:8080/actuator:

我们可以看到actuator默认开启了两个入口:/health和/info。

如果我们在配置文件里面这样配置,则可以开启actuator所有的入口:

重启应用程序,再次访问http://localhost:8080/actuator:

我们可以看到actuator暴露的所有入口。

Health Indicators

Health入口是用来监控组件的状态的,通过上面的入口,我们可以看到Health的入口如下:

有两个入口,一个是总体的health,一个是具体的health-path。

我们访问一下http://localhost:8080/actuator/health:

上面的结果实际上是隐藏了具体的信息,我们可以通过设置

来开启详情,开启之后访问如下:

其中的components就是health-path,我们可以访问具体的某一个components如http://localhost:8080/actuator/health/db:

就可以看到具体某一个component的信息。

这些Health components的信息都是收集实现了HealthIndicator接口的bean来的。

我们看下怎么自定义HealthIndicator:

再次查看http://localhost:8080/actuator/health, 我们会发现多了一个Cust的组件:

在Spring Boot 2.X之后,Spring添加了React的支持,我们可以添加ReactiveHealthIndicator如下:

再次查看http://localhost:8080/actuator/health,可以看到又多了一个组件:

/info 入口

info显示了App的大概信息,默认情况下是空的。我们可以这样自定义:

查看:http://localhost:8080/actuator/info

/metrics入口

/metrics提供了JVM和操作系统的一些信息,我们看下metrics的目录,访问:http://localhost:8080/actuator/metrics:

访问其中具体的某一个组件如下http://localhost:8080/actuator/metrics/jvm.memory.max:

Spring Boot 2.X 的metrics是通过Micrometer来实现的,Spring Boot会自动注册MeterRegistry。 有关Micrometer和Spring Boot的结合使用我们会在后面的文章中详细讲解。

自定义Endpoint

Spring Boot的Endpoint也是可以自定义的:

访问http://localhost:8080/actuator/, 我们会发现多了一个入口: http://localhost:8080/actuator/features/ 。

上面的代码中@ReadOperation对应的是GET, @WriteOperation对应的是PUT,@DeleteOperation对应的是DELETE。

@Selector后面对应的是路径参数, 比如我们可以这样调用configureFeature方法:

注意,这里的请求BODY是以JSON形式提供的:

请求URL:/actuator/features/abc 中的abc就是@Selector 中的 name。

我们再看一下GET请求:

http://localhost:8080/actuator/features/

这个就是我们之前PUT进去的值。

扩展现有的Endpoints

我们可以使用@EndpointExtension (@EndpointWebExtension或者@EndpointJmxExtension)来实现对现有EndPoint的扩展:

上面的例子扩展了InfoEndpoint。

本文所提到的例子可以参考:https://github.com/ddean2009/learn-springboot2/tree/master/springboot-actuator

最后更新于

这有帮助吗?