| amtool(1) | 0.25.0 | amtool(1) |
amtool - Tooling for the Prometheus alert manager
View and modify the current Alertmanager state.
Config File: The alertmanager tool will read a config file in YAML format from one of two default config locations: $HOME/.config/prometheus/amtool.yml or /etc/prometheus/amtool.yml
All flags can be given in the config file, but the following are the suited for static configuration:
alertmanager.url Set a default alertmanager url for each request
author Set a default author value for new silences. If this argument is not specified then the username will be used
require-comment Bool, whether to require a comment on silence creation. Defaults to true
output Set a default output type. Options are (simple, extended, json)
date.format Sets the output format for dates. Defaults to "2006-01-02 15:04:05 MST"
http.config.file HTTP client configuration file for amtool to connect to Alertmanager. The format is https://prometheus.io/docs/alerting/latest/configuration/#http_config.
Show help.
View and search through current alerts.
Amtool has a simplified prometheus query syntax, but contains robust support for bash variable expansions. The non-option section of arguments constructs a list of "Matcher Groups" that will be used to filter your query. The following examples will attempt to show this behaviour in action:
amtool alert query alertname=foo node=bar
This query will match all alerts with the alertname=foo and node=bar label value pairs set.
amtool alert query foo node=bar
If alertname is omitted and the first argument does not contain a '=' or a '=~' then it will be assumed to be the value of the alertname pair.
amtool alert query 'alertname=~foo.*'
As well as direct equality, regex matching is also supported. The '=~' syntax (similar to prometheus) is used to represent a regex match. Regex matching can be used in combination with a direct match.
Amtool supports several flags for filtering the returned alerts by state (inhibited, silenced, active, unprocessed). If none of these flags is given, only active alerts are returned.
Add a new alert.
This command is used to add a new alert to Alertmanager.
To add a new alert with labels:
amtool alert add alertname=foo node=bar
If alertname is omitted and the first argument does not contain a '=' then it will be assumed to be the value of the alertname pair.
amtool alert add foo node=bar
One or more annotations can be added using the --annotation flag:
amtool alert add foo node=bar --annotation=runbook='http://runbook.biz' --annotation=summary='summary of the alert' --annotation=description='description of the alert'
Additional flags such as --generator-url, --start, and --end are also supported.
Add a new alertmanager silence
This statement will add a silence that matches alerts with the alertname=foo and node=bar label value pairs set.
If alertname is omitted and the first argument does not contain a '=' or a '=~' then it will be assumed to be the value of the alertname pair.
As well as direct equality, regex matching is also supported. The '=~' syntax (similar to Prometheus) is used to represent a regex match. Regex matching can be used in combination with a direct match.
expire an alertmanager silence
Import alertmanager silences from JSON file or stdin
This command can be used to bulk import silences from a JSON file created by query command. For example:
amtool silence query -o json foo > foo.json
amtool silence import foo.json
JSON data can also come from stdin if no param is specified.
Query Alertmanager silences.
Amtool has a simplified prometheus query syntax, but contains robust support for bash variable expansions. The non-option section of arguments constructs a list of "Matcher Groups" that will be used to filter your query. The following examples will attempt to show this behaviour in action:
amtool silence query alertname=foo node=bar
This query will match all silences with the alertname=foo and node=bar label value pairs set.
amtool silence query foo node=bar
If alertname is omitted and the first argument does not contain a '=' or a '=~' then it will be assumed to be the value of the alertname pair.
amtool silence query 'alertname=~foo.*'
As well as direct equality, regex matching is also supported. The '=~' syntax (similar to prometheus) is used to represent a regex match. Regex matching can be used in combination with a direct match.
In addition to filtering by silence labels, one can also query for silences that are due to expire soon with the "--within" parameter. In the event that you want to preemptively act upon expiring silences by either fixing them or extending them. For example:
amtool silence query --within 8h
returns all the silences due to expire within the next 8 hours. This syntax can also be combined with the label based filtering above for more flexibility.
The "--expired" parameter returns only expired silences. Used in combination with "--within=TIME", amtool returns the silences that expired within the preceding duration.
amtool silence query --within 2h --expired
returns all silences that expired within the preceding 2 hours.
Update silences
Validate alertmanager config files
Will validate the syntax and schema for alertmanager config file and associated templates. Non existing templates will not trigger errors.
View cluster status and peers.
View current config.
The amount of output is controlled by the output selection flag: - Simple: Print just the running config - Extended: Print the running config as well as uptime and all version info - Json: Print entire config object as json
Prints alert routing tree
Will print whole routing tree in form of ASCII tree view.
Routing is loaded from a local configuration file or a running Alertmanager configuration. Specifying --config.file takes precedence over --alertmanager.url.
Example:
amtool config routes [show] --config.file=doc/examples/simple.yml
Test alert routing
Will return receiver names which the alert with given labels resolves to. If the labelset resolves to multiple receivers, they are printed out in order as defined in the routing tree.
Routing is loaded from a local configuration file or a running Alertmanager configuration. Specifying --config.file takes precedence over --alertmanager.url.
Example:
amtool config routes test --config.file=doc/examples/simple.yml --verify.receivers=team-DB-pager service=database
Render a given definition in a template file to standard output.
| amtool, | version |