SpringBoot之指标监控(Actuator)

1. SpringBoot Actuator

1.1 简介

未来每一个微服务在云上部署以后，我们都需要对其进行监控、追踪、审计、控制等。SpringBoot就抽取了Actuator场景，使得我们每个微服务快速引用即可获得生产级别的应用监控、审计等功能。

1.x与2.x的不同

2. 如何使用SpringBoot Actuator

2.1 导入场景启动器

引入jar包

  
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-actuatorartifactId>
        dependency>

2.2 暴露Endpoints

支持的暴露方式

• HTTP：默认只暴露health和info Endpoint
• JMX：默认暴露所有Endpoint
• 除过health和info，剩下的Endpoint都应该进行保护访问。如果引入SpringSecurity，则会默认配置安全访问规则
  详细的看图

在配置文件配置

#配置Actuator监控功能
# management 是所有Actuator的配置
# management.endpoint.端点名.xxx  对某个端点的具体配置
management:
  endpoints:
    enabled-by-default: true  #暴露所有端点信息，如果为false，则每个端点需要手动开启enabled: true
    web:
      exposure:
        include: '*'   #以web方式暴露
  endpoint:
    health:
      show-details: always  #配置health详细信息
      enabled: true

最常使用的端点：详细版本

如果您的应用程序是Web应用程序（Spring MVC，Spring WebFlux或Jersey），则可以使用以下附加端点：

最常用的Endpoint

• Health：监控状况
• Metrics：运行时指标
• Loggers：日志记录

2.3 测试

2.3.1 测试beans

http://localhost:9080/actuator/beans
显示应用程序中所有Spring Bean的完整列表。

2.3.2 测试conditions

显示自动配置的所有条件信息，包括匹配或不匹配的原因。

2.3.2 测试health

显示应用程序运行状况信息。

2.3.2 测试metrics

2.4 Health Endpoint

健康检查端点，我们一般用于在云平台，平台会定时的检查应用的健康状况，我们就需要Health Endpoint可以为平台返回当前应用的一系列组件健康状况的集合。
重要的几点：
● health endpoint返回的结果，应该是一系列健康检查后的一个汇总报告
● 很多的健康检查默认已经自动配置好了，比如：数据库、redis等
● 可以很容易的添加自定义的健康检查机制

2.4 Metrics Endpoint

提供详细的、层级的、空间指标信息，这些信息可以被pull（主动推送）或者push（被动获取）方式得到；
● 通过Metrics对接多种监控系统
● 简化核心Metrics开发
● 添加自定义Metrics或者扩展已有Metrics

3. 如何定制 Endpoint

3.1 定制 Health 信息

定义一个类MyComHealthIndicator继承AbstractHealthIndicator或者实现HealthIndicator接口

//定义一个类MyComHealthIndicator继承AbstractHealthIndicator
@Component
public class MyComHealthIndicator extends AbstractHealthIndicator {

    /**
     * 真实的检查方法
     * @param builder
     * @throws Exception
     */
    @Override
    protected void doHealthCheck(Health.Builder builder) throws Exception {
        //获取连接测试
        Map<String,Object> map = new HashMap<>();
        //检查完成
        if (1==2){
            builder.status(Status.UP);//健康
            map.put("count",1);
            map.put("ms",100);
        }else {
            builder.status(Status.OUT_OF_SERVICE);
            map.put("err","连接超时");
            map.put("ms",3000);
        }
        //详细信息
        builder.withDetail("code",500).withDetails(map);

    }
}

3.2 定制info信息

有两种方式来定制info信息

3.2.1 编写配置文件

info:
  appName: boot-admin
  version: 2.0.1
  mavenProjectName: @project.artifactId@  #使用@@可以获取maven的pom文件值
  mavenProjectVersion: @project.version@

3.2.2 编写InfoContributor

@Component
public class ExampleInfoContributor implements InfoContributor {
    @Override
    public void contribute(Info.Builder builder) {
        builder.withDetail("example",
                Collections.singletonMap("key", "value"));
    }
}

3.3 定制Metrics信息

SpringBoot支持自动适配的Metrics
● JVM metrics, report utilization of:
○ Various memory and buffer pools
○ Statistics related to garbage collection
○ Threads utilization
○ Number of classes loaded/unloaded
● CPU metrics
● File descriptor metrics
● Kafka consumer and producer metrics
● Log4j2 metrics: record the number of events logged to Log4j2 at each level
● Logback metrics: record the number of events logged to Logback at each level
● Uptime metrics: report a gauge for uptime and a fixed gauge representing the application’s absolute start time
● Tomcat metrics (server.tomcat.mbeanregistry.enabled must be set to true for all Tomcat metrics to be registered)
● Spring Integration metrics

3.3.1 如何定制Metrics

使用构造器注入MeterRegistry，就可以定制Metrics

@RestController
public class UserController {

    Counter counter;
    //使用构造器注入MeterRegistry
    public UserController(MeterRegistry meterRegistry){
        counter = meterRegistry.counter("UserController.method.running.counter");
    }

    @GetMapping("/user")
    //@RequestMapping(value = "/user",method = RequestMethod.GET)
    public String getUser(@RequestParam("name") String name){
        counter.increment();
        return "GET-"+name;
    }

也可以使用下面这种方式

//也可以使用下面的方式
@Bean
MeterBinder queueSize(Queue queue) {
    return (registry) -> Gauge.builder("queueSize", queue::size).register(registry);
}

使用http://localhost:9080/actuator/metrics/UserController.method.running.counter查看详细信息。

3.4 定制Endpoint端点

@Component
@Endpoint(id="docker")
public class DockerEndpoint {


    @ReadOperation
    public Map getDockerInfo(){
        return Collections.singletonMap("info","docker started...");
    }

    @WriteOperation
    private void restartDocker(){
        System.out.println("docker restarted....");
    }
}

可以使用Jconsole执行restartDocker

4. 使用监控服务器监控指标

可视化 ：https://github.com/codecentric/spring-boot-admin

4.1 如何创建监控服务器

1. 创建一个独立的微服务只需要引入两个jar包。

  <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-webartifactId>
        dependency>

        <dependency>
            <groupId>de.codecentricgroupId>
            <artifactId>spring-boot-admin-starter-serverartifactId>
            <version>2.3.1version>
        dependency>

2. 并在启动类上标注@EnableAdminServer注解

@EnableAdminServer
@SpringBootApplication
public class BootDemoAdminserverApplication {

3.需要在客户端引入jar包

 <dependency>
            <groupId>de.codecentricgroupId>
            <artifactId>spring-boot-admin-starter-clientartifactId>
            <version>2.3.1version>
        dependency>

配置属性

#配置Actuator监控功能
# management 是所有Actuator的配置
# management.endpoint.端点名.xxx  对某个端点的具体配置
management:
  endpoints:
    enabled-by-default: true  #暴露所有端点信息，如果为false，则每个端点需要手动开启enabled: true
    web:
      exposure:
        include: '*'   #以web方式暴露
  endpoint:
    health:
      show-details: always  #配置health详细信息
      enabled: true
spring:
  boot:
    admin:
      client:
        url: http://localhost:8888  #监控服务器地址
        instance:
          prefer-ip: true  #使用ip注册
  application:
    name: demo-02

测试结果：