StatusAggregator (LSST CCS - Toolkit (Pom) 3.1.3 API)

java.lang.Object
- org.lsst.ccs.messaging.StatusAggregator

All Implemented Interfaces:

MessageListener, StatusMessageListener
```
public class StatusAggregator
extends Object
implements StatusMessageListener
```
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
MessagingAccess.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()

Constructors
Constructor and Description
`StatusAggregator()`

Method Summary

All Methods Instance Methods Concrete Methods
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.messaging.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`	`onStatusMessage(StatusMessage msg)` Called when the message is received.
`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.
`void`	`setVariable(String variable, String value)` set a variable value.
`void`	`setVariables(Map<String,String> values)` set variable values.
`void`	`updVars()`

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
  - setVariable
```
public void setVariable(String variable,
                        String value)
```
    set a variable value. The variable can be used as $var in configuration sources
    
    Parameters:
    
    variable - the variable name
    
    value - the variable value
  - setVariables
```
public void setVariables(Map<String,String> values)
```
    set variable values. The variables can be used as $var in configuration sources
    
    Parameters:
    
    values - a name-value map
  - updVars
```
public void updVars()
```
  - getConfig
```
protected org.lsst.ccs.messaging.StatusAggregator.StatusAggregateConfig getConfig(String key)
```
  - onStatusMessage
```
public void onStatusMessage(StatusMessage msg)
```
    Description copied from interface: StatusMessageListener
    
    Called when the message is received. The implementation should be thread-safe: the framework makes no guarantees on what thread this method will be called on, and it can be called concurrently for several messages.
    
    Specified by:
    
    onStatusMessage in interface StatusMessageListener
    
    Parameters:
    
    msg - Status bus message to be processed.
  - 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.

Class StatusAggregator

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StatusAggregator

Method Detail

setAggregate

setAggregatePattern

setAggregatePattern

clearAggregate

setVariable

setVariables

updVars

getConfig

onStatusMessage

getLast

getLastTV

getAverage

getStdDev

getMin

getMax

getHistory

getStatistics

getAllLast

getAllLastTV

getAllStatistics