Package io.micrometer.core.instrument.binder.jvm

Class JvmMemoryMetrics

java.lang.Object

io.micrometer.core.instrument.binder.jvm.JvmMemoryMetrics

All Implemented Interfaces:

MeterBinder

public class JvmMemoryMetrics
extends Object
implements MeterBinder

Record metrics that report utilization of various memory and buffer pools.

See Also:

• MemoryPoolMXBean
• BufferPoolMXBean

Constructor Summary

Constructors

Constructor	Description
JvmMemoryMetrics()
JvmMemoryMetrics(Iterable<? extends Tag> extraTags, JvmMemoryMeterConventions conventions)	Memory metrics with extra tags and a specific convention applied to meters.
JvmMemoryMetrics(Iterable<Tag> extraTags)	Uses the default convention with the provided extra tags.

Method Summary

Modifier and Type	Method	Description
void	bindTo(MeterRegistry registry)

Methods inherited from class java.lang.Object

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

Constructor Details

JvmMemoryMetrics

public JvmMemoryMetrics()

JvmMemoryMetrics

public JvmMemoryMetrics(Iterable<Tag> extraTags)

Uses the default convention with the provided extra tags.

Parameters:

extraTags - tags to add to each meter's tags produced by this binder

JvmMemoryMetrics

public JvmMemoryMetrics(Iterable<? extends Tag> extraTags,
 JvmMemoryMeterConventions conventions)

Memory metrics with extra tags and a specific convention applied to meters. The supplied extra tags are not combined with the convention. Provide a convention that applies the extra tags if that is the desired outcome. The convention only applies to some meters.

Parameters:

extraTags - these will be added to meters not covered by the convention

conventions - custom conventions for applicable metrics

Since:

1.16.0

Method Details

bindTo

public void bindTo(MeterRegistry registry)

Specified by:

bindTo in interface MeterBinder