org.qbroker.monitor

Class MultiFileMonitor

java.lang.Object

org.qbroker.monitor.Monitor

org.qbroker.monitor.MultiFileMonitor

All Implemented Interfaces:

java.util.Comparator<long[]>, MonitorAction, MonitorReport

public class MultiFileMonitor
extends Monitor
implements java.util.Comparator<long[]>

MultiFileMonitor monitors a group of files on their mtime and/or size

Use MultiFileMonitor to get the mtime and/or size of a group of files. It is assumed that all the files exist and are readable all the time. MultiFileMonitor can monitor files on a remote server as long as it runs the new version of ftpd and accepts ftp requests.

You can use MultiFileMonitor to monitor when the files have been updated. If not, how late they are. In case of very late, MultiFileMonitor sends alerts or invokes the preconfigured script.

MultiFileMonitor also supports mtime correlations and file size correlations between two sets of files. One is a single reference file, either locally or remotely. The other set contains the target files to be monitored. The reference file controls the correlation process. Whenever the reference file updates, MultiFileMonitor adjusts its timer and correlates this change with the target files. If each of the target file has been updated accordingly, MultiFileMonitor treats it OK. Otherwise, it will send alerts according to the predefined tolerance on the lateness of the target files.

In order to configure MultiFileMonitor to do time correlations, you have to specify a Map named 'reference' in its property hash. The reference hash map contains most of the properties required by a FileMonitor object, such as uri, name, etc. The tolerance of the lateness will be controlled by the threshold parameters. In fact, MultiFileMonitor will create a separate instance for the reference file. The method of performAction() will actually do the time correlations between two files.

In case of the size correlations, you must specify the triggerSize in the property hash map. The triggerSize is zero or any positive number that defines two different states. One is the state that the file size is less than the triggerSize. The other is the opposite. In case state of the reference file changes, MultiFileMonitor will check the state of the target files. If both of them are in the same states, MultiFileMonitor thinks it OK. Otherwise, MultiFileMonitor will send alerts according to the predefined tolerance on the lateness of the target file keeping its state in sync.

Author:

yannanlu@yahoo.com

Field Summary

Fields inherited from class org.qbroker.monitor.Monitor

actionCount, actionGroup, aPatternGroup, cachedSkip, category, dependencyGroup, description, disabledWithReport, disableMode, exceptionCount, exceptionTolerance, FILE_SEPARATOR, formatText, keyList, maxPage, maxRetry, name, normalStep, pm, previousStatus, repeatPeriod, report, reportMode, reportName, resolution, serialNumber, site, skip, statsLogger, statusOffset, statusText, step, template, timeFormat, timeTemplate, tolerance, type, xPatternGroup

Fields inherited from interface org.qbroker.monitor.MonitorReport

DISABLED, EXCEPTION, NOSKIP, REPORT_CACHED, REPORT_CLUSTER, REPORT_FINAL, REPORT_FLOW, REPORT_LOCAL, REPORT_NODE, REPORT_NONE, REPORT_SHARED, SKIPPED

Constructor Summary

Constructors

Constructor and Description
MultiFileMonitor(java.util.Map props)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	checkpoint() returns the checkpoint Map for the action
int	compare(long[] a, long[] b)
void	destroy() closes and releases all opened resources
protected void	finalize()
java.util.Map<java.lang.String,java.lang.Object>	generateReport(long currentTime) generates a report on a monitored entity and returns it as a Map.
Event	performAction(int status, long currentTime, java.util.Map<java.lang.String,java.lang.Object> latest) examines the report on the monitored entity and reacts to it as an action
void	restoreFromCheckpoint(java.util.Map<java.lang.String,java.lang.Object> chkpt) restores the state of the action from the checkpoint Map

Methods inherited from class org.qbroker.monitor.Monitor

getName, getReportKeys, getReportMode, getReportName, getSkippingStatus, initTimeTemplate, updateContent

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

MultiFileMonitor

public MultiFileMonitor(java.util.Map props)

Method Detail

generateReport

public java.util.Map<java.lang.String,java.lang.Object> generateReport(long currentTime)
                                                                throws java.io.IOException

Description copied from interface: MonitorReport

generates a report on a monitored entity and returns it as a Map. The report Map will be passed to the associated MonitorAction as an opaque object. The action object is supposed to know how to retrieve the information from the report Map.

Specified by:

generateReport in interface MonitorReport

Specified by:

generateReport in class Monitor

Throws:

java.io.IOException

performAction

public Event performAction(int status,
                           long currentTime,
                           java.util.Map<java.lang.String,java.lang.Object> latest)

Description copied from interface: MonitorAction

examines the report on the monitored entity and reacts to it as an action

Specified by:

performAction in interface MonitorAction

Specified by:

performAction in class Monitor

compare

public int compare(long[] a,
                   long[] b)

Specified by:

compare in interface java.util.Comparator<long[]>

checkpoint

public java.util.Map<java.lang.String,java.lang.Object> checkpoint()

Description copied from interface: MonitorAction

returns the checkpoint Map for the action

Specified by:

checkpoint in interface MonitorAction

Overrides:

checkpoint in class Monitor

restoreFromCheckpoint

public void restoreFromCheckpoint(java.util.Map<java.lang.String,java.lang.Object> chkpt)

Description copied from interface: MonitorAction

restores the state of the action from the checkpoint Map

Specified by:

restoreFromCheckpoint in interface MonitorAction

Overrides:

restoreFromCheckpoint in class Monitor

destroy

public void destroy()

Description copied from interface: MonitorReport

closes and releases all opened resources

Specified by:

destroy in interface MonitorReport

Overrides:

destroy in class Monitor

finalize

protected void finalize()

Overrides:

finalize in class Monitor