com.j256.simplemetrics.manager

Class MetricsManager

java.lang.Object

com.j256.simplemetrics.manager.MetricsManager

public class MetricsManager
extends Object

Class which manages the various metrics that are in the system so they can be queried by operations. You register metrics with this class, register classes that need to manually update metrics values, and controls the metrics persistence.

Author:

graywatson

Constructor Summary

Constructors

Constructor and Description
MetricsManager()

Method Summary

Modifier and Type	Method and Description
Collection<ControlledMetric<?,?>>	getMetrics()
Map<ControlledMetric<?,?>,MetricValueDetails>	getMetricValueDetailsMap() Return a map of the controlled metrics and their current associated values.
String[]	getMetricValues()
Map<ControlledMetric<?,?>,Number>	getMetricValuesMap() Return a map of the controlled metrics and their current associated values.
int	getPersistCount()
void	persist() Persists the configured metrics by calling to the registered updaters, extracting the value-details from the metrics, and then calling the registered value and details persisters.
String	persistJmx()
void	persistValuesOnly() Persists the configured metrics to the value persisters only by extracting the values from the metrics and then calling the registered persisters.
void	registerMetric(ControlledMetric<?,?> metric) Register a metric with the manager.
void	registerUpdater(MetricsUpdater metricsUpdater) Register a MetricsUpdater to be called right before persist writes the metrics.
void	setJmxServer(com.j256.simplejmx.server.JmxServer jmxServer) Set the optional jmx-server that can be used to publish metrics to JMX.
void	setMetricDetailsPersisters(MetricDetailsPersister[] metricDetailsPersisters) Set the persisters for the metric details.
void	setMetricValuesPersisters(MetricValuesPersister[] metricValuesPersisters) Set the persisters for the metric values.
void	unregisterMetric(ControlledMetric<?,?> metric) Unregister a metric with the manager.
void	updateMetrics() Update the various classes' metrics.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsManager

public MetricsManager()

Method Detail

registerMetric

public void registerMetric(ControlledMetric<?,?> metric)

Register a metric with the manager.

unregisterMetric

public void unregisterMetric(ControlledMetric<?,?> metric)

Unregister a metric with the manager.

registerUpdater

public void registerUpdater(MetricsUpdater metricsUpdater)

Register a MetricsUpdater to be called right before persist writes the metrics.

persist

public void persist()
             throws IOException

Persists the configured metrics by calling to the registered updaters, extracting the value-details from the metrics, and then calling the registered value and details persisters.

Throws:

IOException

persistValuesOnly

public void persistValuesOnly()
                       throws IOException

Persists the configured metrics to the value persisters only by extracting the values from the metrics and then calling the registered persisters. Usually you will want to call persist() instead.

NOTE: you should call updateMetrics() before calling this method if necessary.

Throws:

IOException

getMetricValuesMap

public Map<ControlledMetric<?,?>,Number> getMetricValuesMap()

Return a map of the controlled metrics and their current associated values. NOTE: this does not call updateMetrics() beforehand.

getMetricValueDetailsMap

public Map<ControlledMetric<?,?>,MetricValueDetails> getMetricValueDetailsMap()

Return a map of the controlled metrics and their current associated values. NOTE: this does not call updateMetrics() beforehand.

updateMetrics

public void updateMetrics()

Update the various classes' metrics.

persistJmx

public String persistJmx()

getMetrics

public Collection<ControlledMetric<?,?>> getMetrics()

Returns:

An unmodifiable collection of metrics we are managing.

setJmxServer

public void setJmxServer(com.j256.simplejmx.server.JmxServer jmxServer)

Set the optional jmx-server that can be used to publish metrics to JMX.

setMetricValuesPersisters

public void setMetricValuesPersisters(MetricValuesPersister[] metricValuesPersisters)

Set the persisters for the metric values.

setMetricDetailsPersisters

public void setMetricDetailsPersisters(MetricDetailsPersister[] metricDetailsPersisters)

Set the persisters for the metric details.

getMetricValues

public String[] getMetricValues()

getPersistCount

public int getPersistCount()