1 SpringBoot Actuator

1.1 简介

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

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

1.2 如何使用

• 引入场景

• 访问http://localhost:8080/actuator/**

• 暴露所有监控信息为HTTP

  management:
    endpoints:
      enabled-by-default: true #暴露所有端点信息
      web:
        exposure:
          include: '*'  #以web方式暴露
  

1.3 可视化

https://github.com/codecentric/spring-boot-admin

2 Actuator Endpoint

2.1 常用端点

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

最常用的EndPoint。

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

2.2 Health Endpoint

健康检查端点，我们一般用于在云平台，平台会定时的检查应用的健康状况，我们就需要Health Endpoint可以为平台返回当前应用的一系列组件健康状况的集合。

• health endpoint返回的结果，应该是一系列健康检查后的一个汇总报告
• 很多的健康检查默认已经自动配置好了，比如：数据库、redis等
• 可以很容易的添加自定义的健康检查机制

2.3 Metrics Endpoint

提供详细的、层级的、空间指标信息，这些信息可以被pull（主动推送）或者push（被动获取）方式得到。

• 通过Metrics对接多种监控系统
• 简化核心Metrics开发
• 添加自定义Metrics或者扩展已有Metrics

2.4 管理Endpoint

2.4.1 开启与禁用Endpints

• 默认所有的Endpoint（除了shutdown）都是开启的

• 需要开启或者禁用某个Endpoint。配置模式为 management.endpoint..enabled = true

• 可禁用所有的Endpoint然后手动开启指定的Endpoint

  management:
    endpoints:
      enabled-by-default: false
    endpoint:
      beans:
        enabled: true
      health:
        enabled: true
  

2.4.2 暴露Endpoints

支持的暴露方式

• HTTP：默认只暴露health和info Endpoint

• JMX：默认暴露所有Endpoint

• 除了health和info，剩下的Endpoint都应该进行保护访问，如果引入SpringSecurity，则会默认配置安全访问规则

  ID	JMX	Web
  auditevents	Yes	No
  beans	Yes	No
  caches	Yes	No
  conditions	Yes	No
  configprops	Yes	No
  env	Yes	No
  flyway	Yes	No
  health	Yes	Yes
  heapdump	N/A	No
  httptrace	Yes	No
  info	Yes	Yes
  integrationgraph	Yes	No
  jolokia	N/A	No
  logfile	N/A	No
  loggers	Yes	No
  liquibase	Yes	No
  metrics	Yes	No
  mappings	Yes	No
  prometheus	N/A	No
  scheduledtasks	Yes	No
  sessions	Yes	No
  shutdown	Yes	No
  startup	Yes	No
  threaddump	Yes	No

3 定制Endpoint

3.1 定制Health信息

自定义的Health类名必须叫xxxHealthIndicator，xxx则是组件名字，可以参考DiskSpaceHealthIndicator

import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.stereotype.Component;

@Component
public class MyHealthIndicator implements HealthIndicator {

    @Override
    public Health health() {
        int errorCode = check(); // perform some specific health check
        if (errorCode != 0) {
            return Health.down().withDetail("Error Code", errorCode).build();
        }
        return Health.up().build();
    }

}

构建Health
Health build = Health.down()
                .withDetail("msg", "error service")
                .withDetail("code", "500")
                .withException(new RuntimeException())
                .build();

management:
    health:
      enabled: true
      show-details: always #总是显示详细信息。可显示每个模块的状态信息

@Component
public class MyComHealthIndicator extends AbstractHealthIndicator {

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


        builder.withDetail("code",100)
                .withDetails(map);

    }
}

3.2 定制info信息

常用两种方式。

• 编写配置文件

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

• 编写InfoContributor

  import java.util.Collections;
  
  import org.springframework.boot.actuate.info.Info;
  import org.springframework.boot.actuate.info.InfoContributor;
  import org.springframework.stereotype.Component;
  
  @Component
  public class ExampleInfoContributor implements InfoContributor {
  
      @Override
      public void contribute(Info.Builder builder) {
          builder.withDetail("example",
                  Collections.singletonMap("key", "value"));
      }
  
  }
  

  http://localhost:8080/actuator/info 会输出以上方式返回的所有info信息

3.3 定制Metrics信息

3.3.1 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.2 增加定制Metrics

class MyService{
    Counter counter;
    public MyService(MeterRegistry meterRegistry){
         counter = meterRegistry.counter("myservice.method.running.counter");
    }

    public void hello() {
        counter.increment();
    }
}


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

4 定制Endpoint

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


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

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

场景：开发ReadinessEndpoint来管理程序是否就绪，或者LivenessEndpoint来管理程序是否存活。