sirius.kernel.health.metrics.package-info Maven / Gradle / Ivy
/*
* Made with all the love in the world
* by scireum in Remshalden, Germany
*
* Copyright by scireum GmbH
* http://www.scireum.de - [email protected]
*/
/**
* Used to record and monitor system metrics.
*
* Defines a discovery interface {@link sirius.kernel.health.metrics.MetricProvider} which is found and monitored
* by {@link sirius.kernel.health.metrics.Metrics}. The {@link sirius.kernel.health.metrics.SystemMetricProvider}
* uses Sigar and JMX to provide some basic metrics for the JVM and the underlying machine.
*
* Limits for all metrics can be defined in the system configuration under health.limits.[metric]:
*
* -
* gray: Up to this value, it is considered as not noteworthy and normally not shown.
* Everything above is active, but good.
*
* -
* warning: If this value is reached, this metric is considered increased but still acceptable.
*
* - error: Once this value is reached, the system stability is no longer guaranteed and some action
* is required. If there is no upper limit for a metric, this value can also be skipped.
*
*
* Eache module which provides metrics normally also defines some default limits in its component-[name].conf.
*/
package sirius.kernel.health.metrics;