net.centro.rtb.monitoringcenter.metrics.system.os

Interface OperatingSystemStatus

All Known Implementing Classes:

OperatingSystemMetricSet

public interface OperatingSystemStatus

This interface holds the current readings for OS-level data points (such as CPU load, RAM usage, swap space usage, and disk usage). All metrics exposed by this class are immutable by the client.

See Also:

OperatingSystemMXBean, OperatingSystemMXBean, UnixOperatingSystemMXBean

Method Summary

Modifier and Type	Method and Description
com.codahale.metrics.Gauge<Integer>	getAvailableLogicalProcessorsGauge() Retrieves the number of logical processors as observed by the JVM.
com.codahale.metrics.Gauge<Long>	getCommittedVirtualMemorySizeInBytesGauge() Retrieves the amount of virtual memory that is guaranteed to be available to the running process in bytes.
com.codahale.metrics.Gauge<Long>	getFreeDiskSpaceInBytesGauge() Retrieves the free disk space in bytes for the root path ("/").
com.codahale.metrics.Gauge<Long>	getFreePhysicalMemorySizeInBytesGauge() Retrieves the amount of free physical memory in bytes.
com.codahale.metrics.Gauge<Long>	getFreeSwapSpaceSizeInBytesGauge() Retrieves the amount of free swap space in bytes.
com.codahale.metrics.Gauge<Double>	getIoWaitPercentageGauge() Retrieves a recent UNIX iowait (percentage of CPU blocked for IO) value as reported in the output for the iostat command.
com.codahale.metrics.Gauge<Double>	getJvmCpuBusyPercentageGauge() Retrieves the recent CPU usage for the JVM process.
com.codahale.metrics.Gauge<Long>	getMaxFileDescriptorsGauge() Retrieves the maximum number of file descriptors.
com.codahale.metrics.Gauge<Long>	getOpenFileDescriptorsGauge() Retrieves the number of open file descriptors.
com.codahale.metrics.Gauge<Double>	getSystemCpuBusyPercentageGauge() Retrieves the recent CPU usage for the whole system.
com.codahale.metrics.Gauge<Double>	getSystemLoadAverageGauge() Retrieves the UNIX system load average for the past minute.
com.codahale.metrics.Gauge<Double>	getSystemLoadAveragePerLogicalProcessorGauge() Retrieves the UNIX system load average for the past minute divided by the number of logical processors.
com.codahale.metrics.Gauge<Long>	getTotalDiskSpaceInBytesGauge() Retrieves the total disk space in bytes for the root path ("/").
com.codahale.metrics.Gauge<Long>	getTotalPhysicalMemorySizeInBytesGauge() Retrieves the total amount of physical memory in bytes.
com.codahale.metrics.Gauge<Long>	getTotalSwapSpaceSizeInBytesGauge() Retrieves the total amount of swap space in bytes.
com.codahale.metrics.Gauge<Double>	getUsedDiskSpacePercentageGauge() Retrieves the percentage of used disk space for the root path ("/").
com.codahale.metrics.Gauge<Double>	getUsedFileDescriptorsPercentageGauge() Retrieves the percentage of used file descriptors.
com.codahale.metrics.Gauge<Double>	getUsedPhysicalMemoryPercentageGauge() Retrieves the percentage of used physical memory.
com.codahale.metrics.Gauge<Double>	getUsedSwapSpacePercentageGauge() Retrieves the percentage of used swap space.

Method Detail

getAvailableLogicalProcessorsGauge

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

Retrieves the number of logical processors as observed by the JVM. Logical processors are individual cores, summed up for all sockets and, possibly, multiplied by a factor of two whenever Intel's hyper-threading technology is in play.

Returns:

a gauge holding the number of logical processors as observed by the JVM.

See Also:

OperatingSystemMXBean.getAvailableProcessors()

getSystemLoadAverageGauge

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

Retrieves the UNIX system load average for the past minute.

Returns:

a gauge holding the system load average for the past minute; null if not available.

See Also:

OperatingSystemMXBean.getSystemLoadAverage()

getSystemLoadAveragePerLogicalProcessorGauge

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

Retrieves the UNIX system load average for the past minute divided by the number of logical processors.

Returns:

a gauge holding the system load average for the past minute per logical processor; null if not available.

getJvmCpuBusyPercentageGauge

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

Retrieves the recent CPU usage for the JVM process. The returned value is in the range from 0 to 100.

Returns:

a gauge holding the percentage of the time CPU was busy recently running JVM threads; null if not available.

See Also:

OperatingSystemMXBean.getProcessCpuLoad()

getSystemCpuBusyPercentageGauge

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

Retrieves the recent CPU usage for the whole system. The returned value is in the range from 0 to 100.

Returns:

a gauge holding the percentage of the time CPU was busy recently; null if not available.

See Also:

OperatingSystemMXBean.getSystemCpuLoad()

getCommittedVirtualMemorySizeInBytesGauge

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

Retrieves the amount of virtual memory that is guaranteed to be available to the running process in bytes.

Returns:

a gauge holding the amount of virtual memory that is guaranteed to be available; null if not available.

See Also:

OperatingSystemMXBean.getCommittedVirtualMemorySize()

getTotalPhysicalMemorySizeInBytesGauge

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

Retrieves the total amount of physical memory in bytes.

Returns:

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

See Also:

OperatingSystemMXBean.getTotalPhysicalMemorySize()

getFreePhysicalMemorySizeInBytesGauge

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

Retrieves the amount of free physical memory in bytes.

Returns:

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

See Also:

OperatingSystemMXBean.getFreePhysicalMemorySize()

getUsedPhysicalMemoryPercentageGauge

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

Retrieves the percentage of used physical memory. The returned value is in the range from 0 to 100.

Returns:

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

getTotalSwapSpaceSizeInBytesGauge

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

Retrieves the total amount of swap space in bytes.

Returns:

a gauge holding the total amount of swap space in bytes; null if not available.

See Also:

OperatingSystemMXBean.getTotalSwapSpaceSize()

getFreeSwapSpaceSizeInBytesGauge

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

Retrieves the amount of free swap space in bytes.

Returns:

a gauge holding the amount of free swap space in bytes; null if not available.

See Also:

OperatingSystemMXBean.getFreeSwapSpaceSize()

getUsedSwapSpacePercentageGauge

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

Retrieves the percentage of used swap space. The returned value is in the range from 0 to 100.

Returns:

a gauge holding the percentage of used swap space; null if not available.

getMaxFileDescriptorsGauge

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

Retrieves the maximum number of file descriptors.

Returns:

a gauge holding the maximum number of file descriptors; null if not available.

See Also:

UnixOperatingSystemMXBean.getMaxFileDescriptorCount()

getOpenFileDescriptorsGauge

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

Retrieves the number of open file descriptors.

Returns:

a gauge holding the number of open file descriptors; null if not available.

See Also:

UnixOperatingSystemMXBean.getOpenFileDescriptorCount()

getUsedFileDescriptorsPercentageGauge

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

Retrieves the percentage of used file descriptors. The returned value is in the range from 0 to 100.

Returns:

a gauge holding the percentage of used file descriptors; null if not available.

getTotalDiskSpaceInBytesGauge

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

Retrieves the total disk space in bytes for the root path ("/").

Returns:

a gauge holding the total disk space in bytes for the root path; null if not available

See Also:

File.getTotalSpace()

getFreeDiskSpaceInBytesGauge

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

Retrieves the free disk space in bytes for the root path ("/").

Returns:

a gauge holding the free disk space in bytes for the root path; null if not available

See Also:

()

getUsedDiskSpacePercentageGauge

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

Retrieves the percentage of used disk space for the root path ("/"). The returned value is in the range from 0 to 100.

Returns:

a gauge holding the percentage of used disk space for the root path; null if not available.

getIoWaitPercentageGauge

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

Retrieves a recent UNIX iowait (percentage of CPU blocked for IO) value as reported in the output for the iostat command. The returned value is in the range from 0 to 100.

Returns:

a gauge holding a recent UNIX iowait value; null if not available.