sirius.kernel.health.metrics

Class Metrics

java.lang.Object

sirius.kernel.health.metrics.Metrics

All Implemented Interfaces:

EveryMinute, TimedTask

public class Metrics
extends Object
implements EveryMinute

Collects and stores metrics for various parts of the system.

To provide custom metrics, implement MetricProvider and register it in the component model using the Register annotation.

The collected metrics are updated once every minute.

Constructor Summary

Constructors

Constructor and Description
Metrics()

Method Summary

Modifier and Type	Method and Description
List<Metric>	getMetrics() Returns a list of all collected metrics so far.
void	runTimer() Called every time the timer interval is fired.

Methods inherited from class java.lang.Object

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

Constructor Detail

Metrics

public Metrics()

Method Detail

runTimer

public void runTimer()
              throws Exception

Description copied from interface: TimedTask

Called every time the timer interval is fired.

Note that only small computations can be done in this method. Computations which take longs must be executed in another executor as otherwise the timer will run out of schedule and start dropping tasks.

Specified by:

runTimer in interface TimedTask

Throws:

Exception - in case anything goes wrong. Will be caught and handled using Exceptions

See Also:

Tasks.executor(String)

getMetrics

public List<Metric> getMetrics()

Returns a list of all collected metrics so far.

Returns:

a list of all metrics