org.lsst.ccs.bus

Class StatusAggregator

java.lang.Object

org.lsst.ccs.bus.StatusAggregator

All Implemented Interfaces:

EncodedStatusListens, KeyValueStatusListener, StatusListens

public class StatusAggregator
extends Object
implements KeyValueStatusListener

A StatusAggregator listens to the status bus and keeps track in memory of selected status data.

It will keep at least the last value of each status data it is configured to monitor.

It can also keep a history during a given time, and accumulate statistics over a given time.

The StatusAggregator should be registered on the bus, with something like
MessagingFactory.getInstance().forSubsystem("archon-sl").addStatusListener(sa);
note the specific name so that the listener receives status messages also from its host subsystem, if it is useful.

It should also be configured to monitor and store status data using the setAggregate or setAggregatePattern methods for each relevant data name.

Author:

aubourg

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StatusAggregator.Statistics Internal class, unmutable data structure with min, max, average and stddev.
static class	StatusAggregator.TimedValue Internal class, unmutable data structure with name, timestamp and value.

Constructor Summary

Constructors

Constructor and Description
StatusAggregator()

Method Summary

Modifier and Type	Method and Description
void	clearAggregate(String key) stop monitoring a given data.
Map<String,Object>	getAllLast() returns the last values of all parameters monitored
Map<String,StatusAggregator.TimedValue>	getAllLastTV() returns the last values of all parameters monitored, with their timestamp.
Map<String,StatusAggregator.Statistics>	getAllStatistics() returns the statistics of all parameters monitored.
double	getAverage(String key) returns the average (over the configured duration) for a given key.
protected org.lsst.ccs.bus.StatusAggregator.StatusAggregateConfig	getConfig(String key)
List<StatusAggregator.TimedValue>	getHistory(String key) returns the history (over the configured duration) for a given key.
Object	getLast(String key) returns the last value seen for a given key (which has to be monitored)
StatusAggregator.TimedValue	getLastTV(String key) returns the last value seen for a given key (which has to be monitored)
double	getMax(String key) returns the max (over the configured duration) for a given key.
double	getMin(String key) returns the min (over the configured duration) for a given key.
StatusAggregator.Statistics	getStatistics(String key) returns statistics (over the configured duration) for a given key.
double	getStdDev(String key) returns the stddev (over the configured duration) for a given key.
void	onKeyValueStatusDecomposition(String source, long timeStamp, String key, Object value, int commonID) listeners will receive a EncodedDataStatus split along key-values (values being of a simple type)
void	setAggregate(String key, int historyDuration, int aggregateWindow) Configures the StatusAgregator to monitor a given data.
void	setAggregatePattern(Pattern pattern, int historyDuration, int aggregateWindow) Configures the StatusAgregator to monitor all the data which name matches a regex pattern.
void	setAggregatePattern(String pattern, int historyDuration, int aggregateWindow) Configures the StatusAgregator to monitor all the data which name matches a regex pattern.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusAggregator

public StatusAggregator()

Method Detail

setAggregate

public void setAggregate(String key,
                         int historyDuration,
                         int aggregateWindow)

Configures the StatusAgregator to monitor a given data.

Parameters:

key - the name ("subsystem/key") of the data to be monitored

historyDuration - duration (in ms) for which to keep history. -1 not to keep history.

aggregateWindow - duration (in ms) for which to compute aggregates and stats. -1 not to compute.

setAggregatePattern

public void setAggregatePattern(String pattern,
                                int historyDuration,
                                int aggregateWindow)

Configures the StatusAgregator to monitor all the data which name matches a regex pattern.

Parameters:

pattern - the pattern that the data ("subsystem/key") to be monitored must match.

historyDuration - duration (in ms) for which to keep history. -1 not to keep history.

aggregateWindow - duration (in ms) for which to compute aggregates and stats. -1 not to compute.

setAggregatePattern

public void setAggregatePattern(Pattern pattern,
                                int historyDuration,
                                int aggregateWindow)

Configures the StatusAgregator to monitor all the data which name matches a regex pattern.

Parameters:

pattern - the pattern that the data ("subsystem/key") to be monitored must match.

historyDuration - duration (in ms) for which to keep history. -1 not to keep history.

aggregateWindow - duration (in ms) for which to compute aggregates and stats. -1 not to compute.

clearAggregate

public void clearAggregate(String key)

stop monitoring a given data.

Parameters:

key - the name ("subsystem/key") of the data to be cleared

getConfig

protected org.lsst.ccs.bus.StatusAggregator.StatusAggregateConfig getConfig(String key)

onKeyValueStatusDecomposition

public void onKeyValueStatusDecomposition(String source,
                                          long timeStamp,
                                          String key,
                                          Object value,
                                          int commonID)

Description copied from interface: KeyValueStatusListener

listeners will receive a EncodedDataStatus split along key-values (values being of a simple type)

Specified by:

onKeyValueStatusDecomposition in interface KeyValueStatusListener

commonID - calls having the same "commonID" are extracted from the same Encoded object.

getLast

public Object getLast(String key)

returns the last value seen for a given key (which has to be monitored)

Parameters:

key -

Returns:

the last value seen on the status bus.

getLastTV

public StatusAggregator.TimedValue getLastTV(String key)

returns the last value seen for a given key (which has to be monitored)

Parameters:

key -

Returns:

the last value seen on the status bus, as a TimedValue.

getAverage

public double getAverage(String key)

returns the average (over the configured duration) for a given key. The data has to be a number.

Parameters:

key -

Returns:

the average, as a double

getStdDev

public double getStdDev(String key)

returns the stddev (over the configured duration) for a given key. The data has to be a number.

Parameters:

key -

Returns:

the stddev, as a double

getMin

public double getMin(String key)

returns the min (over the configured duration) for a given key. The data has to be a number.

Parameters:

key -

Returns:

the min, as a double

getMax

public double getMax(String key)

returns the max (over the configured duration) for a given key. The data has to be a number.

Parameters:

key -

Returns:

the max, as a double

getHistory

public List<StatusAggregator.TimedValue> getHistory(String key)

returns the history (over the configured duration) for a given key.

Parameters:

key -

Returns:

the history as a list of TimedValue

getStatistics

public StatusAggregator.Statistics getStatistics(String key)

returns statistics (over the configured duration) for a given key. Statistics contain min, max, average and stddev.

Parameters:

key -

Returns:

the Statistics object

getAllLast

public Map<String,Object> getAllLast()

returns the last values of all parameters monitored

Returns:

a map of the last values, the key is the data name.

getAllLastTV

public Map<String,StatusAggregator.TimedValue> getAllLastTV()

returns the last values of all parameters monitored, with their timestamp.

Returns:

a map of the last values as TimedValue, the key is the data name.

getAllStatistics

public Map<String,StatusAggregator.Statistics> getAllStatistics()

returns the statistics of all parameters monitored.

Returns:

a map of the Statistics, the key is the data name.