mirror of
https://github.com/henrygd/beszel.git
synced 2025-12-16 18:26:16 +01:00
* Add support for alerts via shoutrrr This provides users the ability to use a wide variety of notification platforms instead of just email. If there's a problem sending a notification via shoutrrr, an error is logged and email is attempted as a fallback. Since this uses Viper, users can set a notification type and URL via either a config file or environment variable. In the beszel_data folder (where the sqlite dbs reside), create an alerts.env file to set values that way. Values: * NOTIFICATION_TYPE * If this is `shoutrrr`, then the shoutrrr library is used. Any other value, including not being set, uses the fallback email behavior. * NOTIFICATION_URL * If NOTIFICATION_TYPE is shoutrrr, this is the URL given to shoutrrr to send the alert. See list of supported services: https://containrrr.dev/shoutrrr/services/overview/ Note: there's currently a bug in viper v1.18.2+ where environment variable overrides aren't functioning when no config file exists, so this library should remain pinned to 1.18.1 until that's fixed. See: https://github.com/spf13/viper/issues/1895 * Update documentation * Log shoutrrr URL instead of unused "to" var
196 lines
6.0 KiB
Go
196 lines
6.0 KiB
Go
// Package alerts handles alert management and delivery.
|
|
package alerts
|
|
|
|
import (
|
|
"beszel/internal/entities/system"
|
|
"fmt"
|
|
"net/mail"
|
|
|
|
"github.com/containrrr/shoutrrr"
|
|
"github.com/pocketbase/dbx"
|
|
"github.com/pocketbase/pocketbase"
|
|
"github.com/pocketbase/pocketbase/models"
|
|
"github.com/pocketbase/pocketbase/tools/mailer"
|
|
"github.com/spf13/viper"
|
|
)
|
|
|
|
type AlertManager struct {
|
|
app *pocketbase.PocketBase
|
|
config AlertConfig
|
|
}
|
|
|
|
type AlertConfig struct {
|
|
NotificationType string `mapstructure:"NOTIFICATION_TYPE"`
|
|
NotificationURL string `mapstructure:"NOTIFICATION_URL"`
|
|
}
|
|
|
|
func NewAlertManager(app *pocketbase.PocketBase) *AlertManager {
|
|
config, configErr := loadConfig("beszel_data")
|
|
if configErr != nil {
|
|
app.Logger().Error("Error loading config from beszel_data: ", "err", configErr.Error())
|
|
}
|
|
|
|
return &AlertManager{
|
|
app: app,
|
|
config: config,
|
|
}
|
|
}
|
|
|
|
func loadConfig(path string) (AlertConfig, error) {
|
|
viper.AddConfigPath(path)
|
|
viper.SetConfigName("alerts")
|
|
viper.SetConfigType("env")
|
|
|
|
viper.AutomaticEnv()
|
|
|
|
config := AlertConfig{}
|
|
err := viper.ReadInConfig()
|
|
if err != nil {
|
|
if _, ok := err.(viper.ConfigFileNotFoundError); !ok {
|
|
return config, err
|
|
}
|
|
}
|
|
|
|
err = viper.Unmarshal(&config)
|
|
return config, err
|
|
}
|
|
|
|
func (am *AlertManager) HandleSystemAlerts(newStatus string, newRecord *models.Record, oldRecord *models.Record) {
|
|
alertRecords, err := am.app.Dao().FindRecordsByExpr("alerts",
|
|
dbx.NewExp("system = {:system}", dbx.Params{"system": oldRecord.GetId()}),
|
|
)
|
|
if err != nil || len(alertRecords) == 0 {
|
|
// log.Println("no alerts found for system")
|
|
return
|
|
}
|
|
// log.Println("found alerts", len(alertRecords))
|
|
var systemInfo *system.Info
|
|
for _, alertRecord := range alertRecords {
|
|
name := alertRecord.GetString("name")
|
|
switch name {
|
|
case "Status":
|
|
am.handleStatusAlerts(newStatus, oldRecord, alertRecord)
|
|
case "CPU", "Memory", "Disk":
|
|
if newStatus != "up" {
|
|
continue
|
|
}
|
|
if systemInfo == nil {
|
|
systemInfo = getSystemInfo(newRecord)
|
|
}
|
|
if name == "CPU" {
|
|
am.handleSlidingValueAlert(newRecord, alertRecord, name, systemInfo.Cpu)
|
|
} else if name == "Memory" {
|
|
am.handleSlidingValueAlert(newRecord, alertRecord, name, systemInfo.MemPct)
|
|
} else if name == "Disk" {
|
|
am.handleSlidingValueAlert(newRecord, alertRecord, name, systemInfo.DiskPct)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func getSystemInfo(record *models.Record) *system.Info {
|
|
var SystemInfo system.Info
|
|
record.UnmarshalJSONField("info", &SystemInfo)
|
|
return &SystemInfo
|
|
}
|
|
|
|
func (am *AlertManager) handleSlidingValueAlert(newRecord *models.Record, alertRecord *models.Record, name string, curValue float64) {
|
|
triggered := alertRecord.GetBool("triggered")
|
|
threshold := alertRecord.GetFloat("value")
|
|
// fmt.Println(name, curValue, "threshold", threshold, "triggered", triggered)
|
|
var subject string
|
|
var body string
|
|
if !triggered && curValue > threshold {
|
|
alertRecord.Set("triggered", true)
|
|
systemName := newRecord.GetString("name")
|
|
subject = fmt.Sprintf("%s usage above threshold on %s", name, systemName)
|
|
body = fmt.Sprintf("%s usage on %s is %.1f%%.\n\n%s\n\n- Beszel", name, systemName, curValue, am.app.Settings().Meta.AppUrl+"/system/"+systemName)
|
|
} else if triggered && curValue <= threshold {
|
|
alertRecord.Set("triggered", false)
|
|
systemName := newRecord.GetString("name")
|
|
subject = fmt.Sprintf("%s usage below threshold on %s", name, systemName)
|
|
body = fmt.Sprintf("%s usage on %s is below threshold at %.1f%%.\n\n%s\n\n- Beszel", name, systemName, curValue, am.app.Settings().Meta.AppUrl+"/system/"+systemName)
|
|
} else {
|
|
// fmt.Println(name, "not triggered")
|
|
return
|
|
}
|
|
if err := am.app.Dao().SaveRecord(alertRecord); err != nil {
|
|
// app.Logger().Error("failed to save alert record", "err", err.Error())
|
|
return
|
|
}
|
|
// expand the user relation and send the alert
|
|
if errs := am.app.Dao().ExpandRecord(alertRecord, []string{"user"}, nil); len(errs) > 0 {
|
|
// app.Logger().Error("failed to expand user relation", "errs", errs)
|
|
return
|
|
}
|
|
if user := alertRecord.ExpandedOne("user"); user != nil {
|
|
am.sendAlert(&mailer.Message{
|
|
To: []mail.Address{{Address: user.GetString("email")}},
|
|
Subject: subject,
|
|
Text: body,
|
|
})
|
|
}
|
|
}
|
|
|
|
func (am *AlertManager) handleStatusAlerts(newStatus string, oldRecord *models.Record, alertRecord *models.Record) error {
|
|
var alertStatus string
|
|
switch newStatus {
|
|
case "up":
|
|
if oldRecord.GetString("status") == "down" {
|
|
alertStatus = "up"
|
|
}
|
|
case "down":
|
|
if oldRecord.GetString("status") == "up" {
|
|
alertStatus = "down"
|
|
}
|
|
}
|
|
if alertStatus == "" {
|
|
return nil
|
|
}
|
|
// expand the user relation
|
|
if errs := am.app.Dao().ExpandRecord(alertRecord, []string{"user"}, nil); len(errs) > 0 {
|
|
return fmt.Errorf("failed to expand: %v", errs)
|
|
}
|
|
user := alertRecord.ExpandedOne("user")
|
|
if user == nil {
|
|
return nil
|
|
}
|
|
emoji := "\U0001F534"
|
|
if alertStatus == "up" {
|
|
emoji = "\u2705"
|
|
}
|
|
// send alert
|
|
systemName := oldRecord.GetString("name")
|
|
am.sendAlert(&mailer.Message{
|
|
To: []mail.Address{{Address: user.GetString("email")}},
|
|
Subject: fmt.Sprintf("Connection to %s is %s %v", systemName, alertStatus, emoji),
|
|
Text: fmt.Sprintf("Connection to %s is %s\n\n- Beszel", systemName, alertStatus),
|
|
})
|
|
|
|
return nil
|
|
}
|
|
|
|
func (am *AlertManager) sendAlert(message *mailer.Message) {
|
|
// fmt.Println("sending alert", "to", message.To, "subj", message.Subject, "body", message.Text)
|
|
|
|
if am.config.NotificationType == "shoutrrr" {
|
|
err := shoutrrr.Send(am.config.NotificationURL, fmt.Sprintf("%s\n\n%s", message.Subject, message.Text))
|
|
if err == nil {
|
|
am.app.Logger().Info("Sent shoutrrr alert", "to", am.config.NotificationURL, "subj", message.Subject)
|
|
return
|
|
}
|
|
|
|
am.app.Logger().Error("Failed to send alert via shoutrrr, falling back to email notification. ", "err", err.Error())
|
|
}
|
|
|
|
message.From = mail.Address{
|
|
Address: am.app.Settings().Meta.SenderAddress,
|
|
Name: am.app.Settings().Meta.SenderName,
|
|
}
|
|
if err := am.app.NewMailClient().Send(message); err != nil {
|
|
am.app.Logger().Error("Failed to send alert: ", "err", err.Error())
|
|
} else {
|
|
am.app.Logger().Info("Sent email alert", "to", message.To, "subj", message.Subject)
|
|
}
|
|
}
|