org.avaje.metric.spi

Interface PluginMetricManager

public interface PluginMetricManager

The SPI for the underlying implementation that is plugged in via service locator.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<Metric>	collectNonEmptyMetrics() Return the collection of metrics that are considered non-empty.
BucketTimedMetric	getBucketTimedMetric(MetricName name, int... bucketRanges) Return the BucketTimedMetric using the given base metric name and bucketRanges.
CounterMetric	getCounterMetric(MetricName name) Return the CounterMetric using the metric name.
Collection<Metric>	getJvmMetrics() Return a collection of the JVM metrics.
MetricNameCache	getMetricNameCache(Class<?> cls) Return the MetricNameCache using the class as a base name.
MetricNameCache	getMetricNameCache(MetricName baseName) Return the MetricNameCache using a MetricName as a base name.
Collection<Metric>	getMetrics() Return a collection of all the metrics.
TimedMetric	getTimedMetric(MetricName name) Return the TimedMetric using the metric name.
TimedMetricGroup	getTimedMetricGroup(MetricName baseName) Return the TimedMetricGroup using the given base metric name.
ValueMetric	getValueMetric(MetricName name) Return the ValueMetric using the metric name.
MetricName	name(Class<?> cls, String name) Create a MetricName based on the class and name.
MetricName	name(String name) Create a Metric name by parsing a name that is expected to include periods.
MetricName	name(String group, String type, String name) Create a Metric name based on group, type and name.
GaugeDoubleMetric	register(MetricName name, GaugeDouble gauge) Create and register a GaugeMetric using the gauge supplied (double values).
GaugeLongMetric	register(MetricName name, GaugeLong gauge) Create and register a GaugeCounterMetric using the gauge supplied (long values).

Method Detail

name

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

Create a MetricName based on the class and name. Typically name is a method name.

name

MetricName name(String group,
              String type,
              String name)

Create a Metric name based on group, type and name.

Parameters:

group - The group which often maps to a package name.

type - The type which often maps to a simple class name.

name - The name which often maps to a method name.

name

MetricName name(String name)

Create a Metric name by parsing a name that is expected to include periods.

The name is expected to be in dot notation similar to package.class.method.

getTimedMetric

TimedMetric getTimedMetric(MetricName name)

Return the TimedMetric using the metric name.

getBucketTimedMetric

BucketTimedMetric getBucketTimedMetric(MetricName name,
                                     int... bucketRanges)

Return the BucketTimedMetric using the given base metric name and bucketRanges.

Parameters:

name - The metric name

bucketRanges - Time in milliseconds which are used to create buckets.

getCounterMetric

CounterMetric getCounterMetric(MetricName name)

Return the CounterMetric using the metric name.

getValueMetric

ValueMetric getValueMetric(MetricName name)

Return the ValueMetric using the metric name.

getTimedMetricGroup

TimedMetricGroup getTimedMetricGroup(MetricName baseName)

Return the TimedMetricGroup using the given base metric name.

getMetricNameCache

MetricNameCache getMetricNameCache(Class<?> cls)

Return the MetricNameCache using the class as a base name.

getMetricNameCache

MetricNameCache getMetricNameCache(MetricName baseName)

Return the MetricNameCache using a MetricName as a base name.

collectNonEmptyMetrics

Collection<Metric> collectNonEmptyMetrics()

Return the collection of metrics that are considered non-empty. This means these are metrics that have collected statistics since the last time they were collected.

getMetrics

Collection<Metric> getMetrics()

Return a collection of all the metrics.

getJvmMetrics

Collection<Metric> getJvmMetrics()

Return a collection of the JVM metrics.

register

GaugeDoubleMetric register(MetricName name,
                         GaugeDouble gauge)

Create and register a GaugeMetric using the gauge supplied (double values).

register

GaugeLongMetric register(MetricName name,
                       GaugeLong gauge)

Create and register a GaugeCounterMetric using the gauge supplied (long values).