Spring Boot實踐---JVM上的實時監控類庫：Metrics

時間 2019-11-12

標籤 spring boot 實踐 jvm 實時監控 metrics 欄目 Spring 简体版

原文原文鏈接

1、使用Metrics

系統開發到必定的階段，線上的機器愈來愈多，就須要一些監控了，除了服務器的監控，業務方面也須要一些監控服務。Metrics做爲一款監控指標的度量類庫，提供了許多工具幫助開發者來完成自定義的監控工做。java

經過構建一個Spring Boot的基本應用來演示Metrics的工做方式。web

在Maven的pom.xml中引入Metrics：spring

<dependency>
    <groupId>io.dropwizard.metrics</groupId>
    <artifactId>metrics-core</artifactId>
    <version>${metrics.version}</version>
</dependency>

目前Metrics的最新版本是3.1.2。緩存

2、Metrics的基本工具

Metrics提供了五個基本的度量類型：服務器

Gauges（度量）
Counters（計數器）
Histograms（直方圖數據）
Meters（TPS計算器）
Timers（計時器）

Metrics中MetricRegistry是中心容器，它是程序中全部度量的容器，全部新的度量工具都要註冊到一個MetricRegistry實例中才可使用，儘可能在一個應用中保持讓這個MetricRegistry實例保持單例。網絡

2.1 MetricRegistry 容器

在代碼中配置好這個MetricRegistry容器：app

@Bean
public MetricRegistry metrics() {
    return new MetricRegistry();
}

2.2 Meters TPS計算器

TPS計算器這個名稱並不許確，Meters工具會幫助咱們統計系統中某一個事件的速率。好比每秒請求數（TPS），每秒查詢數（QPS）等等。這個指標能反應系統當前的處理能力，幫助咱們判斷資源是否已經不足。Meters自己是一個自增計數器。dom

經過MetricRegistry能夠得到一個Meter：ide

@Bean
public Meter requestMeter(MetricRegistry metrics) {
    return metrics.meter("request");
}

在請求中調用mark()方法，來增長計數，咱們能夠在不一樣的請求中添加不一樣的Meter，針對本身的系統完成定製的監控需求。工具

@RequestMapping("/hello")
@ResponseBody
public String helloWorld() {
    requestMeter.mark();
    return "Hello World";
}

應用運行的過程當中，在console中反饋的信息：

-- Meters ----------------------------------------------------------------------
request
             count = 21055
         mean rate = 133.35 events/second
     1-minute rate = 121.66 events/second
     5-minute rate = 36.99 events/second
    15-minute rate = 13.33 events/second

從以上信息中能夠看出Meter能夠爲咱們提供平均速率，以及採樣後的1分鐘，5分鐘，15分鐘的速率。

2.3 Histogram 直方圖數據

直方圖是一種很是常見的統計圖表，Metrics經過這個Histogram這個度量類型提供了一些方便實時繪製直方圖的數據。

和以前的Meter相同，咱們能夠經過MetricRegistry來得到一個Histogram。

@Bean
public Histogram responseSizes(MetricRegistry metrics) {
    return metrics.histogram("response-sizes");
}

在應用中，須要統計的位置調用Histogram的update()方法。

responseSizes.update(new Random().nextInt(10));

好比咱們須要統計某個方法的網絡流量，經過Histogram就很是的方便。

在console中Histogram反饋的信息：

-- Histograms ------------------------------------------------------------------
response-sizes
             count = 21051
               min = 0
               max = 9
              mean = 4.55
            stddev = 2.88
            median = 4.00
              75% <= 7.00
              95% <= 9.00
              98% <= 9.00
              99% <= 9.00
            99.9% <= 9.00

Histogram爲咱們提供了最大值，最小值和平均值等數據，利用這些數據，咱們就能夠開始繪製自定義的直方圖了。

2.4 Counter 計數器

Counter的本質就是一個AtomicLong實例，能夠增長或者減小值，能夠用它來統計隊列中Job的總數。

經過MetricRegistry也能夠得到一個Counter實例。

@Bean
public Counter pendingJobs(MetricRegistry metrics) {
    return metrics.counter("requestCount");
}

在須要統計數據的位置調用inc()和dec()方法。

// 增長計數
pendingJobs.inc();
// 減去計數
pendingJobs.dec();

console的輸出很是簡單：

-- Counters --------------------------------------------------------------------
requestCount
             count = 21051

只是輸出了當前度量的值。

2.5 Timer 計時器

Timer是一個Meter和Histogram的組合。這個度量單位能夠比較方便地統計請求的速率和處理時間。對於接口中調用的延遲等信息的統計就比較方便了。若是發現一個方法的RPS（請求速率）很低，並且平均的處理時間很長，那麼這個方法八成出問題了。

一樣，經過MetricRegistry獲取一個Timer的實例：

@Bean
public Timer responses(MetricRegistry metrics) {
    return metrics.timer("executeTime");
}

在須要統計信息的位置使用這樣的代碼：

final Timer.Context context = responses.time();
try {
    // handle request
} finally {
    context.stop();
}

console中就會實時返回這個Timer的信息：

-- Timers ----------------------------------------------------------------------
executeTime
             count = 21061
         mean rate = 133.39 calls/second
     1-minute rate = 122.22 calls/second
     5-minute rate = 37.11 calls/second
    15-minute rate = 13.37 calls/second
               min = 0.00 milliseconds
               max = 0.01 milliseconds
              mean = 0.00 milliseconds
            stddev = 0.00 milliseconds
            median = 0.00 milliseconds
              75% <= 0.00 milliseconds
              95% <= 0.00 milliseconds
              98% <= 0.00 milliseconds
              99% <= 0.00 milliseconds
            99.9% <= 0.01 milliseconds

2.6 Gauges 度量

除了Metrics提供的幾個度量類型，咱們能夠經過Gauges完成自定義的度量類型。比方說很簡單的，咱們想看咱們緩存裏面的數據大小，就能夠本身定義一個Gauges。

metrics.register(
                MetricRegistry.name(ListManager.class, "cache", "size"),
                (Gauge<Integer>) () -> cache.size()
        );

這樣Metrics就會一直監控Cache的大小。

除此以外有時候，咱們須要計算本身定義的一直單位，好比消息隊列裏面消費者(consumers)消費的速率和生產者(producers)的生產速率的比例，這也是一個度量。

public class CompareRatio extends RatioGauge {

    private final Meter consumers;
    private final Meter producers;

    public CacheHitRatio(Meter consumers, Meter producers) {
        this.consumers = consumers;
        this.producers = producers;
    }

    @Override
    protected Ratio getRatio() {
        return Ratio.of(consumers.getOneMinuteRate(),
                producers.getOneMinuteRate());
    }
}

把這個類也註冊到Metrics容器裏面：

@Bean
public CompareRatio cacheHitRatio(MetricRegistry metrics, Meter requestMeter, Meter producers) {

    CompareRatio compareRatio = new CompareRatio(consumers, producers);

    metrics.register("生產者消費者比率", compareRatio);

    return cacheHitRatio;
}

3、Reporter 報表

Metrics經過報表，將採集的數據展示到不一樣的位置,這裏好比咱們註冊一個ConsoleReporter到MetricRegistry中，那麼console中就會打印出對應的信息。

@Bean
public ConsoleReporter consoleReporter(MetricRegistry metrics) {
    return ConsoleReporter.forRegistry(metrics)
            .convertRatesTo(TimeUnit.SECONDS)
            .convertDurationsTo(TimeUnit.MILLISECONDS)
            .build();
}

除此以外Metrics還支持JMX、HTTP、Slf4j等等，能夠訪問 http://metrics.dropwizard.io/3.1.0/manual/core/#reporters 來查看Metrics提供的報表，若是仍是不能知足本身的業務，也能夠本身繼承Metrics提供的ScheduledReporter類完成自定義的報表類。

4、完整的代碼

這個demo是在一個很簡單的spring boot下運行的，關鍵的幾個類完整代碼以下。

配置類MetricConfig.java

package demo.metrics.config;

import com.codahale.metrics.*;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.concurrent.TimeUnit;

@Configuration
public class MetricConfig {

    @Bean
    public MetricRegistry metrics() {
        return new MetricRegistry();
    }

    /**
     * Reporter 數據的展示位置
     *
     * @param metrics
     * @return
     */
    @Bean
    public ConsoleReporter consoleReporter(MetricRegistry metrics) {
        return ConsoleReporter.forRegistry(metrics)
                .convertRatesTo(TimeUnit.SECONDS)
                .convertDurationsTo(TimeUnit.MILLISECONDS)
                .build();
    }

    @Bean
    public Slf4jReporter slf4jReporter(MetricRegistry metrics) {
        return Slf4jReporter.forRegistry(metrics)
                .outputTo(LoggerFactory.getLogger("demo.metrics"))
                .convertRatesTo(TimeUnit.SECONDS)
                .convertDurationsTo(TimeUnit.MILLISECONDS)
                .build();
    }

    @Bean
    public JmxReporter jmxReporter(MetricRegistry metrics) {
        return JmxReporter.forRegistry(metrics).build();
    }

    /**
     * 自定義單位
     *
     * @param metrics
     * @return
     */
    @Bean
    public ListManager listManager(MetricRegistry metrics) {
        return new ListManager(metrics);
    }

    /**
     * TPS 計算器
     *
     * @param metrics
     * @return
     */
    @Bean
    public Meter requestMeter(MetricRegistry metrics) {
        return metrics.meter("request");
    }

    /**
     * 直方圖
     *
     * @param metrics
     * @return
     */
    @Bean
    public Histogram responseSizes(MetricRegistry metrics) {
        return metrics.histogram("response-sizes");
    }

    /**
     * 計數器
     *
     * @param metrics
     * @return
     */
    @Bean
    public Counter pendingJobs(MetricRegistry metrics) {
        return metrics.counter("requestCount");
    }

    /**
     * 計時器
     *
     * @param metrics
     * @return
     */
    @Bean
    public Timer responses(MetricRegistry metrics) {
        return metrics.timer("executeTime");
    }

}

接收請求的類MainController.java

package demo.metrics.action;

import com.codahale.metrics.Counter;
import com.codahale.metrics.Histogram;
import com.codahale.metrics.Meter;
import com.codahale.metrics.Timer;
import demo.metrics.config.ListManager;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.Random;

@Controller
@RequestMapping("/")
public class MainController {

    @Autowired
    private Meter requestMeter;

    @Autowired
    private Histogram responseSizes;

    @Autowired
    private Counter pendingJobs;

    @Autowired
    private Timer responses;

    @Autowired
    private ListManager listManager;

    @RequestMapping("/hello")
    @ResponseBody
    public String helloWorld() {

        requestMeter.mark();

        pendingJobs.inc();

        responseSizes.update(new Random().nextInt(10));

        listManager.getList().add(1);

        final Timer.Context context = responses.time();
        try {
            return "Hello World";
        } finally {
            context.stop();
        }
    }
}

項目啓動類DemoApplication.java：

package demo.metrics;

import com.codahale.metrics.ConsoleReporter;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;

import java.util.concurrent.TimeUnit;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        ApplicationContext ctx = SpringApplication.run(DemoApplication.class, args);

        // 啓動Reporter
        ConsoleReporter reporter = ctx.getBean(ConsoleReporter.class);
        reporter.start(1, TimeUnit.SECONDS);
    }
}