SpringBoot 使用Prometheus采集自定義指標(biāo)數(shù)據(jù)的方案

更新時(shí)間：2022年10月09日 11:11:56 作者：張志翔 ?

這篇文章主要介紹了SpringBoot 使用Prometheus采集自定義指標(biāo)數(shù)據(jù),我們?cè)趉8s集群成功搭建了Prometheus服務(wù)，今天，我們將在springboot2.x中使用prometheus記錄指標(biāo)，需要的朋友可以參考下

一、我們需要什么指標(biāo)

對(duì)于DDD、TDD等，大家比較熟悉了，但是對(duì)于MDD可能就比較陌生了。MDD是Metrics-Driven Development的縮寫(xiě)，主張開(kāi)發(fā)過(guò)程由指標(biāo)驅(qū)動(dòng)，通過(guò)實(shí)用指標(biāo)來(lái)驅(qū)動(dòng)快速、精確和細(xì)粒度的軟件迭代。MDD可使所有可以測(cè)量的東西都得到量化和優(yōu)化，進(jìn)而為整個(gè)開(kāi)發(fā)過(guò)程帶來(lái)可見(jiàn)性，幫助相關(guān)人員快速、準(zhǔn)確地作出決策，并在發(fā)生錯(cuò)誤時(shí)立即發(fā)現(xiàn)問(wèn)題并修復(fù)。依照MDD的理念，在需求階段就應(yīng)該考慮關(guān)鍵指標(biāo)，在應(yīng)用上線后通過(guò)指標(biāo)了解現(xiàn)狀并持續(xù)優(yōu)化。有一些基于指標(biāo)的方法論，建議大家了解一下：

Google的四大黃金指標(biāo)：延遲Latency、流量Traffic、錯(cuò)誤Errors、飽和度Saturation
Netflix的USE方法：使用率Utilization、飽和度Saturation、錯(cuò)誤Error
WeaveCloud的RED方法：速率Rate、錯(cuò)誤Errors、耗時(shí)Duration

二、在SrpingBoot中引入prometheus

SpringBoot2.x集成Prometheus非常簡(jiǎn)單，首先引入maven依賴：

io.micrometer
micrometer-registry-prometheus
1.7.3
io.github.mweirauch
micrometer-jvm-extras
0.2.2

然后，在application.properties中將prometheus的endpoint放出來(lái)。

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

接下來(lái)就可以進(jìn)行指標(biāo)埋點(diǎn)了，Prometheus的四種指標(biāo)類型此處不再贅述，請(qǐng)自行學(xué)習(xí)。一般指標(biāo)埋點(diǎn)代碼實(shí)現(xiàn)上有兩種形式：AOP、侵入式，建議盡量使用AOP記錄指標(biāo)，對(duì)于無(wú)法使用aop的場(chǎng)景就只能侵入代碼了。常用的AOP方式有：

@Aspect（通用）
HandlerInterceptor （SpringMVC的攔截器）
ClientHttpRequestInterceptor （RestTemplate的攔截器）
DubboFilter （dubbo接口）

我們選擇通用的@Aspect，結(jié)合自定義指標(biāo)注解來(lái)實(shí)現(xiàn)。首先自定義指標(biāo)注解：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MethodMetrics {
    String name() default "";
    String desc() default "";
    String[] tags() default {};
    //是否記錄時(shí)間間隔
    boolean withoutDuration() default false;
}

然后是切面實(shí)現(xiàn)：

@Aspect
public class PrometheusAnnotationAspect {
 
    @Autowired
    private MeterRegistry meterRegistry;
 
    @Pointcut("@annotation(com.smac.prometheus.annotation.MethodMetrics)")
    public void pointcut() {}
 
    @Around(value = "pointcut()")
    public Object process(ProceedingJoinPoint joinPoint) throws Throwable {
        Method targetMethod = ((MethodSignature) joinPoint.getSignature()).getMethod();
        Method currentMethod = ClassUtils.getUserClass(joinPoint.getTarget().getClass()).getDeclaredMethod(targetMethod.getName(), targetMethod.getParameterTypes());
        if (currentMethod.isAnnotationPresent(MethodMetrics.class)) {
            MethodMetrics methodMetrics = currentMethod.getAnnotation(MethodMetrics.class);
            return processMetric(joinPoint, currentMethod, methodMetrics);
        } else {
            return joinPoint.proceed();
        }
    }
 
    private Object processMetric(ProceedingJoinPoint joinPoint, Method currentMethod, MethodMetrics methodMetrics) {
        String name = methodMetrics.name();
        if (!StringUtils.hasText(name)) {
            name = currentMethod.getName();
        }
        String desc = methodMetrics.desc();
        if (!StringUtils.hasText(desc)) {
            desc = currentMethod.getName();
        }
        //不需要記錄時(shí)間
        if (methodMetrics.withoutDuration()) {
            Counter counter = Counter.builder(name).tags(methodMetrics.tags()).description(desc).register(meterRegistry);
            try {
                return joinPoint.proceed();
            } catch (Throwable e) {
                throw new IllegalStateException(e);
            } finally {
                counter.increment();
            }
        }
        //需要記錄時(shí)間（默認(rèn)）
        Timer timer = Timer.builder(name).tags(methodMetrics.tags()).description(desc).register(meterRegistry);
        return timer.record(() -> {
            try {
                return joinPoint.proceed();
            } catch (Throwable e) {
                throw new IllegalStateException(e);
            }
        });
    }
}

代碼很容易，沒(méi)什么可說(shuō)明的，接下來(lái)就是在需要記監(jiān)控的地方加上這個(gè)注解就行，比如：

@MethodMetrics(name="sms_send",tags = {"vendor","aliyun"})
public void send(String mobile, SendMessage message) throws Exception {
    ...
}

至此，aop形式的指標(biāo)實(shí)現(xiàn)方式就完成了。如果是侵入式的話，直接使用meterRegistry就行：

meterRegistry.counter("sms.send","vendor","aliyun").increment();

啟動(dòng)服務(wù)，打開(kāi)http://localhost:8080/actuator/prometheus查看指標(biāo)。

三、高級(jí)指標(biāo)之分位數(shù)

分位數(shù)(P50/P90/P95/P99)是我們常用的一個(gè)性能指標(biāo)，Prometheus提供了兩種解決方案：

client側(cè)計(jì)算方案

summery類型，設(shè)置percentiles，在本地計(jì)算出Pxx，作為指標(biāo)的一個(gè)tag被直接收集。

Timer timer = Timer.builder("sms.send").publishPercentiles(0.5, 0.9, 0.95,0.99).register(meterRegistry);
timer.record(costTime, TimeUnit.MILLISECONDS);

會(huì)出現(xiàn)四個(gè)帶quantile的指標(biāo)，如圖：

server側(cè)計(jì)算方案

開(kāi)啟histogram，將所有樣本放入buckets中，在server側(cè)通過(guò)histogram_quantile函數(shù)對(duì)buckets進(jìn)行實(shí)時(shí)計(jì)算得出。注意：histogram采用了線性插值法，buckets的劃分對(duì)誤差的影響比較大，需合理設(shè)置。

Timer timer = Timer.builder("sms.send")
                .publishPercentileHistogram(true)
                .serviceLevelObjectives(Duration.ofMillis(10),Duration.ofMillis(20),Duration.ofMillis(50))
                .minimumExpectedValue(Duration.ofMillis(1))
                .maximumExpectedValue(Duration.ofMillis(100))
                .register(meterRegistry);
timer.record(costTime, TimeUnit.MILLISECONDS);

會(huì)出現(xiàn)一堆xxxx_bucket的指標(biāo)，如圖：

然后，使用

histogram_quantile(0.95, rate(sms_send_seconds_bucket[5m]))

就可以看到P95的指標(biāo)了，如圖：

結(jié)論：

方案1適用于單機(jī)或只關(guān)心本地運(yùn)行情況的指標(biāo)，比如gc時(shí)間、定時(shí)任務(wù)執(zhí)行時(shí)間、本地緩存更新時(shí)間等；

方案2則適用于分布式環(huán)境下的整體運(yùn)行情況的指標(biāo)，比如搜索接口的響應(yīng)時(shí)間、第三方接口的響應(yīng)時(shí)間等。

到此這篇關(guān)于SpringBoot 使用Prometheus采集自定義指標(biāo)數(shù)據(jù)的文章就介紹到這了,更多相關(guān)SpringBoot采集自定義指標(biāo)數(shù)據(jù)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: