org.avaje.metric

Class MetricManager

java.lang.Object

org.avaje.metric.MetricManager

public class MetricManager
extends Object

Manages the creation and registration of Metrics.

Provides methods to allow agents to go through the registered metrics and gather/report the statistics.

This uses a service locator to initialise a underlying PluginMetricManager instance. A default implementation of PluginMetricManager is provided by avaje-metric-core.

Constructor Summary

Constructors

Constructor and Description
MetricManager()

Method Summary

Modifier and Type	Method and Description
static void	addSupplier(MetricSupplier supplier) Add a metric supplier to the manager.
static List<MetricStatistics>	collectNonEmptyJvmMetrics() Return JVM metrics that are not empty.
static List<MetricStatistics>	collectNonEmptyMetrics() Return all the non-JVM registered metrics that are not empty.
static CounterMetric	getCounterMetric(Class<?> cls, String eventName) Return a CounterMetric using the Class and name to derive the MetricName.
static CounterMetric	getCounterMetric(MetricName name) Return a CounterMetric given the name.
static CounterMetric	getCounterMetric(String name) Return a CounterMetric given the name.
static Collection<Metric>	getJvmMetrics() Return the core JVM metrics.
static MetricNameCache	getMetricNameCache(Class<?> cls) Return a MetricNameCache for the given class.
static MetricNameCache	getMetricNameCache(MetricName baseName) Return a MetricNameCache for a given base metric name.
static Collection<Metric>	getMetrics() Return all the non-JVM registered metrics.
static TimedMetric	getTimedMetric(Class<?> cls, String eventName) Return a TimedMetric using the Class, name to derive the MetricName.
static TimedMetric	getTimedMetric(Class<?> cls, String name, int... bucketRanges) Return a BucketTimedMetric given the name and bucket ranges.
static TimedMetric	getTimedMetric(MetricName name) Return a TimedMetric given the name.
static TimedMetric	getTimedMetric(MetricName name, int... bucketRanges) Return a BucketTimedMetric given the name and bucket ranges.
static TimedMetric	getTimedMetric(String name) Return a TimedMetric given the name.
static TimedMetric	getTimedMetric(String name, int... bucketRanges) Return a BucketTimedMetric given the name and bucket ranges.
static TimedMetricGroup	getTimedMetricGroup(Class<?> cls) Return the TimedMetricGroup with a class providing the base metric name.
static TimedMetricGroup	getTimedMetricGroup(MetricName baseName) Return the TimedMetricGroup with a based metric name.
static TimedMetricGroup	getTimedMetricGroup(String name) Return a TimedMetricGroup with a common group and type name.
static ValueMetric	getValueMetric(Class<?> cls, String eventName) Return a ValueMetric using the Class and name to derive the MetricName.
static ValueMetric	getValueMetric(MetricName name) Return a ValueMetric given the name.
static ValueMetric	getValueMetric(String name) Return a ValueMetric given the name.
static JvmMetrics	jvmMetrics() Return the built in JVM metrics support to register collection of all or some of the built in JVM metrics.
static MetricName	name(Class<?> cls, String name) Create a MetricName based on a class and name.
static MetricName	name(String name) Create a Metric name by parsing a name that is expected to include periods (dot notation similar to package.Class.method).
static GaugeDoubleMetric	register(MetricName name, GaugeDouble gauge) Create and register a GaugeMetric using the gauge supplied.
static GaugeLongMetric	register(MetricName name, GaugeLong gauge) Create and register a GaugeCounterMetric using the gauge supplied.
static GaugeDoubleMetric	register(String name, GaugeDouble gauge) Create and register a GaugeMetric using the gauge supplied.
static GaugeLongMetric	register(String name, GaugeLong gauge) Create and register a GaugeCounterMetric using the gauge supplied.
static void	reportTiming(RequestTiming requestTiming) When a request completes it is reported to the manager.
static RequestTimingManager	requestTimingManager() Return the API for managing request timing.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricManager

public MetricManager()

Method Detail

reportTiming

public static void reportTiming(RequestTiming requestTiming)

When a request completes it is reported to the manager.

addSupplier

public static void addSupplier(MetricSupplier supplier)

Add a metric supplier to the manager. These metrics are then included in the reporting.

name

public static MetricName name(Class<?> cls,
                              String name)

Create a MetricName based on a class and name.

Often the name maps to a method name.

name

public static MetricName name(String name)

Create a Metric name by parsing a name that is expected to include periods (dot notation similar to package.Class.method).

getMetricNameCache

public static MetricNameCache getMetricNameCache(Class<?> cls)

Return a MetricNameCache for the given class.

The MetricNameCache can be used to derive MetricName objects dynamically with relatively less overhead.

getMetricNameCache

public static MetricNameCache getMetricNameCache(MetricName baseName)

Return a MetricNameCache for a given base metric name.

The MetricNameCache can be used to derive MetricName objects dynamically with relatively less overhead.

getTimedMetric

public static TimedMetric getTimedMetric(MetricName name,
                                         int... bucketRanges)

Return a BucketTimedMetric given the name and bucket ranges.

getTimedMetric

public static TimedMetric getTimedMetric(Class<?> cls,
                                         String name,
                                         int... bucketRanges)

Return a BucketTimedMetric given the name and bucket ranges.

getTimedMetric

public static TimedMetric getTimedMetric(String name,
                                         int... bucketRanges)

Return a BucketTimedMetric given the name and bucket ranges.

getTimedMetric

public static TimedMetric getTimedMetric(MetricName name)

Return a TimedMetric given the name.

getTimedMetric

public static TimedMetric getTimedMetric(Class<?> cls,
                                         String eventName)

Return a TimedMetric using the Class, name to derive the MetricName.

getTimedMetric

public static TimedMetric getTimedMetric(String name)

Return a TimedMetric given the name.

getCounterMetric

public static CounterMetric getCounterMetric(MetricName name)

Return a CounterMetric given the name.

getCounterMetric

public static CounterMetric getCounterMetric(String name)

Return a CounterMetric given the name.

getCounterMetric

public static CounterMetric getCounterMetric(Class<?> cls,
                                             String eventName)

Return a CounterMetric using the Class and name to derive the MetricName.

getValueMetric

public static ValueMetric getValueMetric(MetricName name)

Return a ValueMetric given the name.

getValueMetric

public static ValueMetric getValueMetric(Class<?> cls,
                                         String eventName)

Return a ValueMetric using the Class and name to derive the MetricName.

getValueMetric

public static ValueMetric getValueMetric(String name)

Return a ValueMetric given the name.

getTimedMetricGroup

public static TimedMetricGroup getTimedMetricGroup(MetricName baseName)

Return the TimedMetricGroup with a based metric name.

getTimedMetricGroup

public static TimedMetricGroup getTimedMetricGroup(Class<?> cls)

Return the TimedMetricGroup with a class providing the base metric name.

The package name is the 'group' and the simple class name the 'type'.

getTimedMetricGroup

public static TimedMetricGroup getTimedMetricGroup(String name)

Return a TimedMetricGroup with a common group and type name.

Parameters:

name - the metric name

Returns:

the TimedMetricGroup used to create TimedMetric's that have a common base name.

register

public static GaugeDoubleMetric register(MetricName name,
                                         GaugeDouble gauge)

Create and register a GaugeMetric using the gauge supplied.

register

public static GaugeDoubleMetric register(String name,
                                         GaugeDouble gauge)

Create and register a GaugeMetric using the gauge supplied.

register

public static GaugeLongMetric register(MetricName name,
                                       GaugeLong gauge)

Create and register a GaugeCounterMetric using the gauge supplied.

register

public static GaugeLongMetric register(String name,
                                       GaugeLong gauge)

Create and register a GaugeCounterMetric using the gauge supplied.

getMetrics

public static Collection<Metric> getMetrics()

Return all the non-JVM registered metrics.

getJvmMetrics

public static Collection<Metric> getJvmMetrics()

Return the core JVM metrics.

collectNonEmptyMetrics

public static List<MetricStatistics> collectNonEmptyMetrics()

Return all the non-JVM registered metrics that are not empty.

collectNonEmptyJvmMetrics

public static List<MetricStatistics> collectNonEmptyJvmMetrics()

Return JVM metrics that are not empty.

jvmMetrics

public static JvmMetrics jvmMetrics()

Return the built in JVM metrics support to register collection of all or some of the built in JVM metrics.

requestTimingManager

public static RequestTimingManager requestTimingManager()

Return the API for managing request timing.