快捷導(dǎo)航

SpringBoot實現(xiàn)自定義指標(biāo)監(jiān)控功能

更新時間：2024年01月30日 11:36:31 作者：summer_west_fish

本文主要介紹了SpringBoot實現(xiàn)自定義指標(biāo)監(jiān)控功能的實現(xiàn),,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,感興趣的小伙伴跟著著小編來一起來學(xué)習(xí)吧

一、添加業(yè)務(wù)監(jiān)控指標(biāo)

在 spring-web-prometheus-demo 項目的基礎(chǔ)上，我們添加一個 PrometheusCustomMonitor 類。在這里面我們定義了三個業(yè)務(wù)指標(biāo)：

order_request_count：下單總次數(shù)
order_amount_sum：下單總金額

@Component
public class PrometheusCustomMonitor {
 
    /**
     * 訂單發(fā)起次數(shù)
     */
    private Counter orderCount;
 
    /**
     * 金額統(tǒng)計
     */
    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", "order", "test-svc");
        amountSum = registry.summary("order_amount_sum", "orderAmount", "test-svc");
    }
 
    public Counter getOrderCount() {
        return orderCount;
    }
 
    public DistributionSummary getAmountSum() {
        return amountSum;
    }
}

二、模擬訂單數(shù)據(jù)

這里我們新增一個 TestController 類，去模擬現(xiàn)實的訂單數(shù)據(jù)。

后續(xù)應(yīng)用啟動后，我們可以通過 localhost:8080/order 去模擬用戶下單操作。

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
 
import javax.annotation.Resource;
import java.util.Random;
 
@RestController
public class TestController {
 
    @Resource
    private PrometheusCustomMonitor monitor;
 
    @RequestMapping("/order")
    public String order() throws Exception {
        // 統(tǒng)計下單次數(shù)
        monitor.getOrderCount().increment();
        Random random = new Random();
        int amount = random.nextInt(100);
        // 統(tǒng)計金額
        monitor.getAmountSum().record(amount);
        return "下單成功, 金額: " + amount;
    }
}

實際項目中，我們一般使用 AOP 的方式去實現(xiàn)業(yè)務(wù)指標(biāo)上報。這里為了簡單，直接寫在代碼里了。

三、啟動項目測試

現(xiàn)在我們啟動應(yīng)用，訪問 localhost:8080/order 可以成功模擬下單，每次都會有一個隨機的訂單金額產(chǎn)生。

此時我們訪問 localhost:8080/actuator/prometheus 就可以看到對應(yīng)的指標(biāo)已經(jīng)存在。

后續(xù)我們在 Grafana 中配置好相應(yīng)的圖表就可以看到對應(yīng)的業(yè)務(wù)指標(biāo)變化了。

四、配置Grafana圖表

這里我們一共配置四個圖表，分別是：

訂單總數(shù)
訂單支付總額
訂單數(shù)增長率
訂單支付金額增長率

1、配置訂單個數(shù)圖表

我們在原有面板上新建一個圖表（Panel），名稱命名為「訂單個數(shù)」，來統(tǒng)計所有的訂單數(shù)量。

在「數(shù)據(jù)配置區(qū)」中數(shù)據(jù)源選擇「Prometheus」，Metrics 填入「order_amount_sum_count」。

接著在「圖表設(shè)置區(qū)」的「Visualization」中選擇「Stat」類別，表示這是一個統(tǒng)計數(shù)值。

接著在「圖表設(shè)置區(qū)」的「Display」中的 Value 設(shè)置為「Last」，表示其值是取最后一個數(shù)值（因為這個數(shù)值是已經(jīng)統(tǒng)計好了的）。Fields 設(shè)置為「Numeric Fields」，表示其是一個數(shù)值字段。

2、配置訂單總額圖表

我們同樣在原有面板上新建一個圖表（Panel），名稱命名為「訂單金額」，來統(tǒng)計所有訂單的支付總金額。

在「數(shù)據(jù)配置區(qū)」中數(shù)據(jù)源選擇「Prometheus」，Metrics 填入「order_amount_sum_sum」。

接著在「圖表設(shè)置區(qū)」的「Visualization」中選擇「Stat」類別，表示這是一個統(tǒng)計數(shù)值。

接著在「圖表設(shè)置區(qū)」的「Display」中的 Value 設(shè)置為「Last」，表示其值是取最后一個數(shù)值（因為這個數(shù)值是已經(jīng)統(tǒng)計好了的）。Fields 設(shè)置為「Numeric Fields」，表示其是一個數(shù)值字段。