org.avaje.metric.MetricManager Maven / Gradle / Ivy
package org.avaje.metric;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.ServiceLoader;
import org.avaje.metric.spi.PluginMetricManager;
/**
* 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.
*/
public class MetricManager {
/**
* The implementation that is found via service loader.
*/
private static final PluginMetricManager mgr = initialiseProvider();
/**
* The default implementation which is avaje-metric-core.
*/
private static final String DEFAULT_PROVIDER = "org.avaje.metric.core.DefaultMetricManager";
/**
* Finds and returns the implementation of PluginMetricManager using the ServiceLoader.
*/
private static PluginMetricManager initialiseProvider() {
ServiceLoader loader = ServiceLoader.load(PluginMetricManager.class);
Iterator it = loader.iterator();
if (it.hasNext()) {
return it.next();
}
try {
Class clazz = Class.forName(DEFAULT_PROVIDER);
return (PluginMetricManager) clazz.newInstance();
} catch (ClassNotFoundException e) {
throw new RuntimeException("Provider " + DEFAULT_PROVIDER + " not found", e);
} catch (Exception e) {
throw new RuntimeException("Provider " + DEFAULT_PROVIDER + " could not be instantiated: " + e, e);
}
}
/**
* When a request completes it is reported to the manager.
*/
public static void reportTiming(RequestTiming requestTiming) {
mgr.reportTiming(requestTiming);
}
/**
* Return the request timings that have been collected since the last collection.
*/
public static List collectRequestTimings() {
return mgr.collectRequestTimings();
}
/**
* Create a MetricName based on a class and name.
*
* Often the name maps to a method name.
*/
public static MetricName name(Class cls, String name) {
return mgr.name(cls, name);
}
/**
* Create a Metric name based on group, type and name.
*
* @param group
* The group which often maps to a package name.
* @param type
* The type which often maps to a simple class name.
* @param name
* The name which often maps to a method name.
*/
public static MetricName name(String group, String type, String name) {
return mgr.name(group, type, name);
}
/**
* Create a Metric name by parsing a name that is expected to include periods (dot notation
* similar to package.Class.method).
*/
public static MetricName name(String name) {
return mgr.name(name);
}
/**
* Return a MetricNameCache for the given class.
*
* The MetricNameCache can be used to derive MetricName objects dynamically with relatively less
* overhead.
*
*/
public static MetricNameCache getMetricNameCache(Class cls) {
return mgr.getMetricNameCache(cls);
}
/**
* Return a MetricNameCache for a given base metric name.
*
* The MetricNameCache can be used to derive MetricName objects dynamically with relatively less
* overhead.
*
*/
public static MetricNameCache getMetricNameCache(MetricName baseName) {
return mgr.getMetricNameCache(baseName);
}
/**
* Return a BucketTimedMetric given the name and bucket ranges.
*/
public static BucketTimedMetric getTimedMetric(MetricName name, int... bucketRanges) {
return mgr.getBucketTimedMetric(name, bucketRanges);
}
/**
* Return a BucketTimedMetric given the name and bucket ranges.
*/
public static BucketTimedMetric getTimedMetric(Class cls, String name, int... bucketRanges) {
return getTimedMetric(name(cls, name), bucketRanges);
}
/**
* Return a BucketTimedMetric given the name and bucket ranges.
*/
public static BucketTimedMetric getTimedMetric(String name, int... bucketRanges) {
return getTimedMetric(name(name), bucketRanges);
}
/**
* Return a TimedMetric given the name.
*/
public static TimedMetric getTimedMetric(MetricName name) {
return mgr.getTimedMetric(name);
}
/**
* Return a TimedMetric using the Class, name to derive the MetricName.
*/
public static TimedMetric getTimedMetric(Class cls, String eventName) {
return getTimedMetric(name(cls, eventName));
}
/**
* Return a TimedMetric given the name.
*/
public static TimedMetric getTimedMetric(String name) {
return getTimedMetric(name(name));
}
/**
* Return a CounterMetric given the name.
*/
public static CounterMetric getCounterMetric(MetricName name) {
return mgr.getCounterMetric(name);
}
/**
* Return a CounterMetric given the name.
*/
public static CounterMetric getCounterMetric(String name) {
return getCounterMetric(name(name));
}
/**
* Return a CounterMetric using the Class and name to derive the MetricName.
*/
public static CounterMetric getCounterMetric(Class cls, String eventName) {
return getCounterMetric(name(cls, eventName));
}
/**
* Return a ValueMetric given the name.
*/
public static ValueMetric getValueMetric(MetricName name) {
return mgr.getValueMetric(name);
}
/**
* Return a ValueMetric using the Class and name to derive the MetricName.
*/
public static ValueMetric getValueMetric(Class cls, String eventName) {
return getValueMetric(name(cls, eventName));
}
/**
* Return a ValueMetric given the name.
*/
public static ValueMetric getValueMetric(String name) {
return getValueMetric(name(name));
}
/**
* Return the TimedMetricGroup with a based metric name.
*/
public static TimedMetricGroup getTimedMetricGroup(MetricName baseName) {
return mgr.getTimedMetricGroup(baseName);
}
/**
* Return the TimedMetricGroup with a class providing the base metric name.
*
* The package name is the 'group' and the simple class name the 'type'.
*/
public static TimedMetricGroup getTimedMetricGroup(Class cls) {
return getTimedMetricGroup(name(cls,""));
}
/**
* Return a TimedMetricGroup with a common group and type name.
*
* @param group
* the common group name
* @param type
* the common type name
*
* @return the TimedMetricGroup used to create TimedMetric's that have a common base name.
*/
public static TimedMetricGroup getTimedMetricGroup(String group, String type) {
return getTimedMetricGroup(name(group, type, ""));
}
/**
* Create and register a GaugeMetric using the gauge supplied.
*/
public static GaugeDoubleMetric register(MetricName name, GaugeDouble gauge) {
return mgr.register(name, gauge);
}
/**
* Create and register a GaugeMetric using the gauge supplied.
*/
public static GaugeDoubleMetric register(String name, GaugeDouble gauge) {
return mgr.register(name(name), gauge);
}
/**
* Create and register a GaugeCounterMetric using the gauge supplied.
*/
public static GaugeLongMetric register(MetricName name, GaugeLong gauge) {
return mgr.register(name, gauge);
}
/**
* Create and register a GaugeCounterMetric using the gauge supplied.
*/
public static GaugeLongMetric register(String name, GaugeLong gauge) {
return mgr.register(name(name), gauge);
}
/**
* Return all the non-jvm registered metrics.
*/
public static Collection getMetrics() {
return mgr.getMetrics();
}
/**
* Return all the non-jvm registered metrics that are not empty.
*/
public static Collection collectNonEmptyMetrics() {
return mgr.collectNonEmptyMetrics();
}
/**
* Return the core JVM metrics.
*/
public static Collection getJvmMetrics() {
return mgr.getJvmMetrics();
}
/**
* Return all the timing metrics that are currently collecting per request timings and whose name
* matches the name expression.
*
* If the name match expression is null or empty then all timing metrics are returned.
*
*
* These are TimingMetric or BucketTimingMetrics that have {@link TimedMetric#getRequestTimingCollection()}
* greater than 0.
*
* Example name match expressions:
* {@code
*
* // starts with web.
* "web.*"
*
* // end with resource
* "*resource"
*
* // starts with web. and contains customer
* "web.*customer*"
*
* // starts with web. and contains customer and ends with resource
* "web.*customer*resource"
*
* }
*
* @param nameMatchExpression the expression used to match/filter metric names. Null or empty means match all.
*
* @return timing metrics that are actively collecting request timings.
*/
public static List getRequestTimingMetrics(String nameMatchExpression) {
return mgr.getRequestTimingMetrics(nameMatchExpression);
}
/**
* Return the list of all timing metrics that match the name expression.
*
* If the name match expression is null or empty then all timing metrics are returned.
*
*
* Example name match expressions:
* {@code
*
* // starts with web.
* "web.*"
*
* // end with resource
* "*resource"
*
* // starts with web. and contains customer
* "web.*customer*"
*
* // starts with web. and contains customer and ends with resource
* "web.*customer*resource"
*
* }
*
* @param nameMatchExpression the expression used to match/filter metric names. Null or empty means match all.
* @return all timing metrics those name matches the expression.
*/
public static List getAllTimingMetrics(String nameMatchExpression) {
return mgr.getAllTimingMetrics(nameMatchExpression);
}
/**
* Set request timing on for a metric matching the name.
*
* @param collectionCount the number of requests to collect request timings for
* @return true if request timing was set, false if the metric was not found.
*/
public static boolean setRequestTimingCollection(String metricName, int collectionCount) {
return mgr.setRequestTimingCollection(metricName, collectionCount);
}
/**
* Set request timing on for a metric matching the class and name.
*
* @param collectionCount the number of requests to collect request timings for
* @return true if request timing was set, false if the metric was not found.
*/
public static boolean setRequestTimingCollection(Class cls, String name, int collectionCount) {
return mgr.setRequestTimingCollection(cls, name, collectionCount);
}
/**
* Set request timing on all the timed metrics whose name starts with a given prefix.
*
* If for example all the web endpoints have a prefix of "web." then these can all be
* set to collect say 10 requests.
*
*
* Example name match expressions:
* {@code
*
* // starts with web.
* "web.*"
*
* // end with resource
* "*resource"
*
* // starts with web. and contains customer
* "web.*customer*"
*
* // starts with web. and contains customer and ends with resource
* "web.*customer*resource"
*
* }
*
*
* @param nameMatchExpression The expression used to match timing metrics
* @param collectionCount The number of requests to collect
* @return The timing metrics that had the request timing collection set
*/
public static List setRequestTimingCollectionUsingMatch(String nameMatchExpression, int collectionCount) {
return mgr.setRequestTimingCollectionUsingMatch(nameMatchExpression, collectionCount);
}
}