Metrics (metrics module 1.0.0.CR4 API)

java.lang.Object
- org.jooby.metrics.Metrics

All Implemented Interfaces:

Jooby.Module
```
public class Metrics
extends Object
implements Jooby.Module
```
metrics

Metrics provides a powerful toolkit of ways to measure the behavior of critical components in your production environment.

usage
```
 {
   use(new Metrics()
      .request()
      .threadDump()
      .ping()
      .healthCheck("db", new DatabaseHealthCheck())
      .metric("memory", new MemoryUsageGaugeSet())
      .metric("threads", new ThreadStatesGaugeSet())
      .metric("gc", new GarbageCollectorMetricSet())
      .metric("fs", new FileDescriptorRatioGauge())
      );
 }
 
```
Let's see what all these means.

metrics

Metrics are available at /sys/metrics or /sys/metrics/:type via:
```
   use(new Metrics()
      .metric("memory", new MemoryUsageGaugeSet())
      .metric("threads", new ThreadStatesGaugeSet())
      .metric("gc", new GarbageCollectorMetricSet())
      .metric("fs", new FileDescriptorRatioGauge()));
 
```
The /:type parameter is optional and let you filter metrics by type counters, guages, etc..

There is a name filter too: /sys/metrics?name=memory or /sys/metrics/guages?name=memory. The name parameter filter all the metrics where the name starts with the given name.

health checks

Health checks are available at /sys/healthCheck via:
```
   use(new Metrics()
      .healthCheck("db", new DatabaseHealthCheck()));
 
```
instrumented requests

Captures request information (like active requests or min/mean/max execution time) and a breakdown of the response codes being returned: InstrumentedHandler.
```
   use(new Metrics()
      .request());
 
```
thread dump

A thread dump is available at /sys/threadDump via:
```
   use(new Metrics()
      .threadDump());
 
```
reporting

Reporters are appended via a callback API:
```
   {
     use(new Metrics()
        .reporter(registry  -> {
          ConsoleReporter reporter = ConsoleReporter.forRegistry(registry).build();
          reporter.start(1, TimeUnit.MINUTES);
          return reporter;
        });
   }
 
```
You can add all the reporters you want. Keep in mind you have to start them (if need it), but you don't have to stop them as long they implements the Closeable interface.

That's all folks!
Since:

0.13.0

Author:

edgar

Constructor Summary

Constructors
Constructor and Description
`Metrics()` Creates a new `Metric` module.
`Metrics(com.codahale.metrics.MetricRegistry registry)` Creates a new `Metric` module.
`Metrics(com.codahale.metrics.MetricRegistry registry, String pattern)` Creates a new `Metric` module.
`Metrics(String pattern)` Creates a new `Metric` module.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`configure(Env env, com.typesafe.config.Config conf, com.google.inject.Binder binder)`
`<H extends com.codahale.metrics.health.HealthCheck> Metrics`	`healthCheck(String name, Class<H> check)` Append a health check to the `HealthCheckRegistry`.
`Metrics`	`healthCheck(String name, com.codahale.metrics.health.HealthCheck check)` Append a health check to the `HealthCheckRegistry`.
`<M extends com.codahale.metrics.Metric> Metrics`	`metric(String name, Class<M> metric)` Append a metric to the `MetricRegistry`.
`Metrics`	`metric(String name, com.codahale.metrics.Metric metric)` Append a metric to the `MetricRegistry`, this call is identical to `MetricRegistry.register(String, Metric)`.
`Metrics`	`ping()` Append a simple ping handler that results in a `200` responses with a `pong` body.
`Metrics`	`reporter(BiFunction<com.codahale.metrics.MetricRegistry,com.typesafe.config.Config,com.codahale.metrics.Reporter> callback)` Append a `Reporter` to the `MetricRegistry`.
`Metrics`	`reporter(Function<com.codahale.metrics.MetricRegistry,com.codahale.metrics.Reporter> callback)` Append a `Reporter` to the `MetricRegistry`.
`Metrics`	`request()` Instrument request using `InstrumentedHandler`.
`Metrics`	`request(String pattern)` Instrument request using `InstrumentedHandler`.
`Metrics`	`request(String method, String pattern)` Instrument request using `InstrumentedHandler`.
`Metrics`	`threadDump()` Append a handler that prints thread states (a.k.a thread dump).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jooby.Jooby.Module
config

- Constructor Detail
  - Metrics
```
public Metrics(com.codahale.metrics.MetricRegistry registry,
               String pattern)
```
    Creates a new Metric module.
    
    Parameters:
    
    registry - Use the given registry.
    
    pattern - A root pattern where to publish all the services. Default is: /sys.
  - Metrics
```
public Metrics(String pattern)
```
    Creates a new Metric module.
    
    Parameters:
    
    pattern - A root pattern where to publish all the services. Default is: /sys.
  - Metrics
```
public Metrics(com.codahale.metrics.MetricRegistry registry)
```
    Creates a new Metric module. Services will be available at: /sys.
    
    Parameters:
    
    registry - Use the given registry.
  - Metrics
```
public Metrics()
```
    Creates a new Metric module. Services will be available at: /sys.
- Method Detail
  - request
```
public Metrics request(String method,
                       String pattern)
```
    Instrument request using InstrumentedHandler.
    
    Parameters:
    
    method - Method to filter for. Default is: GET.
    
    pattern - A pattern to filter for. Default is: * (all the requests).
    
    Returns:
    
    This metrics module.
  - request
```
public Metrics request(String pattern)
```
    Instrument request using InstrumentedHandler.
    
    Parameters:
    
    pattern - A pattern to filter for. Default is: * (all the requests).
    
    Returns:
    
    This metrics module.
  - request
```
public Metrics request()
```
    Instrument request using InstrumentedHandler. It will intercept all the GET calls.
    
    Returns:
    
    This metrics module.
  - ping
```
public Metrics ping()
```
    Append a simple ping handler that results in a 200 responses with a pong body. See PingHandler
    
    Returns:
    
    This metrics module.
  - threadDump
```
public Metrics threadDump()
```
    Append a handler that prints thread states (a.k.a thread dump). See ThreadDumpHandler.
    
    Returns:
    
    This metrics module.
  - metric
```
public Metrics metric(String name,
                      com.codahale.metrics.Metric metric)
```
    Append a metric to the MetricRegistry, this call is identical to MetricRegistry.register(String, Metric).
    
    Parameters:
    
    name - Name of the metric.
    
    metric - A metric object
    
    Returns:
    
    This metrics module.
  - metric
```
public <M extends com.codahale.metrics.Metric> Metrics metric(String name,
                                                              Class<M> metric)
```
    Append a metric to the MetricRegistry. The metric will be resolved by Guice. This call is identical to MetricRegistry.register(String, Metric).
    
    Type Parameters:
    
    M - Metric type.
    
    Parameters:
    
    name - Name of the metric.
    
    metric - A metric object.
    
    Returns:
    
    This metrics module.
  - healthCheck
```
public Metrics healthCheck(String name,
                           com.codahale.metrics.health.HealthCheck check)
```
    Append a health check to the HealthCheckRegistry. This call is identical to HealthCheckRegistry.register(String, HealthCheck).
    
    Parameters:
    
    name - Name of the check.
    
    check - A check object.
    
    Returns:
    
    This metrics module.
  - healthCheck
```
public <H extends com.codahale.metrics.health.HealthCheck> Metrics healthCheck(String name,
                                                                               Class<H> check)
```
    Append a health check to the HealthCheckRegistry. The metric will be resolved by Guice. This call is identical to HealthCheckRegistry.register(String, HealthCheck).
    
    Type Parameters:
    
    H - HealthCheck type.
    
    Parameters:
    
    name - Name of the check.
    
    check - A check object.
    
    Returns:
    
    This metrics module.
  - reporter
```
public Metrics reporter(BiFunction<com.codahale.metrics.MetricRegistry,com.typesafe.config.Config,com.codahale.metrics.Reporter> callback)
```
    Append a Reporter to the MetricRegistry.
    
    Parameters:
    
    callback - Reporter callback.
    
    Returns:
    
    This metrics module.
  - reporter
```
public Metrics reporter(Function<com.codahale.metrics.MetricRegistry,com.codahale.metrics.Reporter> callback)
```
    Append a Reporter to the MetricRegistry.
    
    Parameters:
    
    callback - Reporter callback.
    
    Returns:
    
    This metrics module.
  - configure
```
public void configure(Env env,
                      com.typesafe.config.Config conf,
                      com.google.inject.Binder binder)
```
    Specified by:
    
    configure in interface Jooby.Module

Class Metrics

metrics

usage

metrics

health checks

instrumented requests

thread dump

reporting

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jooby.Jooby.Module

Constructor Detail

Metrics

Metrics

Metrics

Metrics

Method Detail

request

request

request

ping

threadDump

metric

metric

healthCheck

healthCheck

reporter

reporter

configure