Skip to main content

Maintenance Window Manager Reference

This is a reference for the Maintenance Window Manager Moolet.

Moogsoft recommends you do not change any properties that are not in this reference guide.

You can change the behavior of the Maintenance Window Manager by editing the configuration properties in the $MOOGSOFT_HOME/config/moolets/maintenance_window_manager.conf configuration file. It contains the following properties:

name

Name of the Maintenance Window Manager Moolet. Do not change.

Type: String

Required: Yes

Default: "MaintenanceWindowManager"

classname

Moolet class name. Do not change.

Type: String

Required: Yes

Default: "CMaintenance"

run_on_startup

Determines whether the Maintenance Window Manager runs when Moogsoft Enterprise starts. By default, it is set to true, so that when Moogfarmd starts, it automatically creates an instance of the Maintenance Window Manager.

Type: Boolean

Required: Yes

Default: true

metric_path_moolet

Determines whether or not Moogsoft Enterprise factors the Maintenance Window Manager into the Event Processing metric for Self Monitoring.

Type: Boolean

Required: Yes

Default: true

process_output_of

Defines the input source for the Maintenance Window Manager. This determines the Maintenance Window Manager's place in the alert processing workflow.

Type: List

Required: Yes

One of: AlertBuilder, AlertRulesEngine, Enricher

Default: "AlertBuilder"

maintenance_status_field

Name of the custom_info field or key used to indicate the alert's maintenance status.

Type: String

Required: Yes

Default: "maintenance_status"

maintenance_status_label

Value of the custom_info.maintenance_status field used to indicate that an alert is in maintenance.

Type: String

Required: Yes

Default: "In maintenance"

update_captured_alerts

If enabled, ensures the maintenance status of an alert is set to null once the Maintenance Window that captured it has expired. If disabled, the maintenance status field of a captured alert remains as the text value set in the maintenance_status_label property, unless that alert reoccurs when all custom_info maintenance fields are set to null.

Type: Boolean

Required: Yes

Default: true

It is possible to add a column in the alert view displaying the 'Maintenance Status' for each alert and the text visible in this column can be controlled by editing the maintenance_status_label in the MaintenanceWindowManager Moolet configuration in $MOOGSOFT_HOME/config/moolets/maintenance_window_manager.conf.

For the feature to function, you must place the Maintenance Window Manager Moolet before a Sigalising Moolet in a forwarding chain. It is also appropriate for you to locate it before the Alert Rules Engine in the processing chain.