Configure monitor

The <monitor> section of the oobc.properties.xml file contains the elements that control the basic behavior of the OutOfBandChange daemon.

XML Syntax

The following example shows the XML code for the <monitor> element:

<monitor>
<logFile>@syslog.file.name@</logFile>
<markerFile>@oobc.marker.file@</markerFile>
<syslogMessageSaverFile>@oobc.syslog.saver.file@</syslogMessageSaverFile>
<recoveryFile>@oobc.recovery.file@</recoveryFile>
<pollFrequencySeconds>5</pollFrequencySeconds>
<rollupAlgorithm>IdleTimeout</rollupAlgorithm>
<rollupFrequencySeconds>1800</rollupFrequencySeconds>
<fatalRestartSeconds>15</fatalRestartSeconds>
<notifyOnUnmanaged>true</notifyOnUnmanaged>
</monitor>

Description

The <monitor> section of the oobc.properties.xml file gives fine control over what syslog file is monitored and how often the background threads will poll event queues, rollup events, and restart after failure.

The following table describes the XML elements specified within the <monitor> section of the oobc.properties.xml file:

XML element	Description
`<logFile>`	The readable `syslog` output file that this daemon will process. The value can be any local or network file path to the `syslog` output file.
`<markerFile>`	A local or network path to a file that is writable by the daemon. It maintains a byte count of the next line in the `syslog` file to read. The default value for this file name is the name of the `<logFile>` file with an extension of `marker`.
`<recoveryFile>`	The prefix path to a pair of files used by the OOBC to store in memory state such that the OOBC may recover the next time it starts up.
`<pollFrequencySeconds>`	Used by the `NotifierThread` as the number of seconds to wait for an event on the Event Queue. After this time expires and no events have arrived the `NotifierThread` will "passivate" (if not already in a quiescent state) all of its `Notify` class instances. Then, before reading from the Event Queue again, it will check its internal run flag to see if this thread should continue on or exit. Also used by the `ParserThread` as the number of seconds to sleep when there is no other data to read from the `syslog` file. After sleeping the specified number of seconds it will check its `keepRunning` flag to determined if it should continue on or exit.
`<rollupAlgorithm>`	The algorithm used for consolidating multiple parsed `syslog` events. The legal values are `StaticInterval`, `DynamicInterval`, and `IdleTimeout`.
`<rollupFrequencySeconds>`	The number of seconds that the daemon will wait between rollup cycles. As events are parsed from the `syslog` file they are placed in an 'Event Rollup Queue'. This queue takes like events (events from the same network device) and collapses them into a single event. When the rollup cycle is invoked, only the 'Rolled up Event' is acted upon by this daemon.
`<fatalRestartSeconds>`	The number of seconds that the daemon will wait after a failure causes the shutdown but before the restart of the background daemon threads.
`<notifyOnUnmanaged>`	A true or false value indicating whether a syslog event, received on a device not currently managed by ITNCM - Base, should be written to the output notification log.