hipchat

Documentation

Index

• type Config
  • func NewConfig() Config
  • func (c Config) Validate() error
• type HandlerConfig
• type Service
  • func NewService(c Config, l *log.Logger) *Service
  • func (s *Service) Alert(room, token, message 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

Types

type Config

type Config struct {
	// Whether HipChat integration is enabled.
	Enabled bool `toml:"enabled" override:"enabled"`
	// The HipChat API URL.
	URL string `toml:"url" override:"url"`
	// The authentication token for this notification, can be overridden per alert.
	// https://www.hipchat.com/docs/apiv2/auth for info on obtaining a token.
	Token string `toml:"token" override:"token,redact"`
	// The default room, can be overridden per alert.
	Room string `toml:"room" override:"room"`
	// Whether all alerts should automatically post to HipChat
	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"`
}

func NewConfig

func NewConfig() Config

func (Config) Validate

func (c Config) Validate() error

type HandlerConfig

type HandlerConfig struct {
	// HipChat room in which to post messages.
	// If empty uses the channel from the configuration.
	Room string `mapstructure:"room"`

	// HipChat authentication token.
	// If empty uses the token from the configuration.
	Token string `mapstructure:"token"`
}

type Service

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

func NewService

func NewService(c Config, l *log.Logger) *Service

func (*Service) Alert

func (s *Service) Alert(room, token, message string, level alert.Level) 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, l *log.Logger) alert.Handler

func (*Service) Open

func (s *Service) Open() error

func (*Service) StateChangesOnly

func (s *Service) StateChangesOnly() bool

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