Prometheus实现自定义指标监控

news2024/10/6 16:16:31

1、Prometheus实现自定义指标监控

前面我们已经通过 Prometheus+Grafana 实现了监控，可以在 Grafana 上看到对应的 SpringBoot 应用信息了，

通过这些信息我们可以对 SpringBoot 应用有更全面的监控。

在这里插入图片描述

但是如果我们需要对一些业务指标做监控，我们应该怎么做呢？这篇文章就带你一步步实现一个模拟的订单业务指

标监控。

假设我们有一个订单系统，我们需要监控它的实时订单总额、10 分钟内的下单失败率、请求失败数。那么我们应

该怎么做呢?

1.1 添加业务监控指标

在 spring-web-prometheus-demo 项目的基础上，我们添加一个 PrometheusCustomMonitor 类。在这里面我

们定义了三个业务指标：

order_request_count：下单总次数
order_amount_sum：下单总金额

package com.example;

import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.DistributionSummary;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;

/**
 * @author zhangshixing
 * @date 2022年03月16日 15:23
 */
@Component
public class PrometheusCustomMonitor {

    /**
     * 订单发起次数
     */
    private Counter orderCount;

    /**
     * 金额统计
     */
    private DistributionSummary amountSum;

    private final MeterRegistry registry;

    @Autowired
    public PrometheusCustomMonitor(MeterRegistry registry) {
        this.registry = registry;
    }

    @PostConstruct
    private void init() {
        orderCount = registry.counter("order_request_count", "orderCount", "test-svc");
        amountSum = registry.summary("order_amount_sum", "orderAmount", "test-svc");
    }

    public Counter getOrderCount() {
        return orderCount;
    }

    public DistributionSummary getAmountSum() {
        return amountSum;
    }
}

1.2 模拟订单数据

这里我们新增一个 TestController 类，去模拟现实的订单数据。

后续应用启动后，我们可以通过 localhost:8080/order 去模拟用户下单操作。

package com.example;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import java.util.Random;

/**
 * @author zhangshixing
 * @date 2022年03月16日 15:25
 */
@RestController
public class TestController {

    @Resource
    private PrometheusCustomMonitor monitor;

    @RequestMapping("/order")
    public String order() throws Exception {
        // 统计下单次数
        monitor.getOrderCount().increment();
        Random random = new Random();
        int amount = random.nextInt(100);
        // 统计金额
        monitor.getAmountSum().record(amount);
        return "下单成功, 金额: " + amount;
    }
}

实际项目中，我们一般使用 AOP 的方式去实现业务指标上报。这里为了简单，直接写在代码里了。

如果只显示自己定义的指标，配置文件需要配置：

management.endpoint.metrics.enabled=true
management.endpoints.web.exposure.include=*
management.endpoint.prometheus.enabled=true
management.metrics.export.prometheus.enabled=true
management.metrics.enable.jvm = false
management.metrics.enable.tomcat = false
management.metrics.enable.logback = false
management.metrics.enable.process = false
management.metrics.enable.executor = false
management.metrics.enable.http = false
management.metrics.enable.system = false
management.metrics.enable.disk = false
management.metrics.enable.application = false