Documentation
¶
Index ¶
- Constants
- type Config
- type HandlerConfig
- type Service
- func (s *Service) Alert(teams []string, recipients []string, messageType, message, entityID string, ...) 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) Test(options interface{}) error
- func (s *Service) TestOptions() interface{}
- func (s *Service) Update(newConfig []interface{}) error
Constants ¶
View Source
const DefaultOpsGenieAPIURL = "https://api.opsgenie.com/v1/json/alert"
View Source
const DefaultOpsGenieRecoveryURL = "https://api.opsgenie.com/v1/json/alert/note"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// Whether to enable OpsGenie integration.
Enabled bool `toml:"enabled" override:"enabled"`
// The OpsGenie API key.
APIKey string `toml:"api-key" override:"api-key,redact"`
// The default Teams, can be overridden per alert.
Teams []string `toml:"teams" override:"teams"`
// The default Teams, can be overridden per alert.
Recipients []string `toml:"recipients" override:"recipients"`
// The OpsGenie API URL, should not need to be changed.
URL string `toml:"url" override:"url"`
// The OpsGenie Recovery URL, you can change this based on which behavior you want a recovery to trigger (Add Notes, Close Alert, etc.)
RecoveryURL string `toml:"recovery_url" override:"recovery_url"`
// Whether every alert should automatically go to OpsGenie.
Global bool `toml:"global" override:"global"`
}
type HandlerConfig ¶ added in v1.2.0
Click to show internal directories.
Click to hide internal directories.