前言

本文基於設計開發一個應用功能監控專案的需求，其能在不入侵系統的情況下正常監控應用功能。調研之後選擇了prometheus+grafana+springboot2的方案。本文基於此簡單講述一下這幾個系統之間的配置、互動和使用。並從prometheus的功能，配置，使用，以及與dashboard和springboot/springcloud的整合等方面簡單分析，對於各單獨系統的安裝不在本文講述範圍之內。

一、prometheus

1.簡介

Prometheus，是一個開源的系統監控和告警的工具包，其採用Pull方式採集時間序列的度量資料（也支援push方式），通過Http協議傳輸。它的工作方式是被監控的服務需要公開一個

2.支援的prometheus metrics

Counter，Gauge，Histogram，Summary，不進行細節介紹了，後面會專門寫prometheus的文章。需要注意的是counter只能增不能減，適用於服務請求量，使用者訪問數等統計，但是如果需要統計有增有減的指標需要用Gauge。

3.支援的exporter很多，可以方便的監控很多應用，同時也可以自定義開發非官方提供的exporter。

二、grafana

1.簡介

grafana，是一個開源的dashboard展示工具，可以支援很多主流資料來源，包括時序性的和非時序性的。其提供的展示配置以及可擴充套件效能滿足絕大部分時間序列資料展示需求，是一個比較優秀的工具。

2.支援的資料來源

prometheus，inflexdb，elasticsearch，mysql，postgreSQL，openTSDB等，更多資料來源

三、springboot2與prometheus的整合

1.springboot整合配置

springboot2.x與prometheus的整合與springboot1.x區別比較大。prometheus官方提供的Java client不能支援2.x的處理。很多其中呼叫的class都找不到了。所以在2.x中 simpleclient_spring_boot就不起作用了，啟動會報錯。幸好開源工具包io.micrometer提供了2.x中對prometheus採集端點的支援。所以在依賴中新增以下配置（使用gradle作為編譯工具）：

compile group: 'io.micrometer', name: 'micrometer-registry-prometheus', version: '1.0.6'

另外springboot2.x中提供了actuator作為採集exporter，為prometheus暴露採集端點，只需要在專案依賴中新增以下配置即可：

compile('org.springframework.boot:spring-boot-starter-actuator')

完成之後就可以在springboot專案中自定義採集樣本和方式了。

同時在配置檔案application.yaml中要增加如下配置

management:
    security:
# 僅限於 開發環境可對security進行關閉。
        enabled: false
    metrics:
        export:
            prometheus:
                enabled: true
                step: 1m
                descriptions: true
    web:
        server:
            auto-time-requests: true
    endpoints:
        prometheus:
            id: springmetrics
        web:
            exposure:
                include:         health,info,env,prometheus,metrics,httptrace,threaddump,heapdump,springmetrics

配置完成之後即可在啟動應用之後通過host:port/actuator/prometheus 訪問採集資訊

之後在prometheus的配置檔案prometheus.yml中新增scrape_configs:

- job_name: 'demo'
    metrics_path: /actuator/prometheus
    static_configs:
    - targets: ['localhost:9009']

即可與prometheus建立聯絡。之後就可以在grafana中配置prometheus的資料來源進行監控展示。

2.整合框架

micrometer提供了基於Java的monitor facade，其與springboot應用和prometheus的整合方式如下圖展示

上圖中展示的很清楚，應用通過micrometer採集和暴露監控端點給prometheus，prometheus通過pull模式來採集監控時序資料資訊。之後作為資料來源提供給grafana進行展示。

3.micrometer支援的度量方式及在springboot中的應用示例

• Counter

Counter(計數器)簡單理解就是一種只增不減的計數器。它通常用於記錄服務的請求數量、完成的任務數量、錯誤的發生數量等等。

@Service("collectorService")
public class CollectorService {
   
    static final Counter userCounter = Metrics.
            counter("user.counter.total", "services", "demo");
    
    public void processCollectResult() throws InterruptedException {

        while (true){
            
             userCounter.increment(1D);

        }

    }
}

• Gauge

Gauge(儀表)是一個表示單個數值的度量，它可以表示任意地上下移動的數值測量。Gauge通常用於變動的測量值，如當前的記憶體使用情況，同時也可以測量上下移動的"計數"，比如佇列中的訊息數量

@Component("passCaseMetric")
public class PassCaseMetric {

    List<Tag> init(){
        ArrayList<Tag> list = new ArrayList(){};
        list.add(new ImmutableTag("service", "demo"));
        return list;
    }

    AtomicInteger atomicInteger = new AtomicInteger(0);

    Gauge passCaseGuage = Gauge.builder("pass.cases.guage", atomicInteger, AtomicInteger::get)
            .tag("service", "demo")
            .description("pass cases guage of demo")
            .register(new SimpleMeterRegistry());


    AtomicInteger passCases =  Metrics.gauge("pass.cases.guage.value", init(), atomicInteger);

    public void handleMetrics() {

        while (true){
            if (System.currentTimeMillis() % 2 == 0){
                passCases.addAndGet(100);
                System.out.println("ADD + " + passCaseGuage.measure() + " : " + passCases);
            }else {
                int val = passCases.addAndGet(-100);
                if (val < 0){
                    passCases.set(1);
                }
                System.out.println("DECR - " + passCaseGuage.measure() + " : " + passCases);
            }
        }

    }

}

這裡使用了一個true的迴圈用來展示不斷更新的效果。

同樣的可以在grafana中看到監控展示資訊

• Timer

Timer(計時器)同時測量一個特定的程式碼邏輯塊的呼叫(執行)速度和它的時間分佈。簡單來說，就是在呼叫結束的時間點記錄整個呼叫塊執行的總時間，適用於測量短時間執行的事件的耗時分佈，例如訊息佇列訊息的消費速率。

    @Test
    public void testTimerSample(){
        Timer timer = Timer.builder("timer")
                .tag("timer", "timersample")
                .description("timer sample test.")
                .register(new SimpleMeterRegistry());

        for(int i=0; i<2; i++) {
            timer.record(() -> {
                try {
                    TimeUnit.SECONDS.sleep(2);
                }catch (InterruptedException e){

                }

            });
        }

        System.out.println(timer.count());
        System.out.println(timer.measure());
        System.out.println(timer.totalTime(TimeUnit.SECONDS));
        System.out.println(timer.mean(TimeUnit.SECONDS));
        System.out.println(timer.max(TimeUnit.SECONDS));
    }

響應資料

2
[Measurement{statistic='COUNT', value=2.0}, Measurement{statistic='TOTAL_TIME', value=4.005095763}, Measurement{statistic='MAX', value=2.004500494}]
4.005095763
2.0025478815
2.004500494

• Summary

Summary(摘要)用於跟蹤事件的分佈。它類似於一個計時器，但更一般的情況是，它的大小並不一定是一段時間的測量值。在micrometer中，對應的類是DistributionSummary，它的用法有點像Timer，但是記錄的值是需要直接指定，而不是通過測量一個任務的執行時間。

    @Test
    public void testSummary(){

        DistributionSummary summary = DistributionSummary.builder("summary")
                .tag("summary", "summarySample")
                .description("summary sample test")
                .register(new SimpleMeterRegistry());

        summary.record(2D);
        summary.record(3D);
        summary.record(4D);

        System.out.println(summary.count());
        System.out.println(summary.measure());
        System.out.println(summary.max());
        System.out.println(summary.mean());
        System.out.println(summary.totalAmount());
    }

響應資料：

3
[Measurement{statistic='COUNT', value=3.0}, Measurement{statistic='TOTAL', value=9.0}, Measurement{statistic='MAX', value=4.0}]
4.0
3.0
9.0

後記

本文從prometheus、grafana與springboot2.x的整合，配置和應用開發使用方面進行了介紹。對於細節方面以及使用中遇到的一些問題，我會再開文章繼續補充。文中部分內容有參考其他博文以及官方文件，如有不妥請及時指出。共同學習。

refer links：