org.opendaylight.ocpjava.statistics

Class OcpStatisticsCounters

java.lang.Object

org.opendaylight.ocpjava.statistics.OcpStatisticsCounters

All Implemented Interfaces:

org.opendaylight.ocpjava.protocol.spi.statistics.OcpStatisticsHandler

public final class OcpStatisticsCounters
extends Object
implements org.opendaylight.ocpjava.protocol.spi.statistics.OcpStatisticsHandler

Singleton class to hold and process counters

Author:

Marko Lai

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LOG_REPORT_PERIOD Default delay between two writings into log (milliseconds)
static int	MINIMAL_LOG_REPORT_PERIOD Minimal delay between two writings into log (milliseconds)

Method Summary

Modifier and Type	Method and Description
Counter	getCounter(CounterEventTypes counterEventKey) Get counter by CounterEventType
protected Map<CounterEventTypes,Counter>	getCountersMap()
protected CounterEventTypes[]	getEnabledCounters()
static OcpStatisticsCounters	getInstance() Get instance of statistics counters, first created object does not start counting and log reporting
int	getLogReportPeriod()
void	incrementCounter(CounterEventTypes counterEventKey) Increment value of given counter
boolean	isCounterEnabled(CounterEventTypes counterEventKey) Give an information if is given counter is enabled
boolean	isRunCounting() Give an information if counting is running
boolean	isRunLogReport() Give an information if log reporter is running (statistics are write into logs).
String	printOcpStatistics()
void	resetCounters()
void	startCounting(boolean reportToLogs, int logReportDelay) Start counting (counters are set to 0 before counting starts)
void	startLogReport(int logReportDelay) Prints statistics with given delay between logs
void	stopCounting() Stop counting, values in counters are untouched, log reporter is stopped
void	stopLogReport() Stops logging, counting continues

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOG_REPORT_PERIOD

public static final int DEFAULT_LOG_REPORT_PERIOD

Default delay between two writings into log (milliseconds)

See Also:

Constant Field Values

MINIMAL_LOG_REPORT_PERIOD

public static final int MINIMAL_LOG_REPORT_PERIOD

Minimal delay between two writings into log (milliseconds)

See Also:

Constant Field Values

Method Detail

getInstance

public static OcpStatisticsCounters getInstance()

Get instance of statistics counters, first created object does not start counting and log reporting

Returns:

an instance

startCounting

public void startCounting(boolean reportToLogs,
                          int logReportDelay)

Start counting (counters are set to 0 before counting starts)

Parameters:

reportToLogs - - true = statistic counters will periodically log

logReportDelay - - delay between two logs (in milliseconds)

stopCounting

public void stopCounting()

Stop counting, values in counters are untouched, log reporter is stopped

isRunCounting

public boolean isRunCounting()

Give an information if counting is running

Returns:

true, if counting is running, otherwise false

startLogReport

public void startLogReport(int logReportDelay)

Prints statistics with given delay between logs

Parameters:

logReportDelay - - delay between two logs (in milliseconds)

Throws:

IllegalArgumentException - if logReportDelay is less than 0

stopLogReport

public void stopLogReport()

Stops logging, counting continues

isRunLogReport

public boolean isRunLogReport()

Give an information if log reporter is running (statistics are write into logs).

Returns:

true if log reporter writes statistics into log, otherwise false

getLogReportPeriod

public int getLogReportPeriod()

Returns:

the current delay between two writings into logs

getEnabledCounters

protected CounterEventTypes[] getEnabledCounters()

Returns:

the enabled counters

getCountersMap

protected Map<CounterEventTypes,Counter> getCountersMap()

Returns:

the countersMap

isCounterEnabled

public boolean isCounterEnabled(CounterEventTypes counterEventKey)

Give an information if is given counter is enabled

Parameters:

counterEventKey -

Returns:

true if counter has been Enabled, otherwise false

getCounter

public Counter getCounter(CounterEventTypes counterEventKey)

Get counter by CounterEventType

Parameters:

counterEventKey - key to identify counter (can not be null)

Returns:

Counter object or null if counter has not been enabled

Throws:

IllegalArgumentException - if counterEventKey is null

incrementCounter

public void incrementCounter(CounterEventTypes counterEventKey)

Increment value of given counter

Parameters:

counterEventKey - key to identify counter

resetCounters

public void resetCounters()

Specified by:

resetCounters in interface org.opendaylight.ocpjava.protocol.spi.statistics.OcpStatisticsHandler

printOcpStatistics

public String printOcpStatistics()

Specified by:

printOcpStatistics in interface org.opendaylight.ocpjava.protocol.spi.statistics.OcpStatisticsHandler