Skip to main content

Historic Data Utility Command Reference

The Historic Data utility moog_db_split_configurer is a command line utility to configure the retention of historic data.

The utility is located at $MOOGSOFT_HOME/bin/utils.

See Configure Historic Data Retention for more information.


moog_db_split_configurer [ --user <user> --password <password> ] [ --grace_period <period> ] [ --database_name <name> ] [ --alerts_batch_size <size> ] [ --sigs_batch_size <size> ] [ --run_at <hour:minute> ] [ --aged_snapshots_period <days> ] [ --loglevel (WARN|INFO|DEBUG|TRACE) ]




-a, --alerts_batch_size

Integer <number of alerts>

Number of alerts per batch when moving data to the historic database. Increasing this value can speed up the process but places more load on the database. Default is 100.

-e, --events_batch_size

Integer <number of events>

Number of events/snapshots per batch during deletion from active database. Default is 1000.

-g, --grace_period

Integer <number of hours>

Time in hours since the last update after which closed alerts and Situations are eligible to be included in historic data retention. Default is 24 (one day).

-l, --loglevel

String, one of INFO | WARN | DEBUG | TRACE

Log level controlling the amount of information logged by the utility. Default is INFO.

-n, --database_name

String <database name>

The name of the historic database. Default is historic_moogdb.

-p, --password

String <password>

Password for the MySQL user specified in the --user argument.

-s, --sigs_batch_size

Integer <number of Situations>

Number of Situations to include in each batch when moving data to the historic database. Default is 200.

-u, --user

String <username>

MySQL user to run the utility. The user must have schema creation privileges. Default is root.

-r, --run_at

String <hour:minute>

The point of time in a day to run the utility. Default is 01:00. The provided time is a system timezone.

-as, --aged_snapshots_period

Integer days

How many days after which to remove snapshots data from the live moogdb database. Default is 14.

-al, --aged_logs_period

Integer <days>

Number of days to retain the splitter process logs. Default is 90 days.

-h, --help


Display the utility options and syntax.


moog_db_split_configurer --alerts_batch_size 1000 --loglevel INFO --run_at 12:30 --sigs_batch_size 250

+-------------- DB split configurations --------------------------------+ 
Grace period (hours):            [24] 
Alerts batch size:               [1000] 
Situations batch size:           [250] 
Run at:                          [12:30] 
Aged snapshots period (seconds): [1209600] 
Historic database:               [historic_moogdb]
+-------------- DB split configured ------------------------------------+