随着系统越来越大,越来越复杂,我们需要在业务方面加上一些监控服务。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
类完成自定义的报表类。