本文演示的项目主要为SpringBoot2.2.1版本，更高的版本使用姿势没有太大的区别，至于1.x版本的不确保可行（因为我并没有测试）
pom依赖，主要是下面几个包
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-registry-prometheus</artifactId>
</dependency>
</dependencies>
其次是配置文件，注册下Prometheus的相关信息
spring:
application:
name: prometheus-example
management:
endpoints:
web:
exposure:
include: "*"
metrics:
tags:
application: ${spring.application.name}
上面配置中，有两个关键信息，前面博文也有介绍，这里简单说明
management.endpoints.web.exposure.include 这里指定所有的web接口都会上报metrics.tags.application 这个应用所有上报的metrics 都会带上application这个标签配置完毕之后，会提供一个 /actuator/prometheus的端点，供prometheus来拉取Metrics信息
假设我们现在想自己上报http请求的相关信息，当前计划采集下面几个信息
CounterGaugeHistogram基于上面的分析，我们这里实现了三种常见的Metric信息上报，这里提供一个统一的封装类，用于获取对应的Metric类型
package com.git.hui.boot.prometheus.interceptor;
import io.prometheus.client.CollectorRegistry;
import io.prometheus.client.Counter;
import io.prometheus.client.Gauge;
import io.prometheus.client.Histogram;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;
/**
* @author yihui
* @date 2021/11/09
*/
@Component
public class PrometheusComponent implements ApplicationContextAware {
private static PrometheusComponent instance;
/**
* 请求总数
*/
private Counter reqCounter;
/**
* 正在请求的http数量
*/
private Gauge duringReqGauge;
/**
* 直方图，请求分布情况
*/
private Histogram reqLatencyHistogram;
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
instance = this;
CollectorRegistry collectorRegistry = applicationContext.getBean(CollectorRegistry.class);
// 这里指定SpringBoot容器的CollectorRegistry，如果使用默认的会导致无法收集
reqCounter = Counter.build().name("demo_rest_req_total").labelNames("path", "method", "code")
.help("总的请求计数").register(collectorRegistry);
duringReqGauge = Gauge.build()
.name("demo_rest_inprogress_req").labelNames("path", "method")
.help("正在处理的请求数").register(collectorRegistry);
reqLatencyHistogram = Histogram.build().labelNames("path", "method", "code")
.name("demo_rest_requests_latency_seconds_histogram").help("请求耗时分布")
.register(collectorRegistry);
}
public static PrometheusComponent getInstance() {
return instance;
}
public Counter counter() {
return reqCounter;
}
public Gauge gauge() {
return duringReqGauge;
}
public Histogram histogram() {
return reqLatencyHistogram;
}
}
注意上面的setApplicationContext()的方法实现逻辑，其中在创建Counter/Gauge/Histogram时，使用的是simpleclient包中提供的最基础的用法，并不是micrometer的封装方式，后面一篇博文会介绍到两种的差异性
上面实现的特点在于，创建Metric时，就已经定义好了label标签，这里定义了
接下来我们实现一个自定义的拦截器，拦截所有的http请求，然后上报关键信息
public class PrometheusInterceptor extends HandlerInterceptorAdapter {
private ThreadLocal<Histogram.Timer> timerThreadLocal = new ThreadLocal<>();
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
// 正在处理的请求量
PrometheusComponent.getInstance().gauge().labels(request.getRequestURI(), request.getMethod()).inc();
timerThreadLocal.set(PrometheusComponent.getInstance().histogram()
.labels(request.getRequestURI(), request.getMethod(), String.valueOf(response.getStatus()))
.startTimer());
return super.preHandle(request, response, handler);
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
String uri = request.getRequestURI();
String method = request.getMethod();
int status = response.getStatus();
// count 请求计数，标签分别为 请求路径，请求方法，response http code
// 请求应用总量: sum(demo_rest_req_total)
// 每秒http请求量: sum(rate(demo_rest_req_total[1m])
// 请求topk的url: topk(10, sum(demo_rest_req_total) by (path))
PrometheusComponent.getInstance().counter().labels(uri, method, String.valueOf(status)).inc();
// 请求完毕，计数器-1
PrometheusComponent.getInstance().gauge().labels(uri, method).dec();
// 直方图统计
Histogram.Timer timer = timerThreadLocal.get();
if (timer != null) {
timer.observeDuration();
timerThreadLocal.remove();
}
super.afterCompletion(request, response, handler, ex);
}
}
这里我们主要关心的就两点
preHandle）： gauge计数+1，开始计时afterCompletion)： guage计数-1，counter计数+1，计时收集最后我们需要注册上面的拦截器，并写个demo进行测试一下
@RestController
@SpringBootApplication
public class Application implements WebMvcConfigurer {
private Random random = new Random();
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new PrometheusInterceptor()).addPathPatterns("/**");
}
@GetMapping(path = "hello")
public String hello(String name) {
int sleep = random.nextInt(200);
try {
Thread.sleep(sleep);
} catch (InterruptedException e) {
e.printStackTrace();
}
return "hello sleep: " + sleep + " for " + name;
}
public static void main(String[] args) {
SpringApplication.run(Application.class);
}
@Bean
MeterRegistryCustomizer<MeterRegistry> configurer(@Value("\${spring.application.name}") String applicationName) {
return (registry) -> registry.config().commonTags("application", applicationName);
}
}
应用启动之后，访问几次hello的http接口，然后在查看一下metric信息，看是否有我们刚才上报的数据
这一篇博文算是上一篇的补全，若我们希望自定义上报一些信息，可以使用上面这种方式来支持
当然，上报并不代表结束，接下来配置大盘等信息也非常的关键，特别是直方图如何配置Grafana？怎么查看请求的耗时分布情况，就由下文来介绍了