Archiver Command Reference
The archiver utility moog_archiver
is a command line utility to archive
and delete Situations, alerts and statistical data.
The utility is located at $MOOGSOFT_HOME/bin/utils/moog_archiver
.
See Archive Situations and Alerts for more information.
Usage
moog_archiver [ --alert_filter <filter name> ] [ --update_batch_size <number of Situations/rows> ] [ --delimiter <delimiter> ] [ --export ] [ --file_age <number of days > ] [ --log_level WARN|INFO|DEBUG|TRACE ] [ --situation_filter ] [ --loose_alert_age <number of days> ] [ --logconsole ] [ --logfilename ] [ --include_statistics ] [ --retain_open] [ --statistics_age <number of days> ] [ --archive_path <path> ] [ --remove ] [ --situation_age <number of days> ] [ --loose_alerts_only ] [ --delay_time <number of milliseconds> ] [ --id_batch_size <number of rows> ] --help
Argument |
Input |
Description |
---|---|---|
|
String |
Include all loose alerts that match the specified global alert filter. Does not apply to alerts within Situations that are being archived. |
|
Integer |
Maximum number of alert/Situation rows to process at once during the export/deletion process. Increasing this value can speed up archiving but places more load on the database. Default is 1000. |
|
String |
Delimiter to insert between values in the export file. Defaults to comma ",". |
|
- |
Export the archived data to a file. |
|
Integer |
Delete files from the default directory |
|
String, one of |
Log level controlling the amount of information logged by the utility. Default is WARN. |
|
- |
Include all Situations that match the specified global alert filter. |
|
Integer |
Export data related to loose alerts older than the specified number of days. Default is 395. Default is 28 for a standard database or 395 if historic data retention is enabled. |
|
- |
Write logs to the console only. |
|
String |
Specify a log filename. |
|
- |
Include the deletion of statistical data. Statistical data can only be deleted, not archived. |
|
Integer |
Delete statistical data older than the specified number of days. Default is 28 for a standard database or 395 if historic data retention is enabled. |
|
- |
Only include data from Situations with Closed, Dormant or Superseded status. Cannot be
used with the Situation filter |
|
String |
Destination path for the archived data. Default is |
|
- |
Delete data from the database. |
|
Integer |
Include Situation data (and alerts within Situations) older than the specified number of days. Default is 28 for a standard database or 395 if historic data retention is enabled. |
|
- |
Archive loose alerts only. Cannot be used with |
|
Integer |
Length of the delay between each batch operation. Can be used to slow the speed of archiving to reduce load on the database. Default is 0. |
|
Integer |
Maximum number of rows to process per batch during the export/deletion process. Increasing this value can speed up archiving but places more load on the database. Default is 100. |
|
- |
Display the utility options and syntax. |
Example
moog_archiver --export --remove --loose_alert_age 2 --situation_age 7 --retain_open --logfilename 10_12_20_archiver.log Logging to : /var/log/moogsoft/10_12_20_archiver.log