org.gridgain.grid.spi.metrics.jdk
Class GridJdkLocalMetricsSpi

java.lang.Object
  org.gridgain.grid.spi.GridSpiAdapter
      org.gridgain.grid.spi.metrics.jdk.GridJdkLocalMetricsSpi

All Implemented Interfaces:

Serializable, GridSpi, GridSpiJsonConfigurable, GridSpiManagementMBean, GridLocalMetrics, GridLocalMetricsSpi, GridJdkLocalMetricsSpiMBean

@GridSpiInfo(author="GridGain Systems",
             url="www.gridgain.com",
             email="support@gridgain.com",
             version="3.6.0e.13012012")
@GridSpiMultipleInstancesSupport(value=true)
public class GridJdkLocalMetricsSpi
extends GridSpiAdapter
implements GridLocalMetricsSpi, GridJdkLocalMetricsSpiMBean

This class provides JDK MXBean based local VM metrics. Note that average CPU load cannot be obtained from JDK 1.5 and on some operating systems (including Windows Vista) even from JDK 1.6 (although JDK 1.6 supposedly added support for it). For cases when CPU load cannot be obtained from JDK, GridGain ships with Hyperic SIGAR metrics.

If CPU load cannot be obtained either from JDK or Hyperic, then GridLocalMetrics.getCurrentCpuLoad() method will always return -1.

Configuration

Mandatory

This SPI has no mandatory configuration parameters.

Optional

The following configuration parameters are optional:

• Always prefer Hyperic Sigar regardless of JDK version (see GridJdkLocalMetricsSpi.setPreferSigar(boolean))

Wiki & Forum:

Wiki
Forum

See Also:

Serialized Form

Constructor Summary

GridJdkLocalMetricsSpi()

Method Summary

int	getAvailableProcessors() Returns the number of processors available to the Java virtual machine.
double	getCurrentCpuLoad() Returns the system load average for the last minute.
int	getDaemonThreadCount() Returns the current number of live daemon threads.
long	getFileSystemFreeSpace() Returns the number of unallocated bytes in the partition.
String	getFileSystemRoot() Gets root from which file space metrics should be counted.
long	getFileSystemTotalSpace() Returns size of the partition.
long	getFileSystemUsableSpace() Returns the number of bytes available to this virtual machine on the partition.
long	getHeapMemoryCommitted() Returns the amount of heap memory in bytes that is committed for the Java virtual machine to use.
long	getHeapMemoryInitialized() Returns the amount of heap memory in bytes that the Java virtual machine initially requests from the operating system for memory management.
long	getHeapMemoryMaximum() Returns the maximum amount of heap memory in bytes that can be used for memory management.
long	getHeapMemoryUsed() Returns the current heap size that is used for object allocation.
GridLocalMetrics	getMetrics() Provides local VM metrics.
long	getNonHeapMemoryCommitted() Returns the amount of non-heap memory in bytes that is committed for the Java virtual machine to use.
long	getNonHeapMemoryInitialized() Returns the amount of non-heap memory in bytes that the Java virtual machine initially requests from the operating system for memory management.
long	getNonHeapMemoryMaximum() Returns the maximum amount of non-heap memory in bytes that can be used for memory management.
long	getNonHeapMemoryUsed() Returns the current non-heap memory size that is used by Java VM.
int	getPeakThreadCount() Returns the peak live thread count since the Java virtual machine started or peak was reset.
long	getStartTime() Returns the start time of the Java virtual machine in milliseconds.
int	getThreadCount() Returns the current number of live threads including both daemon and non-daemon threads.
long	getTotalStartedThreadCount() Returns the total number of threads created and also started since the Java virtual machine started.
long	getUptime() Returns the uptime of the Java virtual machine in milliseconds.
boolean	isFileSystemMetricsEnabled() Checks whether file system metrics are enabled.
boolean	isPreferSigar() Configuration parameter indicating if Hyperic Sigar should be used regardless of JDK version.
void	setFileSystemMetricsEnabled(boolean enableFsMetrics) Enables or disables file system metrics (default is false).
void	setFileSystemRoot(String fsRoot) Set file system root.
void	setPreferSigar(boolean preferSigar) Configuration parameter indicating if Hyperic Sigar should be used regardless of JDK version.
void	spiStart(String gridName) This method is called to start SPI.
void	spiStop() This method is called to stop SPI.
String	toString()

Methods inherited from class org.gridgain.grid.spi.GridSpiAdapter

assertParameter, checkConfigurationConsistency, configInfo, createSpiAttributeName, getAuthor, getConsistentAttributeNames, getGridGainHome, getLocalNodeId, getName, getNodeAttributes, getSpiContext, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted, getVendorEmail, getVendorUrl, getVersion, injectables, onContextDestroyed, onContextInitialized, registerMBean, setJson, setName, startInfo, startStopwatch, stopInfo, unregisterMBean

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.spi.GridSpi

getName, getNodeAttributes, onContextDestroyed, onContextInitialized

Methods inherited from interface org.gridgain.grid.spi.GridSpiJsonConfigurable

setJson

Methods inherited from interface org.gridgain.grid.spi.GridSpiManagementMBean

getAuthor, getGridGainHome, getLocalNodeId, getName, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted, getVendorEmail, getVendorUrl, getVersion

Constructor Detail

GridJdkLocalMetricsSpi

public GridJdkLocalMetricsSpi()

Method Detail

isPreferSigar

public boolean isPreferSigar()

Configuration parameter indicating if Hyperic Sigar should be used regardless of JDK version. Hyperic Sigar is used to provide CPU load. Starting with JDK 1.6, method OperatingSystemMXBean.getSystemLoadAverage() method was added. However, even in 1.6 and higher this method does not always provide CPU load on some operating systems - in such cases Hyperic Sigar will be used automatically.

Specified by:

isPreferSigar in interface GridJdkLocalMetricsSpiMBean

Returns:

If true then Hyperic Sigar should be used regardless of JDK version, if false, then implementation will attempt to use OperatingSystemMXBean.getSystemLoadAverage() for JDK 1.6 and higher.

setPreferSigar

@GridSpiConfiguration(optional=true)
public void setPreferSigar(boolean preferSigar)

Configuration parameter indicating if Hyperic Sigar should be used regardless of JDK version. Hyperic Sigar is used to provide CPU load. Starting with JDK 1.6, method OperatingSystemMXBean.getSystemLoadAverage() method was added. However, even in 1.6 and higher this method does not always provide CPU load on some operating systems (or provides incorrect value) - in such cases Hyperic Sigar will be used automatically.

By default the value is true.

Parameters:

preferSigar - If true then Hyperic Sigar should be used regardless of JDK version, if false, then implementation will attempt to use OperatingSystemMXBean.getSystemLoadAverage() for JDK 1.6 and higher.

setFileSystemRoot

@GridSpiConfiguration(optional=true)
public void setFileSystemRoot(String fsRoot)

Set file system root.

Parameters:

fsRoot - File system root.

getFileSystemRoot

public String getFileSystemRoot()

Gets root from which file space metrics should be counted. This property only makes sense if GridJdkLocalMetricsSpiMBean.isFileSystemMetricsEnabled() set to true.

Specified by:

getFileSystemRoot in interface GridJdkLocalMetricsSpiMBean

Returns:

Root from which file space metrics should be counted.

setFileSystemMetricsEnabled

@GridSpiConfiguration(optional=true)
public void setFileSystemMetricsEnabled(boolean enableFsMetrics)

Enables or disables file system metrics (default is false). These metrics may be expensive to get in certain environments and are disabled by default. Following metrics are part of file system metrics:

• GridLocalMetrics.getFileSystemFreeSpace()
• GridLocalMetrics.getFileSystemTotalSpace()
• GridLocalMetrics.getFileSystemUsableSpace()

Parameters:

enableFsMetrics - Flag indicating whether file system metrics are enabled.

isFileSystemMetricsEnabled

public boolean isFileSystemMetricsEnabled()

Checks whether file system metrics are enabled. These metrics may be expensive to get in certain environments and are disabled by default.

Specified by:

isFileSystemMetricsEnabled in interface GridJdkLocalMetricsSpiMBean

Returns:

Flag indicating whether file system metrics are enabled.

See Also:

GridJdkLocalMetricsSpi.setFileSystemMetricsEnabled(boolean)

spiStart

public void spiStart(@Nullable
                     String gridName)
              throws GridSpiException

This method is called to start SPI. After this method returns successfully kernel assumes that SPI is fully operational.

Specified by:

spiStart in interface GridSpi

Throws:

GridSpiException - Throws in case of any error during SPI start.

Parameters:

gridName - Name of grid instance this SPI is being started for (null for default grid).

spiStop

public void spiStop()
             throws GridSpiException

This method is called to stop SPI. After this method returns kernel assumes that this SPI is finished and all resources acquired by it are released.

Note that this method can be called at any point including during recovery of failed start. It should make no assumptions on what state SPI will be in when this method is called.

Specified by:

spiStop in interface GridSpi

Throws:

GridSpiException - Thrown in case of any error during SPI stop.

getMetrics

public GridLocalMetrics getMetrics()

Provides local VM metrics.

Specified by:

getMetrics in interface GridLocalMetricsSpi

Returns:

Local VM metrics.

getAvailableProcessors

public int getAvailableProcessors()

Returns the number of processors available to the Java virtual machine. This method is equivalent to the Runtime.availableProcessors() method.

This value may change during a particular invocation of the virtual machine.

Specified by:

getAvailableProcessors in interface GridLocalMetrics

Returns:

The number of processors available to the virtual machine; never smaller than one.

getCurrentCpuLoad

public double getCurrentCpuLoad()

Returns the system load average for the last minute. The system load average is the sum of the number of runnable entities queued to the available processors and the number of runnable entities running on the available processors averaged over a period of time. The way in which the load average is calculated is operating system specific but is typically a damped time-dependent average.

If the load average is not available, a negative value is returned.

This method is designed to provide a hint about the system load and may be queried frequently. The load average may be unavailable on some platform where it is expensive to implement this method.

If you are running JDK 1.6 or above and GridJdkLocalMetricsSpi.setPreferSigar(boolean) is set to false (default is true), then this method is equivalent to OperatingSystemMXBean.getSystemLoadAverage() method. Otherwise, for JDK 1.5 Hyperic Sigar monitoring will be used.

Note that Hyperic Sigar is licensed under GPL. If this license is not suitable for your business, remove hyperic libs from your classpath. In case if this method will not detect JDK 1.6 and will not find Hyperic Sigar libraries in the classpath, -1 will be returned.

Specified by:

getCurrentCpuLoad in interface GridLocalMetrics

Returns:

The system load average; or a negative value if not available.

getHeapMemoryInitialized

public long getHeapMemoryInitialized()

Returns the amount of heap memory in bytes that the Java virtual machine initially requests from the operating system for memory management. This method returns -1 if the initial memory size is undefined.

This value represents a setting of the heap memory for Java VM and is not a sum of all initial heap values for all memory pools.

Specified by:

getHeapMemoryInitialized in interface GridLocalMetrics

Returns:

The initial size of memory in bytes; -1 if undefined.

getHeapMemoryUsed

public long getHeapMemoryUsed()

Returns the current heap size that is used for object allocation. The heap consists of one or more memory pools. This value is the sum of used heap memory values of all heap memory pools.

The amount of used memory in the returned is the amount of memory occupied by both live objects and garbage objects that have not been collected, if any.

Specified by:

getHeapMemoryUsed in interface GridLocalMetrics

Returns:

Amount of heap memory used.

getHeapMemoryCommitted

public long getHeapMemoryCommitted()

Returns the amount of heap memory in bytes that is committed for the Java virtual machine to use. This amount of memory is guaranteed for the Java virtual machine to use. The heap consists of one or more memory pools. This value is the sum of committed heap memory values of all heap memory pools.

Specified by:

getHeapMemoryCommitted in interface GridLocalMetrics

Returns:

The amount of committed memory in bytes.

getHeapMemoryMaximum

public long getHeapMemoryMaximum()

Returns the maximum amount of heap memory in bytes that can be used for memory management. This method returns -1 if the maximum memory size is undefined.

This amount of memory is not guaranteed to be available for memory management if it is greater than the amount of committed memory. The Java virtual machine may fail to allocate memory even if the amount of used memory does not exceed this maximum size.

This value represents a setting of the heap memory for Java VM and is not a sum of all initial heap values for all memory pools.

Specified by:

getHeapMemoryMaximum in interface GridLocalMetrics

Returns:

The maximum amount of memory in bytes; -1 if undefined.

getNonHeapMemoryInitialized

public long getNonHeapMemoryInitialized()

Returns the amount of non-heap memory in bytes that the Java virtual machine initially requests from the operating system for memory management. This method returns -1 if the initial memory size is undefined.

This value represents a setting of non-heap memory for Java VM and is not a sum of all initial heap values for all memory pools.

Specified by:

getNonHeapMemoryInitialized in interface GridLocalMetrics

Returns:

The initial size of memory in bytes; -1 if undefined.

getNonHeapMemoryUsed

public long getNonHeapMemoryUsed()

Returns the current non-heap memory size that is used by Java VM. The non-heap memory consists of one or more memory pools. This value is the sum of used non-heap memory values of all non-heap memory pools.

Specified by:

getNonHeapMemoryUsed in interface GridLocalMetrics

Returns:

Amount of none-heap memory used.

getNonHeapMemoryCommitted

public long getNonHeapMemoryCommitted()

Returns the amount of non-heap memory in bytes that is committed for the Java virtual machine to use. This amount of memory is guaranteed for the Java virtual machine to use. The non-heap memory consists of one or more memory pools. This value is the sum of committed non-heap memory values of all non-heap memory pools.

Specified by:

getNonHeapMemoryCommitted in interface GridLocalMetrics

Returns:

The amount of committed memory in bytes.

getNonHeapMemoryMaximum

public long getNonHeapMemoryMaximum()

Returns the maximum amount of non-heap memory in bytes that can be used for memory management. This method returns -1 if the maximum memory size is undefined.

This amount of memory is not guaranteed to be available for memory management if it is greater than the amount of committed memory. The Java virtual machine may fail to allocate memory even if the amount of used memory does not exceed this maximum size.

This value represents a setting of the non-heap memory for Java VM and is not a sum of all initial non-heap values for all memory pools.

Specified by:

getNonHeapMemoryMaximum in interface GridLocalMetrics

Returns:

The maximum amount of memory in bytes; -1 if undefined.

getUptime

public long getUptime()

Returns the uptime of the Java virtual machine in milliseconds.

Specified by:

getUptime in interface GridLocalMetrics

Returns:

Uptime of the Java virtual machine in milliseconds.

getStartTime

public long getStartTime()

Returns the start time of the Java virtual machine in milliseconds. This method returns the approximate time when the Java virtual machine started.

Specified by:

getStartTime in interface GridLocalMetrics

Returns:

Start time of the Java virtual machine in milliseconds.

getThreadCount

public int getThreadCount()

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

Specified by:

getThreadCount in interface GridLocalMetrics

Returns:

the current number of live threads.

getPeakThreadCount

public int getPeakThreadCount()

Returns the peak live thread count since the Java virtual machine started or peak was reset.

Specified by:

getPeakThreadCount in interface GridLocalMetrics

Returns:

The peak live thread count.

getTotalStartedThreadCount

public long getTotalStartedThreadCount()

Returns the total number of threads created and also started since the Java virtual machine started.

Specified by:

getTotalStartedThreadCount in interface GridLocalMetrics

Returns:

The total number of threads started.

getDaemonThreadCount

public int getDaemonThreadCount()

Returns the current number of live daemon threads.

Specified by:

getDaemonThreadCount in interface GridLocalMetrics

Returns:

The current number of live daemon threads.

getFileSystemFreeSpace

public long getFileSystemFreeSpace()

Returns the number of unallocated bytes in the partition.

Specified by:

getFileSystemFreeSpace in interface GridLocalMetrics

Returns:

Number of unallocated bytes in the partition.

getFileSystemTotalSpace

public long getFileSystemTotalSpace()

Returns size of the partition.

Specified by:

getFileSystemTotalSpace in interface GridLocalMetrics

Returns:

Size of the partition.

getFileSystemUsableSpace

public long getFileSystemUsableSpace()

Returns the number of bytes available to this virtual machine on the partition.

Specified by:

getFileSystemUsableSpace in interface GridLocalMetrics

Returns:

Number of bytes available to this virtual machine on the partition.

toString

public String toString()

Overrides:

toString in class Object