mirror of
https://github.com/prometheus/alertmanager
synced 2024-12-29 09:32:16 +00:00
114 lines
3.9 KiB
Go
114 lines
3.9 KiB
Go
// Copyright 2018 Prometheus Team
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package cli
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/prometheus/client_golang/api"
|
|
"gopkg.in/alecthomas/kingpin.v2"
|
|
|
|
"github.com/prometheus/alertmanager/cli/format"
|
|
"github.com/prometheus/alertmanager/client"
|
|
"github.com/prometheus/alertmanager/pkg/parse"
|
|
)
|
|
|
|
type alertQueryCmd struct {
|
|
inhibited, silenced, active, unprocessed bool
|
|
|
|
matcherGroups []string
|
|
}
|
|
|
|
const alertHelp = `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.
|
|
`
|
|
|
|
func configureAlertCmd(app *kingpin.Application) {
|
|
var (
|
|
a = &alertQueryCmd{}
|
|
alertCmd = app.Command("alert", alertHelp).PreAction(requireAlertManagerURL)
|
|
queryCmd = alertCmd.Command("query", alertHelp).Default()
|
|
)
|
|
queryCmd.Flag("inhibited", "Show inhibited alerts").Short('i').BoolVar(&a.inhibited)
|
|
queryCmd.Flag("silenced", "Show silenced alerts").Short('s').BoolVar(&a.silenced)
|
|
queryCmd.Flag("active", "Show active alerts").Short('a').BoolVar(&a.active)
|
|
queryCmd.Flag("unprocessed", "Show unprocessed alerts").Short('u').BoolVar(&a.unprocessed)
|
|
queryCmd.Arg("matcher-groups", "Query filter").StringsVar(&a.matcherGroups)
|
|
queryCmd.Action(a.queryAlerts)
|
|
}
|
|
|
|
func (a *alertQueryCmd) queryAlerts(ctx *kingpin.ParseContext) error {
|
|
var filterString = ""
|
|
if len(a.matcherGroups) == 1 {
|
|
// If the parser fails then we likely don't have a (=|=~|!=|!~) so lets
|
|
// assume that the user wants alertname=<arg> and prepend `alertname=`
|
|
// to the front.
|
|
_, err := parse.Matcher(a.matcherGroups[0])
|
|
if err != nil {
|
|
filterString = fmt.Sprintf("{alertname=%s}", a.matcherGroups[0])
|
|
} else {
|
|
filterString = fmt.Sprintf("{%s}", strings.Join(a.matcherGroups, ","))
|
|
}
|
|
} else if len(a.matcherGroups) > 1 {
|
|
filterString = fmt.Sprintf("{%s}", strings.Join(a.matcherGroups, ","))
|
|
}
|
|
|
|
c, err := api.NewClient(api.Config{Address: alertmanagerURL.String()})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
alertAPI := client.NewAlertAPI(c)
|
|
// If no selector was passed, default to showing active alerts.
|
|
if !a.silenced && !a.inhibited && !a.active && !a.unprocessed {
|
|
a.active = true
|
|
}
|
|
fetchedAlerts, err := alertAPI.List(context.Background(), filterString, a.silenced, a.inhibited, a.active, a.unprocessed)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
formatter, found := format.Formatters[output]
|
|
if !found {
|
|
return errors.New("unknown output formatter")
|
|
}
|
|
return formatter.FormatAlerts(fetchedAlerts)
|
|
}
|