Interface JvmMemoryUsedMeterConvention

All Known Implementing Classes:

MicrometerJvmMemoryUsedMeterConvention, OpenTelemetryJvmMemoryUsedMeterConvention

public interface JvmMemoryUsedMeterConvention

Convention for JVM memory used metrics.

Since:

1.18.0

See Also:

• JvmMemoryMetrics

Method Summary

Modifier and Type	Method	Description
String	getName()	Canonical name of the meter.
default Tags	getTags(MemoryPoolMXBean memoryPoolBean)	Tags specific to this meter convention.
static JvmMemoryUsedMeterConvention	of(String name)	Create a JvmMemoryUsedMeterConvention with the given name.
static JvmMemoryUsedMeterConvention	of(String name, Function<MemoryPoolMXBean, Tags> tagsFunction)	Create a JvmMemoryUsedMeterConvention with the given name and tags function.

Method Details

getName

String getName()

Canonical name of the meter.

Returns:

meter name

getTags

default Tags getTags(MemoryPoolMXBean memoryPoolBean)

Tags specific to this meter convention.

Parameters:

memoryPoolBean - the memory pool bean from which to derive tags

Returns:

tags to use with the meter

of

static JvmMemoryUsedMeterConvention of(String name)

Create a JvmMemoryUsedMeterConvention with the given name.

Parameters:

name - meter name

Returns:

a new convention instance

of

static JvmMemoryUsedMeterConvention of(String name,
 Function<MemoryPoolMXBean, Tags> tagsFunction)

Create a JvmMemoryUsedMeterConvention with the given name and tags function.

Parameters:

name - meter name

tagsFunction - function to derive tags from a MemoryPoolMXBean

Returns:

a new convention instance