Dropwizard 初探

2015-04-08 Java Java 三方库评论

Setting Up Maven
Meters
Console Reporter
Complete getting started
The Registry
Gauges
Counters
Histograms
Timers
Health Checks
Reporting Via JMX
Reporting Via HTTP
Other Reporting

Setting Up Maven

在MAVEN的dependency里添加metrics-core库

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

注意，使用上面依赖你需要在pom文件里声明了metrics.version属性,并且该属性值是3.1.0

Meters

meter表示的是单位时间内事件数的比例(例如每秒请求数). 除了平均速率之外, meter仍然会追踪1-,5-,15-分钟的移动平均数.

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

public void handleRequest(Request request, Response response) {
    requests.mark();
    // etc
}

上面的meter表示每秒请求数的比例。

Console Reporter

Console Reporter正如其名,向控制台进行输出日志,下面的示例将每秒进行输出一次.

ConsoleReporter reporter = ConsoleReporter.forRegistry(metrics)
       .convertRatesTo(TimeUnit.SECONDS)
       .convertDurationsTo(TimeUnit.MILLISECONDS)
       .build();
   reporter.start(1, TimeUnit.SECONDS);

Complete getting started

下面是一个完整的示例：

  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) {}
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>somegroup</groupId>
  <artifactId>sample</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>Example project for Metrics</name>

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

注意：使用上面依赖你需要在pom文件里声明了metrics.version属性,并且该属性值是3.1.0

1	mvn package exec:java -Dexec.mainClass=sample.First

The Registry

Metrics的核心部分是MetricRegistry类,这个类是应用程序中所有的metrics的容器. 下面的示例创建一个新的MetricRegistry:

1	final MetricRegistry metrics = new MetricRegistry();

如果你在应用程序中嵌入一个自己创建的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();
                             }
                         });
    }
}

当完成计算之后,它将会返回队列里的任务数。

在registry里的每个metric都有一个唯一的名字,其命名规范为用.分割的字符串,例如things.count或者com.example.Thing.latency. MetricRegistry类提供了一个静态方法来构建这些名字.

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

上面的调用会返回com.example.QueueManager.jobs.size。

对于大多数队列或者类队列结构,你也许仅想要获得queue.size()这个值. 大多数java.util和java.util.concurrent包都实现了size()方法,它的复杂度是O(n),这意味着你的gauge也许会很慢(也许还会持有锁)

Counters

counter是一个内部采用AtomicLong计数器的gauge实现. 你可以增加或者减少这个值.例如,我们想要一种更加高效的计算队列大小的方式:

private final Counter pendingJobs = metrics.counter(name(QueueManager.class, "pending-jobs"));

public void addJob(Job job) {
    pendingJobs.inc();
    queue.offer(job);
}

public Job takeJob() {
    pendingJobs.dec();
    return queue.take();
}

每一次业务逻辑的调用，counter都会被计算一次,它会返回队列中的任务数.

正如你看到的,counter的API是非常不同的是,counter(String)取代了register(String, Metric)，然而你可以仍然可以使用register方法创建你自己的Counter实例,实际上counter(String)在内部里已经将这些工作都为你做好了,还允许你使用相同的名字对metric进行复用

还需要说明一点,在上例中,我们静态引入了MetricRegistry的name方法.

Histograms

histogram表示的是流中数据值的静态分布. 除了计算minimum, maximum, mean, etc等值,它还计算中间值或者75th, 90th, 95th, 98th, 99th, 99.9th等百分比.

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

public void handleRequest(Request request, Response response) {
    // etc
    responseSizes.update(response.getContent().length);
}

上面的histogram统计了响应中的字节数.

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();
    }
}

This timer will measure the amount of time it takes to process each request in nanoseconds and provide a rate of requests in requests per second.

Health Checks

Metrics还可以通过metrics-healthchecks模块集中检查你的服务的健康.

首先创建一个新的HealthCheckRegistry实例

final HealthCheckRegistry healthChecks = new HealthCheckRegistry();
Second, implement a HealthCheck subclass:

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());
        }
    }
}

然后将Metrics注册到它身上：

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

接下来运行所有的health checks:

final Map<String, HealthCheck.Resultresults = healthChecks.runHealthChecks();
for (Entry<String, HealthCheck.Resultentry : 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内置了一种health check：ThreadDeadlockHealthCheck,它使用了java内置的线程死锁检测来查找死锁线程.

Reporting Via JMX

通过JMX报告metrics：

1 2	final JmxReporter reporter = JmxReporter.forRegistry(registry).build(); reporter.start();

一旦reporter启动了,registry中的所有的metrics都可以通过JConsole或者VisualVM看到.

Metrics被包装成JMX MBeans,可以在VisualVM's MBeans browser查看Metrics.

注意：在VisualVM中，你双击任一metric属性,VisualVM将会将这些属性数据通过图形化的方式演示给你.

Reporting Via HTTP

Metrics仍然可以通过servlet(AdminServlet)演示给你, 提供JSON形式的数据. 它可以报告health checks,打印thread dump,或者提供一个负载均衡的简单响应. (它还提供了其他的servlets–MetricsServlet,例如HealthCheckServlet, ThreadDumpServlet或者PingServlet.)

如果想要使用servlet你必须在pom文件中依赖metrics-servlets.

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

Other Reporting

除了JMX和HTTP以外,Metrics还提供了下面的报告方式

STDOUT: 使用metrics-core的ConsoleReporter报告
CSV files, 使用metrics-core的CsvReporter报告
SLF4J loggers, 使用metrics-core的Slf4jReporter报告
Ganglia, 使用metrics-ganglia的GangliaReporter报告
Graphite, 使用metrics-graphite的GraphiteReporter报告

本文链接： https://wangmingco.github.io/2015/04/08/Java/lib/dropwizard/

版权声明： 本博客所有文章除特别声明外，均采用 CC BY 4.0 CN协议许可协议。转载请注明出处！

王明Coder

一个纯粹的技术开发者。