Package fr.dyade.aaa.common.monitoring

Class FileMonitoringTimerTask

java.lang.Object

java.util.TimerTask

fr.dyade.aaa.common.monitoring.MonitoringTimerTask

fr.dyade.aaa.common.monitoring.FileMonitoringTimerTask

All Implemented Interfaces:

MonitoringTimerTaskMBean, Runnable

public class FileMonitoringTimerTask
extends MonitoringTimerTask

The FileMonitoringTimerTask class allows to periodically watch JMX attributes and store the corresponding values to a file in CSV format.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_MONITORING_CONFIG_PATH	Default value for the pathname of a configuration file for a csv file monitoring task in the server, value is fileMonitoring.props.
static long	DEFAULT_MONITORING_CONFIG_PERIOD	Default value for the scanning period for the csv file monitoring task in the server, value is 60000L (60 seconds).
static String	DEFAULT_MONITORING_RESULT_PATH	Default value for the pathname of the results file for the monitoring task in the server, value is monitoringStats.csv.
static String	MONITORING_CONFIG_PATH_PROPERTY	Name of property allowing to fix the pathname of a configuration file for a csv file monitoring task in the server.
static String	MONITORING_CONFIG_PERIOD_PROPERTY	Name of property allowing to fix the scanning period for the csv file monitoring task in the server.
static String	MONITORING_RESULT_PATH_PROPERTY	Name of property allowing to fix the pathname of the results file for the csv file monitoring task in the server.
String	path	Pathname of the result file.
(package private) StringBuffer	strbuf
(package private) Timer	timer
(package private) FileWriter	writer

Fields inherited from class fr.dyade.aaa.common.monitoring.MonitoringTimerTask

attlist, logger, mbeanName, timerPeriod

Constructor Summary

Constructors

Constructor	Description
FileMonitoringTimerTask()	Instantiates the FileMonitoringTimerTask component.
FileMonitoringTimerTask(Timer timer, long period, Properties attlist, String path)	Initializes the FileMonitoringTimerTask component.

Method Summary

Modifier and Type	Method	Description
protected void	addRecord(String mbean, String att, Object value)	Records information about the specified attribute.
void	close()	Close the result file, be careful you have to call this method only if the monitoring task is stopped.
protected void	finalizeRecords()	Finalize the record for the current time.
void	init(Timer timer, long period, Properties attlist, Properties taskProps)	Initializes the FileMonitoringTimerTask component.
protected void	initializeRecords()	Initialize the record for the current collect time.

Methods inherited from class fr.dyade.aaa.common.monitoring.MonitoringTimerTask

addMonitoredAttributes, cancelTask, delMonitoredAttributes, getMonitoredAttributes, getPeriod, run, start

Methods inherited from class java.util.TimerTask

cancel, scheduledExecutionTime

Methods inherited from class java.lang.Object

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

Field Detail

MONITORING_CONFIG_PERIOD_PROPERTY

public static final String MONITORING_CONFIG_PERIOD_PROPERTY

Name of property allowing to fix the scanning period for the csv file monitoring task in the server.

This property can be fixed either from java launching command, or in a3servers.xml configuration file.

See Also:

FileMonitoringTimerTask, Constant Field Values

DEFAULT_MONITORING_CONFIG_PERIOD

public static final long DEFAULT_MONITORING_CONFIG_PERIOD

Default value for the scanning period for the csv file monitoring task in the server, value is 60000L (60 seconds).

See Also:

FileMonitoringTimerTask, Constant Field Values

MONITORING_CONFIG_PATH_PROPERTY

public static final String MONITORING_CONFIG_PATH_PROPERTY

Name of property allowing to fix the pathname of a configuration file for a csv file monitoring task in the server.

This property can be fixed either from java launching command, or in a3servers.xml configuration file.

See Also:

FileMonitoringTimerTask, Constant Field Values

DEFAULT_MONITORING_CONFIG_PATH

public static final String DEFAULT_MONITORING_CONFIG_PATH

Default value for the pathname of a configuration file for a csv file monitoring task in the server, value is fileMonitoring.props.

If the file does not exist the timer task is not launched.

See Also:

FileMonitoringTimerTask, Constant Field Values

MONITORING_RESULT_PATH_PROPERTY

public static final String MONITORING_RESULT_PATH_PROPERTY

Name of property allowing to fix the pathname of the results file for the csv file monitoring task in the server.

This property can be fixed either from java launching command, or in a3servers.xml configuration file.

See Also:

FileMonitoringTimerTask, Constant Field Values

DEFAULT_MONITORING_RESULT_PATH

public static final String DEFAULT_MONITORING_RESULT_PATH

Default value for the pathname of the results file for the monitoring task in the server, value is monitoringStats.csv.

See Also:

FileMonitoringTimerTask, Constant Field Values

writer

FileWriter writer

strbuf

StringBuffer strbuf

timer

Timer timer

path

public String path

Pathname of the result file.

Constructor Detail

FileMonitoringTimerTask

public FileMonitoringTimerTask(Timer timer,
                               long period,
                               Properties attlist,
                               String path)

Initializes the FileMonitoringTimerTask component.

Parameters:

timer - Timer to use to schedule the resulting task.

period - Period value of the resulting task

attlist - List of JMX attributes to periodically watch.

path - Pathname of resulting CSV file.

FileMonitoringTimerTask

public FileMonitoringTimerTask()

Instantiates the FileMonitoringTimerTask component.

Method Detail

init

public void init(Timer timer,
                 long period,
                 Properties attlist,
                 Properties taskProps)

Initializes the FileMonitoringTimerTask component.

Specified by:

init in class MonitoringTimerTask

Parameters:

timer - The timer to use to schedule the resulting task.

period - Period value of the resulting task

attlist - List of JMX attributes to periodically watch.

taskProps - The properties to initialize the task.

initializeRecords

protected void initializeRecords()

Initialize the record for the current collect time. For the FileMonitoringTimer, it consists to initialize a StringBuffer to collect informations about all attributes.

Specified by:

initializeRecords in class MonitoringTimerTask

See Also:

MonitoringTimerTask.initializeRecords()

addRecord

protected void addRecord(String mbean,
                         String att,
                         Object value)

Records information about the specified attribute.

Specified by:

addRecord in class MonitoringTimerTask

Parameters:

mbean - The name of the related mbean.

att - The name of the related attribute.

value - The value of the related attribute.

finalizeRecords

protected void finalizeRecords()

Finalize the record for the current time.

Specified by:

finalizeRecords in class MonitoringTimerTask

See Also:

MonitoringTimerTask.finalizeRecords()

close

public void close()

Close the result file, be careful you have to call this method only if the monitoring task is stopped.