io.engineblock.metrics

Class ActivityMetrics

java.lang.Object

io.engineblock.metrics.ActivityMetrics

public class ActivityMetrics
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static com.codahale.metrics.MetricFilter	METRIC_FILTER

Method Summary

Modifier and Type	Method and Description
static void	addHistoLogger(String sessionName, String pattern, String filename, String interval) Add a histogram interval logger to matching metrics in this JVM instance.
static void	addStatsLogger(String sessionName, String pattern, String filename, String interval) Add a histogram stats logger to matching metrics in this JVM instance.
static com.codahale.metrics.Counter	counter(ActivityDef activityDef, String name) Create a counter associated with an activity.
static com.codahale.metrics.Gauge<?>	gauge(ActivityDef activityDef, String name, com.codahale.metrics.Gauge<?> gauge)
static com.codahale.metrics.Gauge<?>	gauge(ScriptContext scriptContext, String name, com.codahale.metrics.Gauge<?> gauge)
static com.codahale.metrics.MetricRegistry	getMetricRegistry()
static com.codahale.metrics.Histogram	histogram(ActivityDef activityDef, String name) Create a histogram associated with an activity.
static com.codahale.metrics.Meter	meter(ActivityDef activityDef, String name) Create a meter associated with an activity.
static void	reportTo(PrintStream out)
static com.codahale.metrics.Timer	timer(ActivityDef activityDef, String name) Create a timer associated with an activity.

Methods inherited from class java.lang.Object

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

Field Detail

METRIC_FILTER

public static com.codahale.metrics.MetricFilter METRIC_FILTER

Method Detail

timer

public static com.codahale.metrics.Timer timer(ActivityDef activityDef,
                                               String name)

Create a timer associated with an activity.

This method ensures that if multiple threads attempt to create the same-named metric on a given activity, that only one of them succeeds.

Parameters:

activityDef - an associated activity def

name - a simple, descriptive name for the timer

Returns:

the timer, perhaps a different one if it has already been registered

histogram

public static com.codahale.metrics.Histogram histogram(ActivityDef activityDef,
                                                       String name)

Create a histogram associated with an activity.

This method ensures that if multiple threads attempt to create the same-named metric on a given activity, that only one of them succeeds.

Parameters:

activityDef - an associated activity def

name - a simple, descriptive name for the histogram

Returns:

the histogram, perhaps a different one if it has already been registered

counter

public static com.codahale.metrics.Counter counter(ActivityDef activityDef,
                                                   String name)

Create a counter associated with an activity.

This method ensures that if multiple threads attempt to create the same-named metric on a given activity, that only one of them succeeds.

Parameters:

activityDef - an associated activity def

name - a simple, descriptive name for the counter

Returns:

the counter, perhaps a different one if it has already been registered

meter

public static com.codahale.metrics.Meter meter(ActivityDef activityDef,
                                               String name)

Create a meter associated with an activity.

This method ensures that if multiple threads attempt to create the same-named metric on a given activity, that only one of them succeeds.

Parameters:

activityDef - an associated activity def

name - a simple, descriptive name for the meter

Returns:

the meter, perhaps a different one if it has already been registered

gauge

public static com.codahale.metrics.Gauge<?> gauge(ActivityDef activityDef,
                                                  String name,
                                                  com.codahale.metrics.Gauge<?> gauge)

gauge

public static com.codahale.metrics.Gauge<?> gauge(ScriptContext scriptContext,
                                                  String name,
                                                  com.codahale.metrics.Gauge<?> gauge)

getMetricRegistry

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

addHistoLogger

public static void addHistoLogger(String sessionName,
                                  String pattern,
                                  String filename,
                                  String interval)

Add a histogram interval logger to matching metrics in this JVM instance.

Parameters:

sessionName - The name for the session to be annotated in the histogram log

pattern - A regular expression pattern to filter out metric names for logging

filename - A file to log the histogram data in

interval - How many seconds to wait between writing each interval histogram

addStatsLogger

public static void addStatsLogger(String sessionName,
                                  String pattern,
                                  String filename,
                                  String interval)

Add a histogram stats logger to matching metrics in this JVM instance.

Parameters:

sessionName - The name for the session to be annotated in the histogram log

pattern - A regular expression pattern to filter out metric names for logging

filename - A file to log the histogram data in

interval - How many seconds to wait between writing each interval histogram

reportTo

public static void reportTo(PrintStream out)