io.tsdb.services.framework.common.instrumentation

Class Metrics

java.lang.Object

io.tsdb.services.framework.common.instrumentation.Metrics

public class Metrics
extends java.lang.Object

Initializes DropWizard/Coda Hale Metrics. Provides commmon layout and function for metrics across projects and classes Centralizes metrics, reporters, heatlhchecks and base metricsets

Constructor Summary

Constructors

Constructor and Description
Metrics()

Method Summary

Modifier and Type	Method and Description
static void	decCounter(java.lang.Class<?> originatingClass, java.lang.String... names)
static com.codahale.metrics.Counter	getCounter(java.lang.Class<?> originatingClass, java.lang.String... names) Retrieve a Counter instance from the Registry (get or create).
static com.codahale.metrics.health.HealthCheckRegistry	getHealthCheckRegistry()
static com.codahale.metrics.Meter	getMeter(java.lang.Class<?> originatingClass, java.lang.String... names) Retrieve a Meter instance from the Registry (get or create).
static com.codahale.metrics.MetricRegistry	getMetricRegistry()
static com.codahale.metrics.Timer	getTimer(java.lang.Class<?> originatingClass, java.lang.String... names) Retrieve a Timer instance from the Registry (get or create).
static com.codahale.metrics.Timer.Context	getTimerContext(java.lang.Class<?> originatingClass, java.lang.String... names)
static void	incCounter(java.lang.Class<?> originatingClass, java.lang.String... names)
static void	initialize() Called to initialize the Metrics helper class.
static void	markMeter(java.lang.Class<?> originatingClass, java.lang.String... names)
static void	registerHealthCheck(java.lang.String name, com.codahale.metrics.health.HealthCheck healthcheck) Registers a health check with the Health Check Registry.
static void	registerMetricSet(java.lang.String prefix, com.codahale.metrics.MetricSet metricSet) Submit a Metric set to be registered with the Metrics registry.
void	startTimer(java.lang.Class<?> originatingClass, java.lang.String... names)
void	stopTimer(java.lang.Class<?> originatingClass, java.lang.String... names)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Metrics

public Metrics()

Method Detail

initialize

public static void initialize()

Called to initialize the Metrics helper class.

Starts the reporters.

registerMetricSet

public static void registerMetricSet(java.lang.String prefix,
                                     com.codahale.metrics.MetricSet metricSet)

Submit a Metric set to be registered with the Metrics registry.

Parameters:

prefix - the prefix for the metric name

metricSet - the metric set to be registered

registerHealthCheck

public static void registerHealthCheck(java.lang.String name,
                                       com.codahale.metrics.health.HealthCheck healthcheck)

Registers a health check with the Health Check Registry.

Parameters:

name - name of the health check

healthcheck - a health check object to regiser.

getCounter

public static com.codahale.metrics.Counter getCounter(java.lang.Class<?> originatingClass,
                                                      java.lang.String... names)

Retrieve a Counter instance from the Registry (get or create).

Parameters:

originatingClass - a Class to use as a namespace for the metric

names - names to append to the namespace

Returns:

returns a Counter instance

getTimer

public static com.codahale.metrics.Timer getTimer(java.lang.Class<?> originatingClass,
                                                  java.lang.String... names)

Retrieve a Timer instance from the Registry (get or create).

Parameters:

originatingClass - a Class to use as a namespace for the metric

names - names to append to the namespace

Returns:

a Timer

getMeter

public static com.codahale.metrics.Meter getMeter(java.lang.Class<?> originatingClass,
                                                  java.lang.String... names)

Retrieve a Meter instance from the Registry (get or create).

Parameters:

originatingClass - a Class to use as a namespace for the metric

names - names to append to the namespace

Returns:

a Meter

incCounter

public static void incCounter(java.lang.Class<?> originatingClass,
                              java.lang.String... names)

decCounter

public static void decCounter(java.lang.Class<?> originatingClass,
                              java.lang.String... names)

markMeter

public static void markMeter(java.lang.Class<?> originatingClass,
                             java.lang.String... names)

getTimerContext

public static com.codahale.metrics.Timer.Context getTimerContext(java.lang.Class<?> originatingClass,
                                                                 java.lang.String... names)

startTimer

public void startTimer(java.lang.Class<?> originatingClass,
                       java.lang.String... names)

stopTimer

public void stopTimer(java.lang.Class<?> originatingClass,
                      java.lang.String... names)

getMetricRegistry

public static com.codahale.metrics.MetricRegistry getMetricRegistry()

getHealthCheckRegistry

public static com.codahale.metrics.health.HealthCheckRegistry getHealthCheckRegistry()