org.lsst.ccs.services

Class AgentStatusAggregatorService

java.lang.Object

org.lsst.ccs.services.AgentStatusAggregatorService

All Implemented Interfaces:

AgentPresenceListener, MessageListener, StatusMessageListener, ServiceLifecycle, AgentService

public class AgentStatusAggregatorService
extends Object
implements StatusMessageListener, ServiceLifecycle, AgentPresenceListener, AgentService

A AgentStatusAggregatorService 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.

This service is installed by default for all Agents but it is registered to the status bus only when configured to listen to specific data. There are two ways to configure this service:

• via a configuration parameter
• from java by invoking the #setAggregatePattern() method

Please refer to the following documentation: https://confluence.slac.stanford.edu/x/aY4YDg

Author:

The LSST CCS Team @ SLAC

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
AgentStatusAggregatorService()

Method Summary

Modifier and Type	Method and Description
void	connecting(AgentInfo agent) Indicates that the agent represented by agent is present on the buses.
void	disconnecting(AgentInfo agent) Indicates that the agent represented by agent has left the buses.
String	getAgentServiceName() Get the name of this service.
Map<String,Object>	getAllLast() returns the last values of all parameters monitored
Map<String,AgentStatusAggregatorService.TimedValue>	getAllLastTV() returns the last values of all parameters monitored, with their timestamp.
Map<String,AgentStatusAggregatorService.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 AgentStatusAggregatorService.StatusAggregateConfig	getConfig(AgentInfo agent, String dataKey, String sourceBasedFullKey)
List<AgentStatusAggregatorService.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)
AgentStatusAggregatorService.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.
AgentStatusAggregatorService.Statistics	getStatistics(String key) returns statistics (over the configured duration) for a given key.
List<AgentStatusAggregatorService.StatusAggregateConfig>	getStatusAggregateConfig()
double	getStdDev(String key) returns the stddev (over the configured duration) for a given key.
void	onStatusMessage(StatusMessage msg) Called when a status message is received.
void	preStart() Called from the enclosing Subsystem when org.lsst.ccs.Subsystem#start() has been called.
protected void	setAggregatePattern(AgentPropertyPredicate agentPropertyPredicate, Pattern pattern, int historyDuration, int aggregateWindow, String alias) Configures the StatusAgregator to monitor all the data which name matches a regex pattern.
void	setAggregatePattern(AgentPropertyPredicate agentPropertyPredicate, String pattern) Configures the StatusAgregator to monitor all the data which name matches a regex pattern.
void	setAggregatePattern(AgentPropertyPredicate agentPropertyPredicate, String pattern, int historyDuration, int aggregateWindow, String alias)
void	setAggregatePattern(AgentPropertyPredicate agentPropertyPredicate, String pattern, String alias)
void	setPatternConfigList(List<AgentStatusAggregatorService.StatusAggregateConfig> list)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

afterInit, preBuild, preInit, preShutdown

Methods inherited from interface org.lsst.ccs.messaging.AgentPresenceListener

connected, connecting

Methods inherited from interface org.lsst.ccs.services.AgentService

startForAgent

Constructor Detail

AgentStatusAggregatorService

public AgentStatusAggregatorService()

Method Detail

getAgentServiceName

public String getAgentServiceName()

Description copied from interface: AgentService

Get the name of this service. This name will be used to add the given service to the lookup tree.

Specified by:

getAgentServiceName in interface AgentService

Returns:

the AgentService name.

preStart

public void preStart()

Description copied from interface: ServiceLifecycle

Called from the enclosing Subsystem when org.lsst.ccs.Subsystem#start() has been called.

The preceding lifecycle step is HasLifecycle.postInit()

The following lifecycle step is HasLifecycle.start() At the time it is called :

• the PhaseState is INITIALIZING
• connection with the messaging layer is effective, the enclosing subsystem has started StatusHeartBeat publication

Specified by:

preStart in interface ServiceLifecycle

connecting

public void connecting(AgentInfo agent)

Description copied from interface: AgentPresenceListener

Indicates that the agent represented by agent is present on the buses. This method is called when the first messages for a given agent is received. In the case of an agent starting up the fist messages is sent when the agent is in PhaseState::INITIALIZING state. At this point not all services are guaranteed to have completely started. This method should be used only to receive a notification that an agent is connecting. For a guarantee that an agent information is fully present, please use the #connected methods. The implementation should return immediately : any blocking operations should be scheduled on a separate thread.

Specified by:

connecting in interface AgentPresenceListener

disconnecting

public void disconnecting(AgentInfo agent)

Description copied from interface: AgentPresenceListener

Indicates that the agent represented by agent has left the buses. The implementation should return immediately : any blocking operations should be scheduled on a separate thread.

Specified by:

disconnecting in interface AgentPresenceListener

setPatternConfigList

@ConfigurationParameterChanger(propertyName="patternConfigList")
public void setPatternConfigList(List<AgentStatusAggregatorService.StatusAggregateConfig> list)

getStatusAggregateConfig

public List<AgentStatusAggregatorService.StatusAggregateConfig> getStatusAggregateConfig()

setAggregatePattern

public void setAggregatePattern(AgentPropertyPredicate agentPropertyPredicate,
                                String pattern)

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

Parameters:

agentPropertyPredicate - A Predicate to select which agent the data is coming from. This predicate allows to select agents based on the agent properties

pattern - a regex pattern used to select which data is to be retained.

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

aggregateWindow - duration (in ms) for which to compute aggregates and stats. -1 not to compute, it is the default

alias - An alias to be used when storing the data instead of the subsystem name. By default the data that passes the regex pattern is stored with a key of the form "agentName/dataTrendingPath. If an alias is specified the key will be "alias/dataTrendingPath" instead. This is useful when it is necessary to hide the agentName. This methods must be invoked before the start lifecycle's method. If invoked too late an exception will be thrown.

setAggregatePattern

public void setAggregatePattern(AgentPropertyPredicate agentPropertyPredicate,
                                String pattern,
                                String alias)

setAggregatePattern

public void setAggregatePattern(AgentPropertyPredicate agentPropertyPredicate,
                                String pattern,
                                int historyDuration,
                                int aggregateWindow,
                                String alias)

setAggregatePattern

protected void setAggregatePattern(AgentPropertyPredicate agentPropertyPredicate,
                                   Pattern pattern,
                                   int historyDuration,
                                   int aggregateWindow,
                                   String alias)

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.

getConfig

protected AgentStatusAggregatorService.StatusAggregateConfig getConfig(AgentInfo agent,
                                                                       String dataKey,
                                                                       String sourceBasedFullKey)

onStatusMessage

public void onStatusMessage(StatusMessage msg)

Description copied from interface: StatusMessageListener

Called when a status 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. The implementation should also return immediately : any blocking operations should be scheduled on a separate thread.

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 AgentStatusAggregatorService.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<AgentStatusAggregatorService.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 AgentStatusAggregatorService.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,AgentStatusAggregatorService.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,AgentStatusAggregatorService.Statistics> getAllStatistics()

returns the statistics of all parameters monitored.

Returns:

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