Package com.microej.kf.util.monitoring

Class ResourceMonitoringServiceImpl

java.lang.Object

com.microej.kf.util.monitoring.ResourceMonitoringServiceImpl

All Implemented Interfaces:

ResourceMonitoringService, FeatureStateListener

public class ResourceMonitoringServiceImpl
extends Object
implements ResourceMonitoringService, FeatureStateListener

This class represents the implementation for the ResourceMonitoringService.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResourceMonitoringServiceImpl.MonitoringTask	This class represents the monitoring task ran at regular interval.

Constructor Summary

Constructors

Constructor	Description
ResourceMonitoringServiceImpl(Timer timer, long intervalMillis, boolean runGcBeforeCollecting)	Instantiates the resource monitoring service.

Method Summary

Modifier and Type	Method	Description
long	getFreeMemory()	Returns the free memory.
long	getMaxMemory()	Returns the max memory.
long	getTotalMemory()	Returns the total memory.
PackedMap<String,Float>	getUsedCpuPercentPerModule()	Retrieves the CPU usage for each module from the previous monitoring cycle, expressed as a percentage.
PackedMap<String,Float>	getUsedMemoryPercentPerModule()	Retrieves the RAM usage values expressed as a percentage (a value between 0 and 1.0).
PackedMap<String,Long>	getUsedMemoryPerModule()	Retrieves the current RAM usage for each module.
void	start()	Starts the resource monitoring task by enabling monitoring on each module.
void	stateChanged(Feature app, Feature.State state)	Called when the state of a Feature has changed.
void	stop()	Stops resource monitoring by disabling monitoring on each module.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceMonitoringServiceImpl

public ResourceMonitoringServiceImpl(Timer timer,
                                     long intervalMillis,
                                     boolean runGcBeforeCollecting)

Instantiates the resource monitoring service.

Parameters:

timer - the timer.

intervalMillis - the timer interval read from the kernel properties.

runGcBeforeCollecting - the boolean read from kernel properties to run GC before collecting monitoring data.

Method Detail

start

public void start()

Starts the resource monitoring task by enabling monitoring on each module.

stop

public void stop()

Stops resource monitoring by disabling monitoring on each module.

stateChanged

public void stateChanged(Feature app,
                         @Nullable
                         Feature.State state)

Description copied from interface: FeatureStateListener

Called when the state of a Feature has changed.

Specified by:

stateChanged in interface FeatureStateListener

Parameters:

app - the Feature which state has changed

state - the previous state, null if Feature state is Feature.State.INSTALLED

getUsedCpuPercentPerModule

public PackedMap<String,Float> getUsedCpuPercentPerModule()

Description copied from interface: ResourceMonitoringService

Retrieves the CPU usage for each module from the previous monitoring cycle, expressed as a percentage.

Specified by:

getUsedCpuPercentPerModule in interface ResourceMonitoringService

Returns:

a map where each entry contains a module name as the key and its CPU usage percentage (0.0 to 1.0) as the value.

getUsedMemoryPerModule

public PackedMap<String,Long> getUsedMemoryPerModule()

Description copied from interface: ResourceMonitoringService

Retrieves the current RAM usage for each module.

Specified by:

getUsedMemoryPerModule in interface ResourceMonitoringService

Returns:

a map where each entry contains a module identifier as the key and its current RAM usage in bytes as the value.

getUsedMemoryPercentPerModule

public PackedMap<String,Float> getUsedMemoryPercentPerModule()

Description copied from interface: ResourceMonitoringService

Retrieves the RAM usage values expressed as a percentage (a value between 0 and 1.0).

The percentage indicates the ratio between a module's current heap consumption and the total heap.

Specified by:

getUsedMemoryPercentPerModule in interface ResourceMonitoringService

Returns:

a map where each entry contains the module name as the key and its current RAM usage percentage as the value.

getFreeMemory

public long getFreeMemory()

Description copied from interface: ResourceMonitoringService

Returns the free memory.

Specified by:

getFreeMemory in interface ResourceMonitoringService

Returns:

the free memory.

getMaxMemory

public long getMaxMemory()

Description copied from interface: ResourceMonitoringService

Returns the max memory.

Specified by:

getMaxMemory in interface ResourceMonitoringService

Returns:

the max memory.

getTotalMemory

public long getTotalMemory()

Description copied from interface: ResourceMonitoringService

Returns the total memory.

Specified by:

getTotalMemory in interface ResourceMonitoringService

Returns:

the total memory.