notify

Documentation

Index

• Constants
• func ShouldNotify(device models.Device, smartAttrs measurements.Smart, notifyLevel string, ...) bool
• type Notify
  • func New(logger logrus.FieldLogger, appconfig config.Interface, device models.Device, ...) Notify
  • func (n *Notify) GenShoutrrrNotificationParams(shoutrrrUrl string) (string, *shoutrrrTypes.Params, error)
  • func (n *Notify) Send() error
  • func (n *Notify) SendScriptNotification(scriptUrl string) error
  • func (n *Notify) SendShoutrrrNotification(shoutrrrUrl string) error
  • func (n *Notify) SendWebhookNotification(webhookUrl string) error
• type Payload
  • func NewPayload(device models.Device, test bool) Payload
  • func (p *Payload) GenerateFailureType(deviceStatus pkg.DeviceStatus) string
  • func (p *Payload) GenerateMessage() string
  • func (p *Payload) GenerateSubject() string

Constants

const NotifyFailureTypeBothFailure = "SmartFailure" //SmartFailure always takes precedence when Scrutiny & Smart failed.

const NotifyFailureTypeEmailTest = "EmailTest"

const NotifyFailureTypeScrutinyFailure = "ScrutinyFailure"

const NotifyFailureTypeSmartFailure = "SmartFailure"

Functions

func ShouldNotify

func ShouldNotify(device models.Device, smartAttrs measurements.Smart, notifyLevel string, notifyFilterAttributes string) bool

ShouldNotify check if the error Message should be filtered (level mismatch or filtered_attributes)

Types

type Notify

type Notify struct {
	Logger  logrus.FieldLogger
	Config  config.Interface
	Payload Payload
}

func New

func New(logger logrus.FieldLogger, appconfig config.Interface, device models.Device, test bool) Notify

func (*Notify) GenShoutrrrNotificationParams

func (n *Notify) GenShoutrrrNotificationParams(shoutrrrUrl string) (string, *shoutrrrTypes.Params, error)

func (*Notify) Send

func (n *Notify) Send() error

func (*Notify) SendScriptNotification

func (n *Notify) SendScriptNotification(scriptUrl string) error

func (*Notify) SendShoutrrrNotification

func (n *Notify) SendShoutrrrNotification(shoutrrrUrl string) error

func (*Notify) SendWebhookNotification

func (n *Notify) SendWebhookNotification(webhookUrl string) error

type Payload

type Payload struct {
	DeviceType   string `json:"device_type"`   //ATA/SCSI/NVMe
	DeviceName   string `json:"device_name"`   //dev/sda
	DeviceSerial string `json:"device_serial"` //WDDJ324KSO
	Test         bool   `json:"test"`          // false

	//private, populated during init (marked as Public for JSON serialization)
	Date        string `json:"date"`         //populated by Send function.
	FailureType string `json:"failure_type"` //EmailTest, BothFail, SmartFail, ScrutinyFail
	Subject     string `json:"subject"`
	Message     string `json:"message"`
}

TODO: include host and/or user label for device.

func NewPayload

func NewPayload(device models.Device, test bool) Payload

func (*Payload) GenerateFailureType

func (p *Payload) GenerateFailureType(deviceStatus pkg.DeviceStatus) string

func (*Payload) GenerateMessage

func (p *Payload) GenerateMessage() string

func (*Payload) GenerateSubject

func (p *Payload) GenerateSubject() string