victorops

Documentation

Index

• Constants
• type Config
  • func NewConfig(jsonData json.RawMessage, decryptFn receivers.DecryptFunc) (Config, error)
• type Notifier
  • func New(cfg Config, meta receivers.Metadata, template *templates.Template, ...) *Notifier
  • func (vn *Notifier) Notify(ctx context.Context, as ...*types.Alert) (bool, error)
  • func (vn *Notifier) SendResolved() bool

Constants

const (
	// DefaultMessageType - Victorops uses "CRITICAL" string to indicate "Alerting" state
	DefaultMessageType = "CRITICAL"
)

const FullValidConfigForTesting = `` /* 127-byte string literal not displayed */

FullValidConfigForTesting is a string representation of a JSON object that contains all fields supported by the notifier Config. It can be used without secrets.

const FullValidSecretsForTesting = `{
	"url": "http://localhost-secret"
}`

FullValidSecretsForTesting is a string representation of JSON object that contains all fields that can be overridden from secrets

Types

type Config

type Config struct {
	URL         string `json:"url,omitempty" yaml:"url,omitempty"`
	MessageType string `json:"messageType,omitempty" yaml:"messageType,omitempty"`
	Title       string `json:"title,omitempty" yaml:"title,omitempty"`
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
}

func NewConfig

func NewConfig(jsonData json.RawMessage, decryptFn receivers.DecryptFunc) (Config, error)

type Notifier

type Notifier struct {
	*receivers.Base
	// contains filtered or unexported fields
}

Notifier defines URL property for Victorops REST API and handles notification process by formatting POST body according to Victorops specifications (http://victorops.force.com/knowledgebase/articles/Integration/Alert-Ingestion-API-Documentation/)

func New

func New(cfg Config, meta receivers.Metadata, template *templates.Template, sender receivers.WebhookSender, images images.Provider, logger logging.Logger, appVersion string) *Notifier

New creates an instance of VictoropsNotifier that handles posting notifications to Victorops REST API

func (*Notifier) Notify

func (vn *Notifier) Notify(ctx context.Context, as ...*types.Alert) (bool, error)

Notify sends notification to Victorops via POST to URL endpoint

func (*Notifier) SendResolved

func (vn *Notifier) SendResolved() bool