Documentation
¶
Index ¶
- Constants
- type Config
- type HandlerConfig
- type Service
- func (s *Service) Alert(channel, message, username, iconEmoji string, level alert.Level) error
- func (s *Service) Close() error
- func (s *Service) Global() bool
- func (s *Service) Handler(c HandlerConfig, l *log.Logger) alert.Handler
- func (s *Service) Open() error
- func (s *Service) StateChangesOnly() bool
- func (s *Service) Test(options interface{}) error
- func (s *Service) TestOptions() interface{}
- func (s *Service) Update(newConfig []interface{}) error
Constants ¶
View Source
const DefaultUsername = "kapacitor"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// Whether Slack integration is enabled.
Enabled bool `toml:"enabled" override:"enabled"`
// The Slack webhook URL, can be obtained by adding Incoming Webhook integration.
URL string `toml:"url" override:"url,redact"`
// The default channel, can be overridden per alert.
Channel string `toml:"channel" override:"channel"`
// The username of the Slack bot.
// Default: kapacitor
Username string `toml:"username" override:"username"`
// IconEmoji uses an emoji instead of the normal icon for the message.
// The contents should be the name of an emoji surrounded with ':', i.e. ':chart_with_upwards_trend:'
IconEmoji string `toml:"icon-emoji" override:"icon-emoji"`
// Whether all alerts should automatically post to slack
Global bool `toml:"global" override:"global"`
// Whether all alerts should automatically use stateChangesOnly mode.
// Only applies if global is also set.
StateChangesOnly bool `toml:"state-changes-only" override:"state-changes-only"`
// Path to CA file
SSLCA string `toml:"ssl-ca" override:"ssl-ca"`
// Path to host cert file
SSLCert string `toml:"ssl-cert" override:"ssl-cert"`
// Path to cert key file
SSLKey string `toml:"ssl-key" override:"ssl-key"`
// Use SSL but skip chain & host verification
InsecureSkipVerify bool `toml:"insecure-skip-verify" override:"insecure-skip-verify"`
}
type HandlerConfig ¶ added in v1.2.0
type HandlerConfig struct {
// Slack channel in which to post messages.
// If empty uses the channel from the configuration.
Channel string `mapstructure:"channel"`
// Username of the Slack bot.
// If empty uses the username from the configuration.
Username string `mapstructure:"username"`
// IconEmoji is an emoji name surrounded in ':' characters.
// The emoji image will replace the normal user icon for the slack bot.
IconEmoji string `mapstructure:"icon-emoji"`
}
Click to show internal directories.
Click to hide internal directories.