monitoring

Start and stop the Refinery pipeline for Monitoring data capture
Show status of Monitoring components and Refinery pipeline
Enable and disable alerts within the Monitoring Alerting component

Refinery Monitoring

refinery monitoring [option]
Options:
--alert                 --disable-alert      --run-check
--alert-host            --enable-alert       --snooze-alert
--alert-port            --for                --start-capture
--capture-status        --list-alerts        --stop-capture
--component-status      --list-checks

--start-capture

Start the Refinery data-capture stack for all Monitoring data.

--stop-capture

Stop the Refinery data-capture stack for all Monitoring data.

--capture-status

Show the Refinery Monitoring data-capture stack status.

--component-status

Show status of all the KX Refinery Monitoring components.

Note that this returns the status of components running via systemd.

--list-checks

List all the monitoring checks defined within Refinery.

--run-check check

Run the specified check (as returned by --list-checks) and prints the output into the console.

--list-alerts

List all the currently configured alerts from the Alerting components.

Requires the Required Alert-specific options.

--disable-alert

Disable a specific alert until manually re-enabled or the Alerting component is restarted.

Requires both Required Alert-specific options and Additional Alert-specific options.

--enable-alert

Re-enable a specific alert previously disabled. Also re-enables a snoozed alert immediately.

Requires both Required Alert-specific options and Additional Alert-specific options.

--snooze-alert

Snooze an alert for a specified amount of time.

Can be applied to a disabled alert to delay the re-enabling by a specific amount of time.

Requires both Required Alert-specific options and Additional Alert-specific options.

Required alert-specific options

--alert-port port

Port the Alerting components are bound to on all Refinery hosts.

The CLI expects the port to be the same on every Refinery host.

--alert-host host

Limit the alert-specific operation to a single host. This allows customization per host rather than across all hosts.

Additional alert-specific options

--alert alert

Name of the alert to operate on.

--for duration

Period 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)