alma.acs.logging.statistics

Class AcsLoggerStatistics

java.lang.Object

alma.acs.logging.statistics.AcsLoggerStatistics

public class AcsLoggerStatistics
extends java.lang.Object

This class takes responsibility of a logger statistics calculation and generation of statistics messages. Design notes: The statistics class is by default disabled, and needs to be activated if in need of statistics calculation (by means of the configuration() method. Otherwise, if statistics are inactive, the logger performances are not affected.

Author:

mmanas created Nov 17, 2014 3:00:00 PM

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_STATISTICS_GRANULARITY
static int	DEFAULT_STATISTICS_PERIOD
static boolean	DEFAULT_STATISTICS_STATE
static int	INITIAL_NUMBER_ERRORS
static int	INITIAL_NUMBER_MESSAGES These constant members represent the default values of the statistics parametres.

Constructor Summary

Constructors

Constructor and Description
AcsLoggerStatistics() Standard constructor

Method Summary

Modifier and Type	Method and Description
void	calculateLoggingStatistics() This method calculates the logging statistics
void	configureStatistics(java.lang.String elementName, boolean state, int period, int granularity) This method allows the statistic module to be configured
int	getAccumulatedNumberOfLogErrors()
int	getAccumulatedNumberOfMessages()
float	getActualStatisticsPeriod()
java.lang.Boolean	getDisableStatistics()
float	getErrorIncrement()
float	getErrorStatistics()
int	getLastPeriodNumberOfLogErrors()
int	getLastPeriodNumberOfMessages()
long	getLastStatisticsRepportTime()
float	getMessageIncrement()
float	getMessageStatistics()
int	getStatisticsCalculationPeriod()
int	getStatisticsGranularity()
java.lang.String	getStatisticsIdentification()
void	incrementNumberOfLogErrors() This method increments the stored number of logging errors detected
void	incrementNumberOfMessages() This method increments the stored number of correctly transferred logs
void	resetStatistics() This method makes a backup and resets the current statisctics values
void	retrieveStatisticsLogs(java.util.List<java.lang.String> statisticsLogList, java.lang.String loggerId) This method generates the logging statistics in message format
void	setAccumulatedNumberOfLogErrors(int accumulatedNumberOfLogErrors)
void	setAccumulatedNumberOfMessages(int accumulatedNumberOfMessages)
void	setActualStatisticsPeriod(float actualStatisticsPeriod)
void	setDisableStatistics(java.lang.Boolean disableStatistics)
void	setErrorIncrement(float errorIncrement)
void	setErrorStatistics(float errorStatistics)
void	setLastPeriodNumberOfLogErrors(int lastPeriodNumberOfLogErrors)
void	setLastPeriodNumberOfMessages(int lastPeriodNumberOfMessages)
void	setLastStatisticsRepportTime(long lastStatisticsRepportTime)
void	setMessageIncrement(float messageIncrement)
void	setMessageStatistics(float messageStatistics)
void	setStatisticsCalculationPeriod(int statisticsCalculationPeriod)
void	setStatisticsGranularity(int statisticsGranularity)
void	setStatisticsIdentification(java.lang.String statisticsIdentification)

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL_NUMBER_MESSAGES

public static final int INITIAL_NUMBER_MESSAGES

These constant members represent the default values of the statistics parametres.

See Also:

Constant Field Values

INITIAL_NUMBER_ERRORS

public static final int INITIAL_NUMBER_ERRORS

See Also:

Constant Field Values

DEFAULT_STATISTICS_PERIOD

public static final int DEFAULT_STATISTICS_PERIOD

See Also:

Constant Field Values

DEFAULT_STATISTICS_GRANULARITY

public static final int DEFAULT_STATISTICS_GRANULARITY

See Also:

Constant Field Values

DEFAULT_STATISTICS_STATE

public static final boolean DEFAULT_STATISTICS_STATE

See Also:

Constant Field Values

Constructor Detail

AcsLoggerStatistics

public AcsLoggerStatistics()

Standard constructor

Method Detail

calculateLoggingStatistics

public void calculateLoggingStatistics()

This method calculates the logging statistics

retrieveStatisticsLogs

public void retrieveStatisticsLogs(java.util.List<java.lang.String> statisticsLogList,
                                   java.lang.String loggerId)

This method generates the logging statistics in message format

Parameters:

statisticsLogList - List of logs (strings)

loggerId - String to indintify the logger (normaly will consist on container name + logger name)

incrementNumberOfMessages

public void incrementNumberOfMessages()

This method increments the stored number of correctly transferred logs

incrementNumberOfLogErrors

public void incrementNumberOfLogErrors()

This method increments the stored number of logging errors detected

resetStatistics

public void resetStatistics()

This method makes a backup and resets the current statisctics values

configureStatistics

public void configureStatistics(java.lang.String elementName,
                                boolean state,
                                int period,
                                int granularity)

This method allows the statistic module to be configured

Parameters:

elementName - String defining the name of the module the statistics belong to

state - Configuaration of disableStatistics attribute (to enable / diable statistics module)

period - Configuration of statisticsCalculationPeriod

granularity - Configuration of statisticsGranularity

getDisableStatistics

public java.lang.Boolean getDisableStatistics()

getStatisticsIdentification

public java.lang.String getStatisticsIdentification()

getAccumulatedNumberOfMessages

public int getAccumulatedNumberOfMessages()

getAccumulatedNumberOfLogErrors

public int getAccumulatedNumberOfLogErrors()

getLastStatisticsRepportTime

public long getLastStatisticsRepportTime()

getStatisticsCalculationPeriod

public int getStatisticsCalculationPeriod()

getStatisticsGranularity

public int getStatisticsGranularity()

getLastPeriodNumberOfMessages

public int getLastPeriodNumberOfMessages()

getLastPeriodNumberOfLogErrors

public int getLastPeriodNumberOfLogErrors()

getMessageStatistics

public float getMessageStatistics()

getErrorStatistics

public float getErrorStatistics()

getMessageIncrement

public float getMessageIncrement()

getErrorIncrement

public float getErrorIncrement()

getActualStatisticsPeriod

public float getActualStatisticsPeriod()

setDisableStatistics

public void setDisableStatistics(java.lang.Boolean disableStatistics)

setStatisticsIdentification

public void setStatisticsIdentification(java.lang.String statisticsIdentification)

setAccumulatedNumberOfMessages

public void setAccumulatedNumberOfMessages(int accumulatedNumberOfMessages)

setAccumulatedNumberOfLogErrors

public void setAccumulatedNumberOfLogErrors(int accumulatedNumberOfLogErrors)

setLastStatisticsRepportTime

public void setLastStatisticsRepportTime(long lastStatisticsRepportTime)

setStatisticsCalculationPeriod

public void setStatisticsCalculationPeriod(int statisticsCalculationPeriod)

setStatisticsGranularity

public void setStatisticsGranularity(int statisticsGranularity)

setLastPeriodNumberOfMessages

public void setLastPeriodNumberOfMessages(int lastPeriodNumberOfMessages)

setLastPeriodNumberOfLogErrors

public void setLastPeriodNumberOfLogErrors(int lastPeriodNumberOfLogErrors)

setMessageStatistics

public void setMessageStatistics(float messageStatistics)

setErrorStatistics

public void setErrorStatistics(float errorStatistics)

setMessageIncrement

public void setMessageIncrement(float messageIncrement)

setErrorIncrement

public void setErrorIncrement(float errorIncrement)

setActualStatisticsPeriod

public void setActualStatisticsPeriod(float actualStatisticsPeriod)