noust alert
Alert rules on CPU, memory, disk, load and traffic.
noust alert [OPTIONS] COMMAND [ARGS]...Subcommands: ack, disable, enable, list, metrics, remove, set, status, unack
noust alert ack
Take an alert that is firing: its reminders stop and the channels are told.
noust alert ack [OPTIONS] NAMEArguments: name
| Option | What it does | Default |
|---|---|---|
--app |
The application the alert is about; leave out for the server's. | `` |
--by |
Who is taking it, as the channels will say. | cli |
--reason |
Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on. |
noust alert disable
Turn a rule off; what it had decided is forgotten.
noust alert disable [OPTIONS] NAMEArguments: name
| Option | What it does | Default |
|---|---|---|
--reason |
Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on. |
noust alert enable
Turn a rule on.
noust alert enable [OPTIONS] NAMEArguments: name
| Option | What it does | Default |
|---|---|---|
--reason |
Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on. |
noust alert list
List the alert rules and how many subjects of each are firing.
noust alert list [OPTIONS]| Option | What it does | Default |
|---|---|---|
-v, --verbose |
Show the detail of each step. | |
--dry-run |
Rehearse without changing anything. Read-only checks still run. | |
--no-color |
Never emit colour. | |
--json |
Print the rules as JSON. | |
--reason |
Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on. |
noust alert metrics
List what a rule can watch, and the unit its limit is written in.
noust alert metrics [OPTIONS]| Option | What it does | Default |
|---|---|---|
-v, --verbose |
Show the detail of each step. | |
--dry-run |
Rehearse without changing anything. Read-only checks still run. | |
--no-color |
Never emit colour. | |
--json |
Print the metrics as JSON. | |
--reason |
Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on. |
noust alert remove
Remove a rule and what it remembered.
noust alert remove [OPTIONS] NAMEArguments: name
| Option | What it does | Default |
|---|---|---|
--reason |
Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on. |
noust alert set
Create an alert rule, or replace the one of that name.
noust alert set [OPTIONS] NAMEArguments: name
| Option | What it does | Default |
|---|---|---|
--metric |
What to watch. | |
--above |
Fire when it stays above LIMIT (90%, 512MB, 2MB/s). | |
--below |
Fire when it stays below LIMIT. | |
--or-equal |
Count the limit itself as a breach (>= and <=). | |
--for |
How long it must hold before it fires (at least 1m): 5m, 1h. | 5m |
--hysteresis |
How far back inside the limit it must come to clear, in the metric's unit. | 0 |
--cooldown |
The least time between two messages about the same thing. | 1h |
--app |
The application, for an application metric (every one by default). | |
--severity |
warning |
|
--remind |
Say it again every cooldown while it keeps firing. | |
--disabled |
Create it switched off. | |
--note |
Free text for whoever reads the rule later. | `` |
--reason |
Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on. |
noust alert status
Show the alerts that are firing now.
noust alert status [OPTIONS]| Option | What it does | Default |
|---|---|---|
-v, --verbose |
Show the detail of each step. | |
--dry-run |
Rehearse without changing anything. Read-only checks still run. | |
--no-color |
Never emit colour. | |
--json |
Print the firing alerts as JSON. | |
--reason |
Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on. |
noust alert unack
Hand a firing alert back: its reminder speaks again.
noust alert unack [OPTIONS] NAMEArguments: name
| Option | What it does | Default |
|---|---|---|
--app |
The application the alert is about; leave out for the server's. | `` |
--reason |
Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on. |