com.bonitasoft.engine.api

Interface PlatformMonitoringAPI

public interface PlatformMonitoringAPI

The PlatformMonitoringAPI allows to monitor certains indicator at platform level. Some indicators are based on the JVM running the platform.

Author:

Zhao Na, Elias Ricken de Medeiros, Feng Hui, Matthieu Chaffotte

Method Summary

Methods

Modifier and Type	Method and Description
int	getAvailableProcessors() Returns the number of processors available to the Java virtual machine.
long	getCommittedVirtualMemorySize() Returns the amount of virtual memory that is guaranteed to be available to the running process in bytes, or -1 if this operation is not supported.
long	getCurrentMemoryUsage() Get the sum of both heap and non-heap memory usage.
long	getFreePhysicalMemorySize() Get the amount of free physical memory in bytes.
long	getFreeSwapSpaceSize() Get the amount of free swap space in bytes.
String	getJvmName() Returns the Java virtual machine implementation name.
Map<String,String>	getJvmSystemProperties() Returns the Java virtual machine System properties list.
String	getJvmVendor() Returns the Java virtual machine implementation vendor.
String	getJvmVersion() Returns the Java virtual machine implementation version.
Map<String,GcInfo>	getLastGcInfo() Returns the last GC info.
float	getMemoryUsagePercentage() Returns the percentage of memory used compare to maximum available memory.
long	getNumberOfActiveTransactions() Get the number of all active transactions If no active transactions there, return 0
String	getOSArch() Returns the operating system architecture.
String	getOSName() Return the OS name.
String	getOSVersion() Return the OS version.
long	getProcessCpuTime() Returns the CPU time used by the process on which the Java virtual machine is running in nanoseconds.
long	getStartTime() Returns a timestamp (in millisecond) which indicates the date when the Java virtual machine started.
double	getSystemLoadAverage() Returns the system load average for the last minute.
int	getThreadCount() Returns the current number of live threads including both daemon and non-daemon threads.
long	getTotalPhysicalMemorySize() Get the total amount of physical memory in bytes.
long	getTotalSwapSpaceSize() Get the total amount of swap space in bytes.
long	getTotalThreadsCpuTime() Returns the total CPU time for all live threads in nanoseconds.
long	getUpTime() Returns the number of milliseconds elapsed since the Java Virtual Machine started.
boolean	isOptionalMonitoringInformationAvailable() Returns true if engine is running on top of a SUN/Oracle JVM
boolean	isSchedulerStarted() Check if the scheduler is started.

Method Detail

getCurrentMemoryUsage

long getCurrentMemoryUsage()
                           throws MonitoringException

Get the sum of both heap and non-heap memory usage.

Returns:

a quantity number of memory occupied currently

Throws:

MonitoringException - occurs when an exception is thrown during monitoring

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

Since:

6.0

getMemoryUsagePercentage

float getMemoryUsagePercentage()
                               throws MonitoringException

Returns the percentage of memory used compare to maximum available memory. This calculation is based on both the heap & non-heap maximum amount of memory that can be used.

Returns:

a percentage of memory occupied compare to maximum available memory

Throws:

MonitoringException - occurs when an exception is thrown during monitoring

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

Since:

6.0

getSystemLoadAverage

double getSystemLoadAverage()
                            throws MonitoringException

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.

Returns:

a average number of system load for the last minute

Throws:

MonitoringException - occurs when an exception is thrown during monitoring

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

Since:

6.0

getUpTime

long getUpTime()
               throws MonitoringException

Returns the number of milliseconds elapsed since the Java Virtual Machine started.

Returns:

a number of milliseconds elapsed since the Java Virtual Machine started

Throws:

MonitoringException - occurs when an exception is thrown during monitoring

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

Since:

6.0

getStartTime

long getStartTime()
                  throws MonitoringException

Returns a timestamp (in millisecond) which indicates the date when the Java virtual machine started. Usually, a timestamp represents the time elapsed since the 1st of January, 1970.

Returns:

a timestamp (in millisecond) which indicates the date when the Java virtual machine started

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

Since:

6.0

getTotalThreadsCpuTime

long getTotalThreadsCpuTime()
                            throws MonitoringException

Returns the total CPU time for all live threads in nanoseconds. It sums the CPU time consumed by each live threads.

Returns:

the total CPU time for all live threads in nanoseconds

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

Since:

6.0

getThreadCount

int getThreadCount()
                   throws MonitoringException

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

Returns:

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

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

Since:

6.0

getAvailableProcessors

int getAvailableProcessors()
                           throws MonitoringException

Returns the number of processors available to the Java virtual machine.

Returns:

the number of processors available to the Java virtual machine

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

Since:

6.0

getOSArch

String getOSArch()
                 throws MonitoringException

Returns the operating system architecture.

Returns:

the operating system architecture as a string

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

Since:

6.0

getOSName

String getOSName()
                 throws MonitoringException

Return the OS name.

Returns:

the OS name

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

Since:

6.0

getOSVersion

String getOSVersion()
                    throws MonitoringException

Return the OS version.

Returns:

the OS version

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

Since:

6.0

getJvmName

String getJvmName()
                  throws MonitoringException

Returns the Java virtual machine implementation name.

Returns:

the Java virtual machine implementation name

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

Since:

6.0

getJvmVendor

String getJvmVendor()
                    throws MonitoringException

Returns the Java virtual machine implementation vendor.

Returns:

the Java virtual machine implementation vendor

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

Since:

6.0

getJvmVersion

String getJvmVersion()
                     throws MonitoringException

Returns the Java virtual machine implementation version.

Returns:

the Java virtual machine implementation version

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

Since:

6.0

getJvmSystemProperties

Map<String,String> getJvmSystemProperties()
                                          throws MonitoringException

Returns the Java virtual machine System properties list.

Returns:

a map of the Java virtual machine System properties

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

Since:

6.0

isSchedulerStarted

boolean isSchedulerStarted()
                           throws MonitoringException

Check if the scheduler is started. If it is started, return true. else return false.

Returns:

if the scheduler is started

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

Since:

6.0

getNumberOfActiveTransactions

long getNumberOfActiveTransactions()
                                   throws MonitoringException

Get the number of all active transactions If no active transactions there, return 0

Returns:

a number of active transaction

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

Since:

6.0

getProcessCpuTime

long getProcessCpuTime()
                       throws MonitoringException,
                              UnavailableInformationException

Returns the CPU time used by the process on which the Java virtual machine is running in nanoseconds. The returned value is of nanoseconds precision but not necessarily nanoseconds accuracy. This method returns -1 if the the platform does not support this operation.

Returns:

the CPU time used by the process in nanoseconds, or -1 if this operation is not supported.

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

UnavailableInformationException - if the Process CPU time is not available for the current JVM.

Since:

6.0

getCommittedVirtualMemorySize

long getCommittedVirtualMemorySize()
                                   throws MonitoringException,
                                          UnavailableInformationException

Returns the amount of virtual memory that is guaranteed to be available to the running process in bytes, or -1 if this operation is not supported.

Returns:

the amount of virtual memory

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

UnavailableInformationException - if the information is not available for the current JVM

Since:

6.0

getTotalSwapSpaceSize

long getTotalSwapSpaceSize()
                           throws MonitoringException,
                                  UnavailableInformationException

Get the total amount of swap space in bytes.

Returns:

the total amount of swap space in bytes

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

UnavailableInformationException - if the information is not available for the current JVM

Since:

6.0

getFreeSwapSpaceSize

long getFreeSwapSpaceSize()
                          throws MonitoringException,
                                 UnavailableInformationException

Get the amount of free swap space in bytes.

Returns:

the amount of free swap space in bytes

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

UnavailableInformationException - if the information is not available for the current JVM

Since:

6.0

getFreePhysicalMemorySize

long getFreePhysicalMemorySize()
                               throws MonitoringException,
                                      UnavailableInformationException

Get the amount of free physical memory in bytes.

Returns:

the amount of free physical memory in bytes.

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

UnavailableInformationException - if the information is not available for the current JVM

Since:

6.0

getTotalPhysicalMemorySize

long getTotalPhysicalMemorySize()
                                throws MonitoringException,
                                       UnavailableInformationException

Get the total amount of physical memory in bytes.

Returns:

the total amount of physical memory in bytes

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

UnavailableInformationException - if the information is not available for the current JVM

Since:

6.0

isOptionalMonitoringInformationAvailable

boolean isOptionalMonitoringInformationAvailable()
                                                 throws MonitoringException

Returns true if engine is running on top of a SUN/Oracle JVM

Returns:

true if engine is running on top of a SUN/Oracle JVM, false otherwise

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

Since:

6.0

getLastGcInfo

Map<String,GcInfo> getLastGcInfo()
                                 throws MonitoringException,
                                        UnavailableInformationException

Returns the last GC info. The key 'GcName' of the outer map is the GarbageCollectorMXBean's instance name. The inner Map represents the LastGcInfo instance. The possible keys are StartTime, EndTime, Duration, MemoryUsageBeforeGc and MemoryUsageAfterGc.

Returns:

the resulting map

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

MonitoringException - occurs when an exception is thrown during monitoring

UnavailableInformationException - if the information is not available for the current JVM

Since:

6.0