net.centro.rtb.monitoringcenter.metrics.system.jvm

Interface MemoryUsageStatus

public interface MemoryUsageStatus

This interface encompasses the current readings for JVM memory usage for a particular memory pool or for the entire heap or non-heap space. All metrics exposed by this class are immutable by the client.

See Also:

MemoryUsage

Method Summary

Modifier and Type	Method and Description
com.codahale.metrics.Gauge<Long>	getCommittedMemoryInBytesGauge() Retrieves the amount of memory in bytes that is committed (i.e., guaranteed) for the JVM to use.
com.codahale.metrics.Gauge<Long>	getInitialSizeInBytesGauge() Retrieves the amount of memory in bytes that the JVM initially requests from the operating system for memory management.
com.codahale.metrics.Gauge<Long>	getMaxAvailableMemoryInBytesGauge() Retrieves the maximum amount of memory in bytes that can be used for memory management.
com.codahale.metrics.Gauge<Long>	getUsedMemoryInBytesGauge() Retrieves the amount of used memory in bytes.
com.codahale.metrics.Gauge<Double>	getUsedMemoryPercentageGauge() Retrieves the percentage of used memory.

Method Detail

getInitialSizeInBytesGauge

com.codahale.metrics.Gauge<Long> getInitialSizeInBytesGauge()

Retrieves the amount of memory in bytes that the JVM initially requests from the operating system for memory management.

Returns:

a gauge holding the initial size of memory in bytes; null if not available.

See Also:

MemoryUsage.getInit()

getUsedMemoryInBytesGauge

com.codahale.metrics.Gauge<Long> getUsedMemoryInBytesGauge()

Retrieves the amount of used memory in bytes.

Returns:

a gauge holding the amount of used memory in bytes.

See Also:

MemoryUsage.getUsed()

getMaxAvailableMemoryInBytesGauge

com.codahale.metrics.Gauge<Long> getMaxAvailableMemoryInBytesGauge()

Retrieves the maximum amount of memory in bytes that can be used for memory management.

Returns:

a gauge holding the maximum amount of memory in bytes; null if not available.

See Also:

MemoryUsage.getMax()

getCommittedMemoryInBytesGauge

com.codahale.metrics.Gauge<Long> getCommittedMemoryInBytesGauge()

Retrieves the amount of memory in bytes that is committed (i.e., guaranteed) for the JVM to use.

Returns:

a gauge holding the amount of memory in bytes that is committed (i.e., guaranteed) for the JVM to use.

See Also:

MemoryUsage.getCommitted()

getUsedMemoryPercentageGauge

com.codahale.metrics.Gauge<Double> getUsedMemoryPercentageGauge()

Retrieves the percentage of used memory. The divisor is either the maximum available amount of memory or the committed amount of memory, depending on the availability of the former. The returned value is in the range from 0 to 100.

Returns:

a gauge holding the percentage of used memory; null if not applicable.