Metrics 入门文档翻译

作者:拔剑少年

简书地址://www.greatytc.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 依赖

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

注: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<Integer>() {
                             @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<String, HealthCheck.Result> results = healthChecks.runHealthChecks();
for (Entry<String, HealthCheck.Result> 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的内置线程死锁检测来确定是否有任何线程处于死锁状态。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,723评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,485评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,998评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,323评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,355评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,079评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,389评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,019评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,519评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,971评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,100评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,738评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,293评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,289评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,517评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,547评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,834评论 2 345

推荐阅读更多精彩内容