alma.alarmsystem.statistics

Class StatsCalculator

java.lang.Object

alma.alarmsystem.statistics.StatsCalculator

All Implemented Interfaces:

java.lang.Runnable

public class StatsCalculator
extends java.lang.Object
implements java.lang.Runnable

A class to calculate various statistics on the alarms processed by the alarm server.

The statistics are

• logged at definite time intervals to avoid flooding the logging systems
• saved on a file

  StatsCalculator logs a minimal set of statistics on the logging system but the full statistics are saved on the file.

  Statistics are logged every time interval whose default is 10 minutes. The time interval can be customized by setting the "alma.acs.alarmsystem.statistics.timeinterval" java property. A time interval of 0 minutes disable the logging of statistics (@see "alma.acs.alarmsystem.statistics.timeinterval"). The log level is INFO by default but can be customized by setting the LOGLEVELPROPNAME java property.

  Statistics logged on file are more complete then those logged. The number of activations and terminations of each alarm received during the time interval is stored in the alarmsMap map.

  Life cycle: start() must be called to start gathering statistics and shutdown() must be executed when finished.

Since:

ACS 2015.2

Author:

acaproni

Field Summary

Fields

Modifier and Type	Field and Description
static AcsLogLevel	DEFAULTLOGLEVEL The default log level
static int	DEFAULTTIMEINTERVAL The default time interval is 10 minutes
static java.lang.String	LOGLEVELPROPNAME The name of the property to customize the the level of the logs with the statistics.
int	timeInterval Statistics are logged every time interval (in minutes)
static java.lang.String	TIMEINTERVALPROPNAME The name of the property to customize the time interval (in minutes) to log statistics.

Constructor Summary

Constructors

Constructor and Description
StatsCalculator(java.util.logging.Logger logger, AlarmSourcesListenerCached sourceNCQueue) Constructor

Method Summary

Modifier and Type	Method and Description
void	msgFromSourceNCReceived() A message from the source NC has been received.
void	processedFS(java.lang.String alarmID, boolean active) An FaultState with the passed ID and activation state has been processed.
void	run() The scheduler invokes this method at fixed time intervals to generate and publish statistics.
void	shutdown() This method must be called when no more statistics must be collected and published.
void	start() Start to collect statistics and spawn the timer task.

Methods inherited from class java.lang.Object

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

Field Detail

TIMEINTERVALPROPNAME

public static final java.lang.String TIMEINTERVALPROPNAME

The name of the property to customize the time interval (in minutes) to log statistics.
Setting the value of this property to 0 disables the statistics.

See Also:

Constant Field Values

DEFAULTTIMEINTERVAL

public static final int DEFAULTTIMEINTERVAL

The default time interval is 10 minutes

See Also:

Constant Field Values

timeInterval

public final int timeInterval

Statistics are logged every time interval (in minutes)

LOGLEVELPROPNAME

public static final java.lang.String LOGLEVELPROPNAME

The name of the property to customize the the level of the logs with the statistics.

The value of this level can be a string (like Debug) or a integer (like 5 for Notice). See AcsLogLevelDefinition for further details

See Also:

Constant Field Values

DEFAULTLOGLEVEL

public static final AcsLogLevel DEFAULTLOGLEVEL

The default log level

Constructor Detail

StatsCalculator

public StatsCalculator(java.util.logging.Logger logger,
                       AlarmSourcesListenerCached sourceNCQueue)

Constructor

Parameters:

logger - The logger

Method Detail

processedFS

public void processedFS(java.lang.String alarmID,
                        boolean active)

An FaultState with the passed ID and activation state has been processed.

For the statistics, StatsCalculator does not distinguish if a alarm is a change (@see AlarmMessageProcessorImpl.processChange(cern.laser.source.alarmsysteminterface.FaultState, String, String, java.sql.Timestamp) or a backup (AlarmMessageProcessorImpl#processBackup(...)).

Parameters:

alarmID - The ID of the received alarm

active - The status of the alarm (true means active)

msgFromSourceNCReceived

public void msgFromSourceNCReceived()

A message from the source NC has been received.
Note that a source can encapsulate more FS changes in the same message.

start

public void start()

Start to collect statistics and spawn the timer task.

shutdown

public void shutdown()

This method must be called when no more statistics must be collected and published. It stops the timer task and frees all the resources.

run

public void run()

The scheduler invokes this method at fixed time intervals to generate and publish statistics. It also reset the variable to calculate the correct statistics at the next iteration.

Specified by:

run in interface java.lang.Runnable