refinery-monitoring(8) -- Monitoring components and data capture interface¶

Synopsis¶

refinery monitoring [option]

Description¶

Provides:

Start and stop of the Refinery pipeline for Monitoring data capture
Status of Monitoring components and Refinery pipeline
Enabling and disabling of alerts within the Monitoring Alerting component

Options¶

--start-capture¶

Starts the Refinery data capture stack for all Monitoring data

--stop-capture¶

Stops the Refinery data capture stack for all Monitoring data

--capture-status¶

Checks the Refinery Monitoring data capture stack status

--component-status¶

Checks all the KX Refinery Monitoring components.

Note that this only returns the component status if they are running via systemd.

--list-checks¶

Lists all the monitoring checks defined within Refinery

--run-check check¶

Runs the specified check (as returned by --list-checks) and prints the output to the console

--list-alerts¶

Lists all the currently configured alerts from the Alerting components. This option requires the [REQURIED ALERT-SPECIFIC OPTIONS] described below.

--disable-alert¶

Disables a specific alert until manually re-enabled or the Alerting component is restarted. This option requires both [REQURIED ALERT-SPECIFIC OPTIONS] and [ADDITIONAL ALERT-SPECIFIC OPTIONS] described below.

--enable-alert¶

Re-enables a specific alert that has been previously disabled. This will also re-enable a snoozed alert immediately. This option requires both [REQURIED ALERT-SPECIFIC OPTIONS] and [ADDITIONAL ALERT-SPECIFIC OPTIONS] described below.

--snooze-alert¶

Snoozes an alert for a specified amount of time. You can apply this command to a disabled alert to delay the re-enabling by a specific amount of time. This option requires both [REQURIED ALERT-SPECIFIC OPTIONS] and [ADDITIONAL ALERT-SPECIFIC OPTIONS] described below.

Required alert-specific options¶

--alert-port port¶

The port that the Alerting components are bound to on all Refinery hosts.

Note that the CLI expects that the port is the same on every Refinery host.

[--alert-host host]¶

Optional argument to limit the alert-specific operation to a single host. This allows customization per host rather than always across all hosts.

Additional alert-specific options¶

--alert alert¶

The name of the alert to operate on

--for duration¶

The amount of time to snooze an alert for. Supported forms:

HH:MM:SS (e.g. 00:05:00 to snooze an alert for 5 minutes)
nD (e.g. 1D to snooze an alert for 24 hours)

Copyright¶

Version¶

RELEASE_NAME