Java中使用Micrometer来实现监控数据的输出

声明：
1.本节以Prometheus作为监控平台来监控，所以Micrometer的实现模块选择的也是Prometheus的
2.本节主要展示效果，具体写法请阅读参考文档列出的文章

---

一、如何在Springboot项目中使用Micrometer

spring boot actuator中配置了与Micrometer相关的自动配置，只要添加Mircrometer的具体实现模块的依赖即可，配置完成后，运行程序，即可在/actuator/prometheus路径下看到输出的metric信息

• 添加依赖

    org.springframework.boot
    spring-boot-starter-actuator


    io.micrometer
    micrometer-registry-prometheus
    1.2.1

如果在运行时会出现找不到方法之类的异常，请适当降低依赖micrometer-registry-prometheus的版本

• 配置spring boot actuator

management:
  endpoints:
    web:
      exposure:
        include: "health,info,prometheus"

---

二、注册表

Micrometer中核心两个内容便是meter和registry，注册表用于将各种meter注册到自身中进行管理，而meter就是各种监控的工具，比如计数器，计量器，计时器等等。不同的监控系统会有不同的注册表实现，其基类都是MeterRegistry，对应于Prometheus的注册表是PrometheusMeterRegistry。
Spring boot中只要你配置好了上节所述的内容后，就会自动生成一个MeterRegistry类型的bean，你只需要在需要使用它的地方注入即可，如果你需要自定义MeterRegistry的各种配置，比如公共标签（所有该项目的监控信息都会加上一个相同的标签）等等，你可以配置一个类型为MeterRegistryCustomizer的bean，来进行一些自定义的操作：

@Bean
@ConditionalOnBean({MtkMeterRegistryAutoConfiguration.class})
@Autowired
public MeterRegistryCustomizer meterRegistryCustomizer(MtkMeterRegistryConfiguration mtkMeterRegistryConfiguration){
    return mtkMeterRegistryConfiguration::apply;
}

---

三、计数器

计数器用来表示计数类监控项目，比如“控制器的访问次数”，“方法的调用次数”等等，这类监控信息都是只增不减的，且和次数有关。

• 创建一个计数器，对访问页面"/meter/greet"的次数进行计数
  • 控制器

  /**
  * 每访问一次该页面，green_count计数器+1
  */
  @RequestMapping("/greet")
  public String greet(){
      return "greet count: " + metricTemplate.counterAdd("greet.count");
  }
  

  • MetricTemplate#counterAdd

  public double counterAdd(String counterName , String... tags){
      return counterAdd(counterName , 1 , tags);
  }
  
  public double counterAdd(String counterName , double increment ,String... tags){
      Counter counter = meterRegistry.counter(counterName, tags);
      counter.increment(increment);
      return counter.count();
  }
  

  • 访问localhost:8080/meter/greet5次
  • 访问localhost:8080/actuator/prometheus搜索"greet_count"

  # HELP greet_count_total  
  # TYPE greet_count_total counter
  greet_count_total{project="mtk-micrometer",} 5.0
  

---

四、计量器

计量器用于持续计量类的任务，比如“集合长度”、“加载了类的个数”、“最大访问时间”等等。

• 创建一个计量器，对一个集合的长度进行计量，每访问/meter/random一次，这个集合长度就会加一
  • 控制器

  @Autowired
  public MeterTest(MetricTemplate metricTemplate){
      this.metricTemplate = metricTemplate;
      //计量器初始化
      this.metricTemplate.gaugeSet("random.list.gauge" , target -> ((List)target).size() , randomIntList);
  }
  /**
   *每访问一次，生成一个随机值，并存入randomIntList
   * @return 返回随机产生的值
   */
  @RequestMapping("/random")
  public int randomNumber(){
      int randomNumber = (int) (Math.random() * 100);
      randomIntList.add(randomNumber);
      return randomNumber;
  }
  

  • MetricTemplate#gaugeSet

  public void gaugeSet(String gaugeName , ToDoubleFunction