Package io.prometheus.client.hotspot

Class StandardExports

java.lang.Object

io.prometheus.client.Collector

io.prometheus.client.hotspot.StandardExports

public class StandardExports
extends Collector

Exports the standard exports common across all prometheus clients.

This includes stats like CPU time spent and memory usage.

Example usage:

 
   new StandardExports().register();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	StandardExports.StatusReader

Nested classes/interfaces inherited from class io.prometheus.client.Collector

Collector.Describable, Collector.MetricFamilySamples, Collector.Type

Field Summary

Fields

Modifier and Type	Field	Description
private static final double	KB
private final boolean	linux
private static final Logger	LOGGER
private final OperatingSystemMXBean	osBean
private final RuntimeMXBean	runtimeBean
private final StandardExports.StatusReader	statusReader

Fields inherited from class io.prometheus.client.Collector

MILLISECONDS_PER_SECOND, NANOSECONDS_PER_SECOND

Constructor Summary

Constructors

Constructor	Description
StandardExports()
StandardExports(StandardExports.StatusReader statusReader, OperatingSystemMXBean osBean, RuntimeMXBean runtimeBean)

Method Summary

Modifier and Type	Method	Description
(package private) static Long	callLongGetter(Method method, Object obj)	Attempts to call a method either directly or via one of the implemented interfaces.
(package private) static Long	callLongGetter(String getterName, Object obj)
List<Collector.MetricFamilySamples>	collect()	Return all metrics of this Collector.
(package private) void	collectMemoryMetricsLinux(List<Collector.MetricFamilySamples> mfs)

Methods inherited from class io.prometheus.client.Collector

checkMetricLabelName, checkMetricName, collect, doubleToGoString, register, register, sanitizeMetricName

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final Logger LOGGER

statusReader

private final StandardExports.StatusReader statusReader

osBean

private final OperatingSystemMXBean osBean

runtimeBean

private final RuntimeMXBean runtimeBean

linux

private final boolean linux

KB

private static final double KB

See Also:

• Constant Field Values

Constructor Details

StandardExports

public StandardExports()

StandardExports

StandardExports(StandardExports.StatusReader statusReader,
 OperatingSystemMXBean osBean,
 RuntimeMXBean runtimeBean)

Method Details

collect

public List<Collector.MetricFamilySamples> collect()

Description copied from class: Collector

Return all metrics of this Collector.

Specified by:

collect in class Collector

callLongGetter

static Long callLongGetter(String getterName,
 Object obj)
                    throws NoSuchMethodException,
InvocationTargetException

Throws:

NoSuchMethodException

InvocationTargetException

callLongGetter

static Long callLongGetter(Method method,
 Object obj)
                    throws InvocationTargetException

Attempts to call a method either directly or via one of the implemented interfaces.

A Method object refers to a specific method declared in a specific class. The first invocation might happen with method == SomeConcreteClass.publicLongGetter() and will fail if SomeConcreteClass is not public. We then recurse over all interfaces implemented by SomeConcreteClass (or extended by those interfaces and so on) until we eventually invoke callMethod() with method == SomePublicInterface.publicLongGetter(), which will then succeed.

There is a built-in assumption that the method will never return null (or, equivalently, that it returns the primitive data type, i.e. long rather than Long). If this assumption doesn't hold, the method might be called repeatedly and the returned value will be the one produced by the last call.

Throws:

InvocationTargetException

collectMemoryMetricsLinux

void collectMemoryMetricsLinux(List<Collector.MetricFamilySamples> mfs)