java metrics 简书_Metrics 入门文档翻译

作者：拔剑少年

简书地址：https://www.jianshu.com/u/dad4d9675892

博客地址：https://it18monkey.github.io

转载请注明出处

Metrics 是一个Java库，它让您对代码在生产中所做的事情有了无与伦比的洞察力。

Metrics 提供了一种强大的工具集用于度量生产环境中关键组件的行为。

对于常见的库，如Jetty、Logback、Log4j、Apache HttpClient、Ehcache、JDBI、Jersey和像Ganglia和Graphite等报告后端，Metrics 提供了全栈的可见性。

metric核心：

主要类：Metric registries.

Metrics 主要有五种度量类型 ：Gauges, Counters,Histograms, Meters, and Timers.

汇报方式：JMX, theconsole, CSV files, andSLF4J loggers.

首先，我们通过在现有程序中添加Metrics的方式来认识和学会使用Metrics。

添加Maven 依赖

io.dropwizard.metrics

metrics-core

${metrics.version}

注：metrics.version 填写最新版本。当前版本3.2.3

Meters

Meter用来测量事件的速率(比如每秒的请求等)，除了平均速率，Meters也可以追踪1-5-15分钟的移(或流、滑)动平均数

private final MetricRegistry metrics = new MetricRegistry();

private final Meter requests = metrics.meter("requests");

public void handleRequest(Request request, Response response) {

requests.mark();

// etc

}

Meters 将会测量每秒请求的速率。

Console Reporter

Console Reporter 顾名思义是用来汇报到控制台的。下面的示例将会每秒打印一次

ConsoleReporter reporter = ConsoleReporter.forRegistry(metrics)

.convertRatesTo(TimeUnit.SECONDS)

.convertDurationsTo(TimeUnit.MILLISECONDS)

.build();

reporter.start(1, TimeUnit.SECONDS);

完整代码：

package sample;

import com.codahale.metrics.*;

import java.util.concurrent.TimeUnit;

public class GetStarted {

static final MetricRegistry metrics = new MetricRegistry();

public static void main(String args[]) {

startReport();

Meter requests = metrics.meter("requests");

requests.mark();

wait5Seconds();

}

static void startReport() {

ConsoleReporter reporter = ConsoleReporter.forRegistry(metrics)

.convertRatesTo(TimeUnit.SECONDS)

.convertDurationsTo(TimeUnit.MILLISECONDS)

.build();

reporter.start(1, TimeUnit.SECONDS);

}

static void wait5Seconds() {

try {

Thread.sleep(5*1000);

}

catch(InterruptedException e) {}

}

}

Registry

Metrics的中心是MetricRegistry 类，它是你程序中所有metric的容器。所以程序一开始就创建了一个

static final MetricRegistry metrics = new MetricRegistry();

Gauges

gauge可一用来实时测量一个值。举个例子，我们可能想要测量一个阻塞队列的大小。

public class QueueManager {

private final Queue queue;

public QueueManager(MetricRegistry metrics, String name) {

this.queue = new Queue();

metrics.register(MetricRegistry.name(QueueManager.class, name, "size"),

new Gauge() {

@Override

public Integer getValue() {

return queue.size();

}

});

}

}

当这个gauge被测量的时候将会返回队列的大小。

注：对于大多数队列或类似队列的数据结构来说，你可能不会想简单的返回queue.size().因为这个方法的大多数实现都是O(n)的，哪可能会导致gague变得非常慢(可能还会有锁问题)

每个注册的metric都有一个唯一的名称，仅仅是一个分隔的字符串像是“things.count”或“com.example.Thing.latency”。MetriRegistry提供了一个静态方法来生成这些名称。

MetricRegistry.name(QueueManager.class, "jobs", "size")

它会返回一个类似“com.example.QueueManager.jobs.size”的字符串。

Counters

counter 是gauge的原子级别实现

Histograms

hostogram 度量数据流中的值的统计分布。除了最小值、最大值、平均值等，它还测量了中位数、75、90、95、98、99和99.9%。

private final Histogram responseSizes = metrics.histogram(name(RequestHandler.class, "response-sizes"));

public void handleRequest(Request request, Response response) {

// etc

responseSizes.update(response.getContent().length);

}

上面的histograms 将会度量响应的字节长度。

Timers

timer 度量特定代码段的速率和其持续时间的分布。

private final Timer responses = metrics.timer(name(RequestHandler.class, "responses"));

public String handleRequest(Request request, Response response) {

final Timer.Context context = responses.time();

try {

// etc;

return "OK";

} finally {

context.stop();

}

}

这个timer 将会度量每个请求的执行时间并且提供每秒请求的速率。

Health Checks

metrics 也可以通过metrics-healthchecks模块集中检测服务的健康状况

首先，创建一个新的HealthCheckRegistry实例：

final HealthCheckRegistry healthChecks = new HealthCheckRegistry();

第二步，实现一个healthcheck子类

public class DatabaseHealthCheck extends HealthCheck {

private final Database database;

public DatabaseHealthCheck(Database database) {

this.database = database;

}

@Override

public HealthCheck.Result check() throws Exception {

if (database.isConnected()) {

return HealthCheck.Result.healthy();

} else {

return HealthCheck.Result.unhealthy("Cannot connect to " + database.getUrl());

}

}

}

然后注册一个实例到之前创建的healthChecks 上。

healthChecks.register("postgres", new DatabaseHealthCheck(database));

运行所有已注册的健康检查：

final Map results = healthChecks.runHealthChecks();

for (Entry entry : results.entrySet()) {

if (entry.getValue().isHealthy()) {

System.out.println(entry.getKey() + " is healthy");

} else {

System.err.println(entry.getKey() + " is UNHEALTHY: " + entry.getValue().getMessage());

final Throwable e = entry.getValue().getError();

if (e != null) {

e.printStackTrace();

}

}

}

Metrics 附带一个预先构建的健康检查:ThreadDeadlockHealthCheck，它使用Java的内置线程死锁检测来确定是否有任何线程处于死锁状态。