org.hawkular.agent.monitor.protocol.platform

Class OshiPlatformCache

java.lang.Object

org.hawkular.agent.monitor.protocol.platform.OshiPlatformCache

public class OshiPlatformCache
extends Object

This caches a snapshot of platform data as provided by the OSHI library. If you want to refresh the cache with new values, you must call refresh(), otherwise, the same cached values will be used across calls.

Author:

John Mazzitelli

Constructor Summary

Constructors

Constructor and Description
OshiPlatformCache(String feedId, String machineId) Creates the cache of OSHi platform data.

Method Summary

Modifier and Type	Method and Description
Map<PlatformPath,PlatformResourceNode>	discoverResources(PlatformPath platformPath) Helps with discovery of platform resources by obtaining all the resources of the given path.
Double	getFileStoreMetric(String fileStoreNameName, Name metricToCollect) Returns the given metric's value, or null if there is no file store with the given name.
Map<String,oshi.software.os.OSFileStore>	getFileStores()
String	getMachineId()
oshi.hardware.GlobalMemory	getMemory()
Double	getMemoryMetric(Name metricToCollect) Returns the given memory metric's value.
Double	getMetric(PlatformResourceNode node, Name metricToCollect) Given a platform resource node and a metric name, this will return that metric's value, or null if there is no resource that can be identified by the node.
oshi.software.os.OperatingSystem	getOperatingSystem()
Double	getOperatingSystemMetric(Name metricToCollect) Returns the given OS metric's value.
Double	getPowerSourceMetric(String powerSourceName, Name metricToCollect) Returns the given metric's value, or null if there is no power source with the given name.
Map<String,oshi.hardware.PowerSource>	getPowerSources()
oshi.hardware.CentralProcessor	getProcessor()
Double	getProcessorMetric(String processorNumber, Name metricToCollect) Returns the given metric's value, or null if there is no processor with the given number.
void	refresh() Clears the cache of all OSHI data.

Methods inherited from class java.lang.Object

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

Constructor Detail

OshiPlatformCache

public OshiPlatformCache(String feedId,
                         String machineId)

Creates the cache of OSHi platform data.

Parameters:

feedId - he feed ID

machineId - the machine ID - if null, one will be attempted to be discovered

See Also:

Util.getSystemId()

Method Detail

refresh

public void refresh()

Clears the cache of all OSHI data. Subsequent calls to retrieve data will be refreshed with the latest data (but will be more expensive since the data has to be recollected from the underlying operating system).

getOperatingSystem

public oshi.software.os.OperatingSystem getOperatingSystem()

Returns:

information about the operating system.

getFileStores

public Map<String,oshi.software.os.OSFileStore> getFileStores()

Returns:

information about all file stores on the platform

getMemory

public oshi.hardware.GlobalMemory getMemory()

Returns:

information about all the platform's memory

getProcessor

public oshi.hardware.CentralProcessor getProcessor()

Returns:

information about all processors/CPUs on the platform

getPowerSources

public Map<String,oshi.hardware.PowerSource> getPowerSources()

Returns:

information about all power sources (e.g. batteries) on the platform.

getPowerSourceMetric

public Double getPowerSourceMetric(String powerSourceName,
                                   Name metricToCollect)

Returns the given metric's value, or null if there is no power source with the given name.

Parameters:

powerSourceName - name of power source

metricToCollect - the metric to collect

Returns:

the value of the metric, or null if there is no power source with the given name

getProcessorMetric

public Double getProcessorMetric(String processorNumber,
                                 Name metricToCollect)

Returns the given metric's value, or null if there is no processor with the given number.

Parameters:

processorNumber - number of the processor, as a String

metricToCollect - the metric to collect

Returns:

the value of the metric, or null if there is no processor with the given number

getFileStoreMetric

public Double getFileStoreMetric(String fileStoreNameName,
                                 Name metricToCollect)

Returns the given metric's value, or null if there is no file store with the given name.

Parameters:

fileStoreNameName - name of file store

metricToCollect - the metric to collect

Returns:

the value of the metric, or null if there is no file store with the given name

getMemoryMetric

public Double getMemoryMetric(Name metricToCollect)

Returns the given memory metric's value.

Parameters:

metricToCollect - the metric to collect

Returns:

the value of the metric

getOperatingSystemMetric

public Double getOperatingSystemMetric(Name metricToCollect)

Returns the given OS metric's value.

Parameters:

metricToCollect - the metric to collect

Returns:

the value of the metric

getMetric

public Double getMetric(PlatformResourceNode node,
                        Name metricToCollect)

Given a platform resource node and a metric name, this will return that metric's value, or null if there is no resource that can be identified by the node.

Parameters:

node - identifies the platform resource whose metric is to be collected

metricToCollect - the metric to collect

Returns:

the value of the metric, or null if there is no resource identified by the node

discoverResources

public Map<PlatformPath,PlatformResourceNode> discoverResources(PlatformPath platformPath)

Helps with discovery of platform resources by obtaining all the resources of the given path. Since we know the OSHI hierarchy is only one level deep (OS is the root parent, and all the rest are underneath (e.g. file stores, memory, processors, powersources), this method looks at the given path's last segment name to determine what it should return.

Parameters:

platformPath - the path of the resources to find.

Returns:

the resources found

getMachineId

public String getMachineId()

Returns:

the unique machine ID for this platform if it is known. Otherwise, null is returned.