ssss关于指标监控SpringBoot Actuator，我们以SpringBoot的官方文档为准。https://docs.spring.io/spring-boot/docs/2.5.7/reference/html/

• • SpringBoot Actuator
  • • 简介
    • • 1.x与2.x的不同
      • 如何使用？
      • 可视化：
    • Actuator Endpoint
    • • 最常使用的端点
      • 管理Endpoints
    • 定制 Endpoint

SpringBoot Actuator

简介

ssss未来每一个微服务在云上部署以后，我们都需要对其进行监控、追踪、审计、控制等。SpringBoot就抽取了Actuator场景，使得我们每个微服务快速引用即可获得生产级别的应用监控、审计等功能。
(在SpringBoot2.5.7种pom的父类依赖种已经引入了actuator)

1.x与2.x的不同

ssdsdss

如何使用？

ssss①、引入场景

ssss②、访问 http://localhost:8080/actuator/**

ssss③、 暴露所有监控信息为HTTP

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

ssss④、进行测试，eg：
http://localhost:8080/actuator/beans
http://localhost:8080/actuator/configprops
http://localhost:8080/actuator/metrics
http://localhost:8080/actuator/metrics/jvm.gc.pause
http://localhost:8080/actuator/endpointName/detailPath

可视化：

Actuator Endpoint

最常使用的端点

sdsadssass
ss①、Health Endpoint

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

dsdss重要的几点：

dsddsss● health endpoint返回的结果，应该是一系列健康检查后的一个汇总报告

dsddsss● 很多的健康检查默认已经自动配置好了，比如：数据库、redis等

dsddsss● 可以很容易的添加自定义的健康检查机制

ss②、Metrics Endpoint

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

dsddsss● 通过Metrics对接多种监控系统

dsddsss● 简化核心Metrics开发

dsddsss● 添加自定义Metrics或者扩展已有Metrics

管理Endpoints

ss①、开启与禁用Endpoints

dsdss● 默认所有的Endpoint除过shutdown都是开启的。

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

management:
  endpoint:
    beans:
      enabled: true

dsdss● 或者禁用所有的Endpoint然后手动开启指定的Endpoint

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

ss②、暴露Endpoints

dsdss支持的暴露方式

dsdsdss● HTTP：默认只暴露health和info Endpoint

dsddsss● JMX：默认暴露所有Endpoint

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

定制 Endpoint

ss①、定制 Health 信息

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);
    }
}

ss②、定制info信息

dsdsdss1、编写配置文件

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

dsdsdss2、编写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"));
    }

}

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

ss③、定制Metrics信息

dsdsdss1、SpringBoot支持自动适配的Metrics
dssdsd
dsdsdss2、增加定制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);
}

ss④、定制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....");
    }
}

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

ss当然，这个也可以直接使用 https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-kubernetes-probes