victorops

package

v0.3.0 Latest Latest Go to latest Published: Nov 10, 2023 License: AGPL-3.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/RSDS/alerting

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Config
- func NewConfig(jsonData json.RawMessage) (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 ¶

View Source

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

View Source

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.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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) (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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL