隨着系統越來越大,越來越復雜,我們需要在業務方面加上一些監控服務。Metrics
作為一款監控指標
的度量類庫,提供了許多工具幫助開發者來完成自定義的監控工作。
使用Metrics
使用Metrics,只需要在pom文件里面加入一下依賴:
<dependency> <groupId>io.dropwizard.metrics</groupId> <artifactId>metrics-core</artifactId> <version>3.1.2</version> </dependency>
Metrics的基本工具
Metrics
提供了五個基本的度量類型:
1.Gauges(度量)
2.Counters(計數器)
3.Histograms(直方圖數據)
4.Meters(TPS計算器)
5.Timers(計時器)
Metrics
中MetricRegistry
是中心容器,它是程序中所有度量的容器,所有新的度量工具都要注冊到一個MetricRegistry
實例中才可以使用,盡量在一個應用中保持讓這個MetricRegistry
實例保持單例。
MetricRegistry 容器
在代碼中配置好這個MetricRegistry
容器:
@Bean public MetricRegistry metrics() { return new MetricRegistry(); }
Meters TPS計算器
Meters
工具會幫助我們統計系統中某一個事件的速率。比如每秒請求數(TPS),每秒查詢數(QPS)等等。這個指標能反應系統當前的處理能力,幫助我們判斷資源是否已經不足。Meters
本身是一個自增計數器。
通過MetricRegistry
可以獲得一個Meter
:
@Bean public Meter requestMeter(MetricRegistry metrics) { return metrics.meter("request"); }
在請求中調用mark()
方法,來增加計數,我們可以在不同的請求中添加不同的Meter
,針對自己的系統完成定制的監控需求。
@RequestMapping("/hello") @ResponseBody public String helloWorld() { requestMeter.mark(); return "Hello World"; }
Histogram 直方圖數據
直方圖是一種非常常見的統計圖表,Metrics
通過這個Histogram
這個度量類型提供了一些方便實時繪制直方圖的數據。比如我們需要統計某個方法的網絡流量,通過Histogram
就非常的方便。Histogram
為我們提供了最大值,最小值和平均值等數據,利用這些數據,我們就可以開始繪制自定義的直方圖了。
和之前的Meter
相同,我們可以通過MetricRegistry
來獲得一個Histogram
。
@Bean public Histogram responseSizes(MetricRegistry metrics) { return metrics.histogram("response-sizes"); }
在應用中,需要統計的位置調用Histogram
的update()
方法。
responseSizes.update(new Random().nextInt(10));
Counter 計數器
Counter
的本質就是一個AtomicLong
實例,可以增加或者減少值,可以用它來統計隊列中Job的總數。通過MetricRegistry
也可以獲得一個Counter
實例。
@Bean public Counter pendingJobs(MetricRegistry metrics) { return metrics.counter("requestCount"); }
在需要統計數據的位置調用inc()
和dec()
方法。
// 增加計數 pendingJobs.inc(); // 減去計數 pendingJobs.dec();
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(); }
Gauges 度量
除了Metrics
提供的幾個度量類型,我們可以通過Gauges
完成自定義的度量類型。比方說很簡單的,我們想看我們緩存里面的數據大小,就可以自己定義一個Gauges
。
metrics.register( MetricRegistry.name(ListManager.class, "cache", "size"), (Gauge<Integer>) () -> cache.size() );
這樣Metrics
就會一直監控Cache
的大小。
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
類完成自定義的報表類。