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

Interface JvmStatus

All Known Implementing Classes:

JvmMetricSet

public interface JvmStatus

This interface encompasses the current readings for various JVM data points, involving such realms as threads, classes, buffer pools, memory utilization, and garbage collection. All metrics exposed by this class are immutable by the client.

Method Summary

Modifier and Type	Method and Description
List<BufferPoolStatus>	getBufferPoolStatuses() Retrieves a list of buffer pool statuses.
com.codahale.metrics.Gauge<Integer>	getCurrentlyLoadedClassesGauge() Retrieves the number of classes that are currently loaded in the JVM.
com.codahale.metrics.Gauge<Integer>	getCurrentThreadsGauge() Retrieves the current number of live threads including both daemon and non-daemon threads.
com.codahale.metrics.Gauge<Integer>	getDaemonThreadsGauge() Retrieves the current number of live daemon threads.
com.codahale.metrics.Gauge<Integer>	getDeadlockedThreadsGauge() Retrieves the number of threads that are currently deadlocked.
com.codahale.metrics.Gauge<Long>	getFullGcCollectionsGauge() Retrieves the number of full garbage collections since the JVM started execution.
List<GarbageCollectorStatus>	getGarbageCollectorStatuses() Retrieves a list of garbage collector statuses.
MemoryUsageStatus	getHeapMemoryUsageStatus() Retrieves the memory usage status of the heap space.
com.codahale.metrics.Timer	getMajorGcTimer() Retrieves the timer for major garbage collections.
List<MemoryPoolStatus>	getMemoryPoolStatuses() Retrieves a list of memory pool statuses.
com.codahale.metrics.Timer	getMinorGcTimer() Retrieves the timer for minor garbage collections.
MemoryUsageStatus	getNonHeapMemoryUsageStatus() Retrieves the memory usage status of the non-heap space.
com.codahale.metrics.Gauge<Integer>	getPeakThreadsGauge() Retrieves the peak live thread count since the JVM started or peak was reset.
Map<Thread.State,com.codahale.metrics.Gauge<Integer>>	getThreadsGaugesByThreadStates() Retrieves current thread counts by thread states.
com.codahale.metrics.Gauge<Long>	getTotalLoadedClassesGauge() Retrieves the total number of classes loaded since the JVM started execution.
MemoryUsageStatus	getTotalMemoryUsageStatus() Retrieves the total memory usage status, including both heap and non-heap spaces.
com.codahale.metrics.Gauge<Long>	getUnloadedClassesGauge() Retrieves the total number of classes unloaded since the JVM started execution.
com.codahale.metrics.Gauge<Long>	getUptimeInMillisGauge() Retrieves the uptime of the JVM in milliseconds.

Method Detail

getTotalLoadedClassesGauge

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

Retrieves the total number of classes loaded since the JVM started execution.

Returns:

a gauge holding the total number of classes loaded in the lifetime of this JVM.

See Also:

ClassLoadingMXBean.getTotalLoadedClassCount()

getUnloadedClassesGauge

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

Retrieves the total number of classes unloaded since the JVM started execution.

Returns:

a gauge holding the total number of classes unloaded since the JVM started execution.

See Also:

ClassLoadingMXBean.getUnloadedClassCount()

getCurrentlyLoadedClassesGauge

com.codahale.metrics.Gauge<Integer> getCurrentlyLoadedClassesGauge()

Retrieves the number of classes that are currently loaded in the JVM.

Returns:

a gauge holding the number of classes that are currently loaded in the JVM.

See Also:

ClassLoadingMXBean.getLoadedClassCount()

getCurrentThreadsGauge

com.codahale.metrics.Gauge<Integer> getCurrentThreadsGauge()

Retrieves the current number of live threads including both daemon and non-daemon threads.

Returns:

a gauge holding the current number of live threads.

See Also:

ThreadMXBean.getThreadCount()

getPeakThreadsGauge

com.codahale.metrics.Gauge<Integer> getPeakThreadsGauge()

Retrieves the peak live thread count since the JVM started or peak was reset.

Returns:

a gauge holding the peak live thread count.

See Also:

ThreadMXBean.getPeakThreadCount()

getDaemonThreadsGauge

com.codahale.metrics.Gauge<Integer> getDaemonThreadsGauge()

Retrieves the current number of live daemon threads.

Returns:

a gauge holding the current number of live daemon threads.

See Also:

ThreadMXBean.getDaemonThreadCount()

getDeadlockedThreadsGauge

com.codahale.metrics.Gauge<Integer> getDeadlockedThreadsGauge()

Retrieves the number of threads that are currently deadlocked.

Returns:

a gauge holding the number of threads that are currently deadlocked.

See Also:

ThreadMXBean.findDeadlockedThreads()

getThreadsGaugesByThreadStates

Map<Thread.State,com.codahale.metrics.Gauge<Integer>> getThreadsGaugesByThreadStates()

Retrieves current thread counts by thread states.

Returns:

a map of gauges holding current thread counts by thread states.

getBufferPoolStatuses

List<BufferPoolStatus> getBufferPoolStatuses()

Retrieves a list of buffer pool statuses. An empty list is returned if no buffer pool data is available.

Returns:

a list of buffer pool statuses.

getFullGcCollectionsGauge

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

Retrieves the number of full garbage collections since the JVM started execution.

Returns:

a gauge holding the number of full garbage collections; null if not available.

getMajorGcTimer

com.codahale.metrics.Timer getMajorGcTimer()

Retrieves the timer for major garbage collections.

Returns:

the timer for major garbage collections.

getMinorGcTimer

com.codahale.metrics.Timer getMinorGcTimer()

Retrieves the timer for minor garbage collections.

Returns:

the timer for minor garbage collections.

getGarbageCollectorStatuses

List<GarbageCollectorStatus> getGarbageCollectorStatuses()

Retrieves a list of garbage collector statuses. An empty list is returned if no garbage collector data is available.

Returns:

a list of garbage collector statuses.

getTotalMemoryUsageStatus

MemoryUsageStatus getTotalMemoryUsageStatus()

Retrieves the total memory usage status, including both heap and non-heap spaces.

Returns:

the total memory usage status.

getHeapMemoryUsageStatus

MemoryUsageStatus getHeapMemoryUsageStatus()

Retrieves the memory usage status of the heap space.

Returns:

the memory usage status of the heap space.

See Also:

MemoryMXBean.getHeapMemoryUsage()

getNonHeapMemoryUsageStatus

MemoryUsageStatus getNonHeapMemoryUsageStatus()

Retrieves the memory usage status of the non-heap space.

Returns:

the memory usage status of the non-heap space.

See Also:

MemoryMXBean.getNonHeapMemoryUsage()

getMemoryPoolStatuses

List<MemoryPoolStatus> getMemoryPoolStatuses()

Retrieves a list of memory pool statuses. An empty list is returned if no memory pool data is available.

Returns:

a list of memory pool statuses.

getUptimeInMillisGauge

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

Retrieves the uptime of the JVM in milliseconds.

Returns:

a gauge holding the uptime of the Java virtual machine in milliseconds.

See Also:

RuntimeMXBean.getUptime()