Moogsoft Docs

Historic Data Utility Command Reference

This is a reference for the Configure Historic Data Retention. The moog-db-split-enabler command line utility accepts the following arguments:

Argument

Input

Description

-a, --alerts_batch_size <arg>

Integer: <number of alerts>

Number of alerts pert batch when moving data to the historic database. Increasing this value can speed up the process but places more load on the database. Defaults to 2000.

-d, --disable

-

Disable the retention of historic data in a separate database. The data in the old historic database is not moved to the active database and is effectively inaccessible.

-e, --enable <arg>

String

Enable the retention of historic data in a separate database.

-g, --grace_period <arg>

Integer: <number of seconds>

Period of time since the last update after which closed alerts and Situations are eligible to be included in historic data retention. Defaults to 3600 (one hour).

-h, --help

-

Display the syntax and option descriptions.

-l, --loglevel <arg>

WARN | INFO | DEBUG | TRACE

Specify the output verbosity. Defaults to INFO.

-n,--database_name <arg>

String

Name of the database to contain the historic data. This database is created the first time the utility runs. If the name is changed from a previous run, the data in the old historic database is not moved to the new historic database and is inaccessible from the UI. Defaults to historic_moogdb.

-p,--password <arg>

String

Password for the MySQL user specified in the user argument -u. Defaults to ' '.

-r,--run_interval <arg>

Integer: <number of seconds>

The intervals at which the utility runs and moves any eligible data to the historic database. The first execution is always the run_interval time divided by two. Defaults to 600 (ten minutes).

-s,--sigs_batch_size <arg>

Integer: <number of Situations>

Number of Situations to include in each batch. Defaults to 500.

-u,--user <arg>

String

MySQL username with schema creation privileges. Defaults to root.