Package io.prometheus.metrics.instrumentation.jvm

Class JvmBufferPoolMetrics

java.lang.Object

io.prometheus.metrics.instrumentation.jvm.JvmBufferPoolMetrics

public class JvmBufferPoolMetrics
extends Object

JVM Buffer Pool metrics. The JvmBufferPoolMetrics are registered as part of the JvmMetrics like this:

 JvmMetrics.builder().register();
 

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

 JvmBufferPoolMetrics.builder().register();
 

Example metrics being exported:

 # HELP jvm_buffer_pool_capacity_bytes Bytes capacity of a given JVM buffer pool.
 # TYPE jvm_buffer_pool_capacity_bytes gauge
 jvm_buffer_pool_capacity_bytes{pool="direct"} 8192.0
 jvm_buffer_pool_capacity_bytes{pool="mapped"} 0.0
 # HELP jvm_buffer_pool_used_buffers Used buffers of a given JVM buffer pool.
 # TYPE jvm_buffer_pool_used_buffers gauge
 jvm_buffer_pool_used_buffers{pool="direct"} 1.0
 jvm_buffer_pool_used_buffers{pool="mapped"} 0.0
 # HELP jvm_buffer_pool_used_bytes Used bytes of a given JVM buffer pool.
 # TYPE jvm_buffer_pool_used_bytes gauge
 jvm_buffer_pool_used_bytes{pool="direct"} 8192.0
 jvm_buffer_pool_used_bytes{pool="mapped"} 0.0
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JvmBufferPoolMetrics.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final List<BufferPoolMXBean>	bufferPoolBeans
private final PrometheusProperties	config
private final Labels	constLabels
private static final String	JVM_BUFFER_POOL_CAPACITY_BYTES
private static final String	JVM_BUFFER_POOL_USED_BUFFERS
private static final String	JVM_BUFFER_POOL_USED_BYTES

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JvmBufferPoolMetrics(List<BufferPoolMXBean> bufferPoolBeans, PrometheusProperties config, Labels constLabels)

Method Summary

Modifier and Type	Method	Description
static JvmBufferPoolMetrics.Builder	builder()
static JvmBufferPoolMetrics.Builder	builder(PrometheusProperties config)
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

JVM_BUFFER_POOL_USED_BYTES

private static final String JVM_BUFFER_POOL_USED_BYTES

See Also:

• Constant Field Values

JVM_BUFFER_POOL_CAPACITY_BYTES

private static final String JVM_BUFFER_POOL_CAPACITY_BYTES

See Also:

• Constant Field Values

JVM_BUFFER_POOL_USED_BUFFERS

private static final String JVM_BUFFER_POOL_USED_BUFFERS

See Also:

• Constant Field Values

config

private final PrometheusProperties config

bufferPoolBeans

private final List<BufferPoolMXBean> bufferPoolBeans

constLabels

private final Labels constLabels

Constructor Details

JvmBufferPoolMetrics

private JvmBufferPoolMetrics(List<BufferPoolMXBean> bufferPoolBeans,
 PrometheusProperties config,
 Labels constLabels)

Method Details

register

private void register(PrometheusRegistry registry)

builder

public static JvmBufferPoolMetrics.Builder builder()

builder

public static JvmBufferPoolMetrics.Builder builder(PrometheusProperties config)