victorops

Documentation

Index

• Constants
• type Config
  • func NewConfig() Config
  • func (c Config) Validate() error
• type Diagnostic
• type HandlerConfig
• type Service
  • func NewService(c Config, d Diagnostic) *Service
  • func (s *Service) Alert(routingKey, messageType, message, entityID string, t time.Time, ...) error
  • func (s *Service) Close() error
  • func (s *Service) Global() bool
  • func (s *Service) Handler(c HandlerConfig, ctx ...keyvalue.T) 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

const DefaultVictorOpsAPIURL = "https://alert.victorops.com/integrations/generic/20131114/alert"

Types

type Config

type Config struct {
	// Whether to enable Victor Ops integration.
	Enabled bool `toml:"enabled" override:"enabled"`
	// The Victor Ops API key.
	APIKey string `toml:"api-key" override:"api-key,redact"`
	// The default Routing Key, can be overridden per alert.
	RoutingKey string `toml:"routing-key" override:"routing-key"`
	// The Victor Ops API URL, should not need to be changed.
	URL string `toml:"url" override:"url"`
	// Whether every alert should automatically go to VictorOps.
	Global bool `toml:"global" override:"global"`
	// JSONData indicates that the VictorOps "data" field should contain JSON and not a string.
	JSONData bool `toml:"json-data" override:"json-data"`
}

func NewConfig

func NewConfig() Config

func (Config) Validate

func (c Config) Validate() error

type Diagnostic

type Diagnostic interface {
	WithContext(ctx ...keyvalue.T) Diagnostic

	Error(msg string, err error)
}

type HandlerConfig

type HandlerConfig struct {
	// The routing key to use for the alert.
	// Defaults to the value in the configuration if empty.
	RoutingKey string `mapstructure:"routing-key"`
}

type Service

type Service struct {
	// contains filtered or unexported fields
}

func NewService

func NewService(c Config, d Diagnostic) *Service

func (*Service) Alert

func (s *Service) Alert(routingKey, messageType, message, entityID string, t time.Time, details models.Result) error

func (*Service) Close

func (s *Service) Close() error

func (*Service) Global

func (s *Service) Global() bool

func (*Service) Handler

func (s *Service) Handler(c HandlerConfig, ctx ...keyvalue.T) alert.Handler

func (*Service) Open

func (s *Service) Open() error

func (*Service) Test

func (s *Service) Test(options interface{}) error

func (*Service) TestOptions

func (s *Service) TestOptions() interface{}

func (*Service) Update

func (s *Service) Update(newConfig []interface{}) error