Package io.prometheus.metrics.instrumentation.jvm

Class ProcessMetrics

java.lang.Object

io.prometheus.metrics.instrumentation.jvm.ProcessMetrics

public class ProcessMetrics
extends Object

Process metrics.

These metrics are defined in the process metrics section of the Prometheus client library documentation, and they are implemented across client libraries in multiple programming languages.

Technically, some of them are OS-level metrics and not JVM-level metrics. However, I'm still putting them in the prometheus-metrics-instrumentation-jvm module, because first it seems overkill to create a separate Maven module just for the ProcessMetrics class, and seconds some of these metrics are coming from the JVM via JMX anyway.

The ProcessMetrics are registered as part of the JvmMetrics like this:

 JvmMetrics.builder().register();
 

However, if you want only the ProcessMetrics you can also register them directly:

 ProcessMetrics.builder().register();
 

Example metrics being exported:

 # HELP process_cpu_seconds_total Total user and system CPU time spent in seconds.
 # TYPE process_cpu_seconds_total counter
 process_cpu_seconds_total 1.63
 # HELP process_max_fds Maximum number of open file descriptors.
 # TYPE process_max_fds gauge
 process_max_fds 524288.0
 # HELP process_open_fds Number of open file descriptors.
 # TYPE process_open_fds gauge
 process_open_fds 28.0
 # HELP process_resident_memory_bytes Resident memory size in bytes.
 # TYPE process_resident_memory_bytes gauge
 process_resident_memory_bytes 7.8577664E7
 # HELP process_start_time_seconds Start time of the process since unix epoch in seconds.
 # TYPE process_start_time_seconds gauge
 process_start_time_seconds 1.693829439767E9
 # HELP process_virtual_memory_bytes Virtual memory size in bytes.
 # TYPE process_virtual_memory_bytes gauge
 process_virtual_memory_bytes 1.2683624448E10
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProcessMetrics.Builder
private static class	ProcessMetrics.FileGrepper
(package private) static interface	ProcessMetrics.Grepper

Field Summary

Fields

Modifier and Type	Field	Description
private final PrometheusProperties	config
private final Labels	constLabels
private final ProcessMetrics.Grepper	grepper
private final boolean	linux
private final OperatingSystemMXBean	osBean
(package private) static final File	PROC_SELF_STATUS
private static final String	PROCESS_CPU_SECONDS_TOTAL
private static final String	PROCESS_MAX_FDS
private static final String	PROCESS_OPEN_FDS
private static final String	PROCESS_RESIDENT_MEMORY_BYTES
private static final String	PROCESS_START_TIME_SECONDS
private static final String	PROCESS_VIRTUAL_MEMORY_BYTES
private final RuntimeMXBean	runtimeBean

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ProcessMetrics(OperatingSystemMXBean osBean, RuntimeMXBean runtimeBean, ProcessMetrics.Grepper grepper, PrometheusProperties config, Labels constLabels)

Method Summary

Modifier and Type	Method	Description
static ProcessMetrics.Builder	builder()
static ProcessMetrics.Builder	builder(PrometheusProperties config)
private Long	callLongGetter(Method method, Object obj)	Attempts to call a method either directly or via one of the implemented interfaces.
private Long	callLongGetter(String getterName, Object obj)
private void	register(PrometheusRegistry registry)

Methods inherited from class java.lang.Object

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

Field Details

PROCESS_CPU_SECONDS_TOTAL

private static final String PROCESS_CPU_SECONDS_TOTAL

See Also:

• Constant Field Values

PROCESS_START_TIME_SECONDS

private static final String PROCESS_START_TIME_SECONDS

See Also:

• Constant Field Values

PROCESS_OPEN_FDS

private static final String PROCESS_OPEN_FDS

See Also:

• Constant Field Values

PROCESS_MAX_FDS

private static final String PROCESS_MAX_FDS

See Also:

• Constant Field Values

PROCESS_VIRTUAL_MEMORY_BYTES

private static final String PROCESS_VIRTUAL_MEMORY_BYTES

See Also:

• Constant Field Values

PROCESS_RESIDENT_MEMORY_BYTES

private static final String PROCESS_RESIDENT_MEMORY_BYTES

See Also:

• Constant Field Values

PROC_SELF_STATUS

static final File PROC_SELF_STATUS

config

private final PrometheusProperties config

osBean

private final OperatingSystemMXBean osBean

runtimeBean

private final RuntimeMXBean runtimeBean

grepper

private final ProcessMetrics.Grepper grepper

linux

private final boolean linux

constLabels

private final Labels constLabels

Constructor Details

ProcessMetrics

private ProcessMetrics(OperatingSystemMXBean osBean,
 RuntimeMXBean runtimeBean,
 ProcessMetrics.Grepper grepper,
 PrometheusProperties config,
 Labels constLabels)

Method Details

register

private void register(PrometheusRegistry registry)

callLongGetter

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

Throws:

NoSuchMethodException

InvocationTargetException

callLongGetter

private 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

builder

public static ProcessMetrics.Builder builder()

builder

public static ProcessMetrics.Builder builder(PrometheusProperties config)