notifydrivers

Documentation

Index

• Constants
• func RegisterNotifier(plugin *NotifierPlugin)
• type NotificationConfig
• type Notifier
  • func InitNotifier(config NotificationConfig) (Notifier, error)
• type NotifierFactory
• type NotifierPlugin
  • func GetNotifiers() []*NotifierPlugin
  • func GetPlugin(typ string) (*NotifierPlugin, error)

Constants

const (
	ErrUnsupportedNotificationType = errors.Error("Unsupported notification type")
)

Functions

func RegisterNotifier

func RegisterNotifier(plugin *NotifierPlugin)

Types

type NotificationConfig

type NotificationConfig struct {
	Ctx                   context.Context
	Id                    string
	Name                  string
	Type                  string
	SendReminder          bool
	DisableResolveMessage bool
	Frequency             time.Duration
	Settings              jsonutils.JSONObject
}

type Notifier

type Notifier interface {
	GetType() string

	GetNotifierId() string
	// GetIsDefault() bool
	GetSendReminder() bool
	GetDisableResolveMessage() bool
	GetFrequency() time.Duration
}

Notifier is responsible for sending alert notifications.

func InitNotifier

func InitNotifier(config NotificationConfig) (Notifier, error)

InitNotifier instantiate a new notifier based on the model

type NotifierFactory

type NotifierFactory func(notification NotificationConfig) (Notifier, error)

type NotifierPlugin

type NotifierPlugin struct {
	Type               string
	Factory            NotifierFactory
	ValidateCreateData func(cred mcclient.IIdentityProvider, input monitor.NotificationCreateInput) (monitor.NotificationCreateInput, error)
}

func GetNotifiers

func GetNotifiers() []*NotifierPlugin

func GetPlugin

func GetPlugin(typ string) (*NotifierPlugin, error)