config: add new YMAL config
This commit is contained in:
Fabian Reinartz
parent
d91ac2ef11
commit
cb9c85ea5a
|
|
@ -0,0 +1,471 @@
|
|||
// Copyright 2015 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 config
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"net/url"
|
||||
"regexp"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"gopkg.in/yaml.v2"
|
||||
|
||||
clientmodel "github.com/prometheus/client_golang/model"
|
||||
|
||||
"github.com/prometheus/prometheus/util/strutil"
|
||||
)
|
||||
|
||||
var (
|
||||
DefaultAggrRule = AggrRule{
|
||||
RepeatRate: Duration(2 * time.Hour),
|
||||
SendResolved: false,
|
||||
}
|
||||
|
||||
DefaultHipchatConfig = HipchatConfig{
|
||||
Color: "purple",
|
||||
ColorResolved: "green",
|
||||
MessageFormat: HipchatFormatHTML,
|
||||
}
|
||||
|
||||
DefaultSlackConfig = SlackConfig{
|
||||
Color: "warning",
|
||||
ColorResolved: "good",
|
||||
}
|
||||
)
|
||||
|
||||
// Load parses the YAML input s into a Config.
|
||||
func Load(s string) (*Config, error) {
|
||||
cfg := &Config{}
|
||||
err := yaml.Unmarshal([]byte(s), cfg)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
cfg.original = s
|
||||
return cfg, nil
|
||||
}
|
||||
|
||||
// LoadFromFile parses the given YAML file into a Config.
|
||||
func LoadFromFile(filename string) (*Config, error) {
|
||||
content, err := ioutil.ReadFile(filename)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return Load(string(content))
|
||||
}
|
||||
|
||||
// Config is the top-level configuration for Alertmanager's config files.
|
||||
type Config struct {
|
||||
AggrRules []*AggrRule `yaml:"aggregation_rules,omitempty"`
|
||||
InhibitRules []*InhibitRule `yaml:"inhibit_rules,omitempty"`
|
||||
NotificationConfigs []*NotificationConfig `yaml:"notification_configs,omitempty"`
|
||||
|
||||
// Catches all undefined fields and must be empty after parsing.
|
||||
XXX map[string]interface{} `yaml:",inline"`
|
||||
|
||||
// original is the input from which the config was parsed.
|
||||
original string
|
||||
}
|
||||
|
||||
func checkOverflow(m map[string]interface{}, ctx string) error {
|
||||
if len(m) > 0 {
|
||||
var keys []string
|
||||
for k := range m {
|
||||
keys = append(keys, k)
|
||||
}
|
||||
return fmt.Errorf("unknown fields in %s: %s", ctx, strings.Join(keys, ", "))
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c Config) String() string {
|
||||
if c.original != "" {
|
||||
return c.original
|
||||
}
|
||||
b, err := yaml.Marshal(c)
|
||||
if err != nil {
|
||||
return fmt.Sprintf("<error creating config string: %s>", err)
|
||||
}
|
||||
return string(b)
|
||||
}
|
||||
|
||||
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||
func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
// We want to set c to the defaults and then overwrite it with the input.
|
||||
// To make unmarshal fill the plain data struct rather than calling UnmarshalYAML
|
||||
// again, we have to hide it using a type indirection.
|
||||
type plain Config
|
||||
if err := unmarshal((*plain)(c)); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
names := map[string]struct{}{}
|
||||
|
||||
for _, nc := range c.NotificationConfigs {
|
||||
if _, ok := names[nc.Name]; ok {
|
||||
return fmt.Errorf("notification config name %q is not unique", nc.Name)
|
||||
}
|
||||
names[nc.Name] = struct{}{}
|
||||
}
|
||||
return checkOverflow(c.XXX, "config")
|
||||
}
|
||||
|
||||
// An InhibitRule specifies that a class of (source) alerts should inhibit
|
||||
// notifications for another class of (target) alerts if all specified matching
|
||||
// labels are equal between the two alerts. This may be used to inhibit alerts
|
||||
// from sending notifications if their meaning is logically a subset of a
|
||||
// higher-level alert.
|
||||
type InhibitRule struct {
|
||||
// The set of Filters which define the group of source alerts (which inhibit
|
||||
// the target alerts).
|
||||
SourceFilters []*Filter `yaml:"source_filters,omitempty"`
|
||||
|
||||
// The set of Filters which define the group of target alerts (which are
|
||||
// inhibited by the source alerts).
|
||||
TargetFilters []*Filter `yaml:"target_filters,omitempty"`
|
||||
|
||||
// A set of label names whose label values need to be identical in source and
|
||||
// target alerts in order for the inhibition to take effect.
|
||||
MatchOn []string `yaml:"match_on,omitempty"`
|
||||
|
||||
// How many seconds to wait for a corresponding inhibit source alert to
|
||||
// appear before sending any notifications for active target alerts.
|
||||
// TODO(julius): Not supported yet. Implement this!
|
||||
// optional int32 before_allowance = 4 [default = 0];
|
||||
// How many seconds to wait after a corresponding inhibit source alert
|
||||
// disappears before sending any notifications for active target alerts.
|
||||
// TODO(julius): Not supported yet. Implement this!
|
||||
// optional int32 after_allowance = 5 [default = 0];
|
||||
|
||||
// Catches all undefined fields and must be empty after parsing.
|
||||
XXX map[string]interface{} `yaml:",inline"`
|
||||
}
|
||||
|
||||
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||
func (r *InhibitRule) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
type plain InhibitRule
|
||||
if err := unmarshal((*plain)(r)); err != nil {
|
||||
return err
|
||||
}
|
||||
return checkOverflow(r.XXX, "inhibit rule")
|
||||
}
|
||||
|
||||
// Grouping and notification setting definitions for alerts.
|
||||
type AggrRule struct {
|
||||
// Filters that define which alerts are matched by this AggregationRule.
|
||||
Filters []*Filter `yaml:"filters,omitempty"`
|
||||
|
||||
// How many seconds to wait before resending a notification for a specific alert.
|
||||
RepeatRate model.Duration `yaml:"repeat_rate"`
|
||||
|
||||
// Notification configurations to use for this AggregationRule, referenced
|
||||
// by their name.
|
||||
NotificationConfigs []string `yaml:"notification_configs"`
|
||||
|
||||
// Catches all undefined fields and must be empty after parsing.
|
||||
XXX map[string]interface{} `yaml:",inline"`
|
||||
}
|
||||
|
||||
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||
func (r *AggrRule) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
*r = DefaultAggrRule
|
||||
type plain AggrRule
|
||||
if err := unmarshal((*plain)(r)); err != nil {
|
||||
return err
|
||||
}
|
||||
if len(r.NotificationConfigs) == 0 {
|
||||
return fmt.Errorf("aggregation rule needs at least one notification config")
|
||||
}
|
||||
return checkOverflow(r.XXX, "aggregation rule")
|
||||
}
|
||||
|
||||
// A regex-based label filter used in aggregations.
|
||||
type Filter struct {
|
||||
Name string `yaml:"name"`
|
||||
Regex *Regexp `yaml:"regex"`
|
||||
|
||||
// Catches all undefined fields and must be empty after parsing.
|
||||
XXX map[string]interface{} `yaml:",inline"`
|
||||
}
|
||||
|
||||
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||
func (f *Filter) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
type plain Filter
|
||||
if err := unmarshal((*plain)(f)); err != nil {
|
||||
return err
|
||||
}
|
||||
return checkOverflow(r.XXX, "aggregation rule")
|
||||
}
|
||||
|
||||
// Notification configuration definition.
|
||||
type NotificationConfig struct {
|
||||
// Name of this NotificationConfig. Referenced from AggregationRule.
|
||||
Name string `yaml:"name"`
|
||||
|
||||
// Notify when resolved.
|
||||
SendResolved bool `yaml:"send_resolved"`
|
||||
|
||||
// Zero or more PagerDuty notification configurations.
|
||||
PagerdutyConfigs []*PagerDutyConfig `yaml:"pagerduty_configs"`
|
||||
|
||||
// Zero or more email notification configurations.
|
||||
EmailConfigs []*EmailConfig `yaml:"email_configs"`
|
||||
|
||||
// Zero or more pushover notification configurations.
|
||||
PushoverConfigs []*PushoverConfig `yaml:"pushover_configs"`
|
||||
|
||||
// Zero or more hipchat notification configurations.
|
||||
HipchatConfigs []*HipchatConfig `yaml:"hipchat_configs"`
|
||||
|
||||
// Zero or more slack notification configurations.
|
||||
SlackConfigs []*SlackConfig `yaml:"slack_config"`
|
||||
|
||||
// Zero or more Flowdock notification configurations.
|
||||
FlowdockConfigs []*FlowdockConfig `yaml:"flowdock_config"`
|
||||
|
||||
// Zero or more generic web hook notification configurations.
|
||||
WebhookConfig []*WebhookConfig `yaml:"webhook_config"`
|
||||
|
||||
// Catches all undefined fields and must be empty after parsing.
|
||||
XXX map[string]interface{} `yaml:",inline"`
|
||||
}
|
||||
|
||||
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||
func (c *NotificationConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
type plain NotificationConfig
|
||||
if err := unmarshal((*plain)(c)); err != nil {
|
||||
return err
|
||||
}
|
||||
if c.Name == "" {
|
||||
return fmt.Errorf("missing name in notification config")
|
||||
}
|
||||
return checkOverflow(r.XXX, "notification config")
|
||||
}
|
||||
|
||||
// Configuration for notification via PagerDuty.
|
||||
type PagerdutyConfig struct {
|
||||
// PagerDuty service key, see:
|
||||
// http://developer.pagerduty.com/documentation/integration/events
|
||||
ServiceKey string `yaml:"service_key"`
|
||||
}
|
||||
|
||||
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||
func (c *PagerdutyConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
type plain PagerdutyConfig
|
||||
if err := unmarshal((*plain)(c)); err != nil {
|
||||
return err
|
||||
}
|
||||
if c.ServiceKey == "" {
|
||||
return fmt.Errorf("missing service key in PagerDuty config")
|
||||
}
|
||||
return checkOverflow(r.XXX, "pagerduty config")
|
||||
}
|
||||
|
||||
// Configuration for notification via mail.
|
||||
type EmailConfig struct {
|
||||
// Email address to notify.
|
||||
Email string `yaml:"email"`
|
||||
}
|
||||
|
||||
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||
func (c *EmailConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
type plain EmailConfig
|
||||
if err := unmarshal((*plain)(c)); err != nil {
|
||||
return err
|
||||
}
|
||||
if c.Email == "" {
|
||||
return fmt.Errorf("missing email address in email config")
|
||||
}
|
||||
return checkOverflow(r.XXX, "email config")
|
||||
}
|
||||
|
||||
// Configuration for notification via pushover.net.
|
||||
type PushoverConfig struct {
|
||||
// Pushover token.
|
||||
Token string `yaml:"token"`
|
||||
|
||||
// Pushover user_key.
|
||||
UserKey string `yaml:"user_key"`
|
||||
}
|
||||
|
||||
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||
func (c *PushoverConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
type plain PushoverConfig
|
||||
if err := unmarshal((*plain)(c)); err != nil {
|
||||
return err
|
||||
}
|
||||
if c.Token == "" {
|
||||
return fmt.Errorf("missing token in Pushover config")
|
||||
}
|
||||
if c.UserKey == "" {
|
||||
return fmt.Errorf("missing user key in Pushover config")
|
||||
}
|
||||
return checkOverflow(r.XXX, "pushover config")
|
||||
}
|
||||
|
||||
type HipchatFormat string
|
||||
|
||||
const (
|
||||
HipchatFormatHTML HipchatFormat = "html"
|
||||
HipchatFormatText HipchatFormat = "text"
|
||||
)
|
||||
|
||||
// Configuration for notification via HipChat.
|
||||
// https://www.hipchat.com/docs/apiv2/method/send_room_notification
|
||||
type HipchatConfig struct {
|
||||
// HipChat auth token, (https://www.hipchat.com/docs/api/auth).
|
||||
AuthToken string `yaml:"auth_token"`
|
||||
|
||||
// HipChat room id, (https://www.hipchat.com/rooms/ids).
|
||||
RoomID int `yaml:"room_id"`
|
||||
|
||||
// Color of message when triggered.
|
||||
Color string `yaml:"color"`
|
||||
|
||||
// Color of message when resolved.
|
||||
ColorResolved string `yaml:"color_resolved"`
|
||||
|
||||
// Should this message notify or not.
|
||||
Notify bool `yaml:"notify"`
|
||||
|
||||
// Prefix to be put in front of the message (useful for @mentions, etc.).
|
||||
Prefix string `yaml:"prefix"`
|
||||
|
||||
// Format the message as "html" or "text".
|
||||
MessageFormat HipchatFormat `yaml:"message_format"`
|
||||
}
|
||||
|
||||
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||
func (c *HipchatConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
*c = DefaultHipchatConfig
|
||||
type plain HipchatConfig
|
||||
if err := unmarshal((*plain)(c)); err != nil {
|
||||
return err
|
||||
}
|
||||
if c.AuthToken == "" {
|
||||
return fmt.Errorf("missing auth token in HipChat config")
|
||||
}
|
||||
if c.RoomID == "" {
|
||||
return fmt.Errorf("missing room ID in HipChat config")
|
||||
}
|
||||
if c.MessageFormat != HipchatFormatHTML && c.MessageFormat != HipchatFormatText {
|
||||
return fmt.Errorf("invalid message format %q", c.MessageFormat)
|
||||
}
|
||||
return checkOverflow(r.XXX, "hipchat config")
|
||||
}
|
||||
|
||||
// Configuration for notification via Slack.
|
||||
type SlackConfig struct {
|
||||
// Slack webhook URL, (https://api.slack.com/incoming-webhooks).
|
||||
WebhookURL string `yaml:"webhook_url"`
|
||||
|
||||
// Slack channel override, (like #other-channel or @username).
|
||||
Channel string `yaml:"channel"`
|
||||
|
||||
// Color of message when triggered.
|
||||
Color string `yaml:"color"`
|
||||
|
||||
// Color of message when resolved.
|
||||
ColorResolved string `yaml:"color_resolved"`
|
||||
}
|
||||
|
||||
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||
func (c *SlackConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
*c = DefaultSlackConfig
|
||||
type plain SlackConfig
|
||||
if err := unmarshal((*plain)(c)); err != nil {
|
||||
return err
|
||||
}
|
||||
if c.WebhookURL == "" {
|
||||
return fmt.Errorf("missing webhook URL in Slack config")
|
||||
}
|
||||
if c.Channel == "" {
|
||||
return fmt.Errorf("missing channel in Slack config")
|
||||
}
|
||||
return checkOverflow(r.XXX, "slack config")
|
||||
}
|
||||
|
||||
// Configuration for notification via Flowdock.
|
||||
type FlowdockConfig struct {
|
||||
// Flowdock flow API token.
|
||||
APIToken string `yaml:"api_token"`
|
||||
|
||||
// Flowdock from_address.
|
||||
FromAddress string `yaml:"from_address"`
|
||||
|
||||
// Flowdock flow tags.
|
||||
Tags []string `yaml:"tags"`
|
||||
}
|
||||
|
||||
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||
func (c *FlowdockConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
type plain FlowdockConfig
|
||||
if err := unmarshal((*plain)(c)); err != nil {
|
||||
return err
|
||||
}
|
||||
if c.APIToken == "" {
|
||||
return fmt.Errorf("missing API token in Flowdock config")
|
||||
}
|
||||
if c.FromAddress == "" {
|
||||
return fmt.Errorf("missing from address in Flowdock config")
|
||||
}
|
||||
return checkOverflow(r.XXX, "flowdock config")
|
||||
}
|
||||
|
||||
// Configuration for notification via generic webhook.
|
||||
type WebhookConfig struct {
|
||||
// URL to send POST request to.
|
||||
URL string `yaml:"url"`
|
||||
}
|
||||
|
||||
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||
func (c *WebhookConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
type plain WebhookConfig
|
||||
if err := unmarshal((*plain)(c)); err != nil {
|
||||
return err
|
||||
}
|
||||
if c.URL == "" {
|
||||
return fmt.Errorf("missing URL in webhook config")
|
||||
}
|
||||
return checkOverflow(r.XXX, "slack config")
|
||||
}
|
||||
|
||||
// Regexp encapsulates a regexp.Regexp and makes it YAML marshallable.
|
||||
type Regexp struct {
|
||||
regexp.Regexp
|
||||
}
|
||||
|
||||
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||
func (re *Regexp) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
var s string
|
||||
if err := unmarshal(&s); err != nil {
|
||||
return err
|
||||
}
|
||||
regex, err := regexp.Compile(s)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
re.Regexp = *regex
|
||||
return nil
|
||||
}
|
||||
|
||||
// MarshalYAML implements the yaml.Marshaler interface.
|
||||
func (re *Regexp) MarshalYAML() (interface{}, error) {
|
||||
if re != nil {
|
||||
return re.String(), nil
|
||||
}
|
||||
return nil, nil
|
||||
}
|
||||
Loading…
Reference in New Issue