package sendgrid import ( "bytes" "encoding/json" "errors" "fmt" "io" "net/http" "strings" "github.com/TwiN/gatus/v5/alerting/alert" "github.com/TwiN/gatus/v5/client" "github.com/TwiN/gatus/v5/config/endpoint" "gopkg.in/yaml.v3" ) const ( ApiURL = "https://api.sendgrid.com/v3/mail/send" ) var ( ErrAPIKeyNotSet = errors.New("api-key not set") ErrFromNotSet = errors.New("from not set") ErrToNotSet = errors.New("to not set") ErrDuplicateGroupOverride = errors.New("duplicate group override") ) type Config struct { APIKey string `yaml:"api-key"` From string `yaml:"from"` To string `yaml:"to"` // ClientConfig is the configuration of the client used to communicate with the provider's target ClientConfig *client.Config `yaml:"client,omitempty"` } func (cfg *Config) Validate() error { if len(cfg.APIKey) == 0 { return ErrAPIKeyNotSet } if len(cfg.From) == 0 { return ErrFromNotSet } if len(cfg.To) == 0 { return ErrToNotSet } return nil } func (cfg *Config) Merge(override *Config) { if override.ClientConfig != nil { cfg.ClientConfig = override.ClientConfig } if len(override.APIKey) > 0 { cfg.APIKey = override.APIKey } if len(override.From) > 0 { cfg.From = override.From } if len(override.To) > 0 { cfg.To = override.To } } // AlertProvider is the configuration necessary for sending an alert using SendGrid type AlertProvider struct { DefaultConfig Config `yaml:",inline"` // DefaultAlert is the default alert configuration to use for endpoints with an alert of the appropriate type DefaultAlert *alert.Alert `yaml:"default-alert,omitempty"` // Overrides is a list of Override that may be prioritized over the default configuration Overrides []Override `yaml:"overrides,omitempty"` } // Override is a case under which the default integration is overridden type Override struct { Group string `yaml:"group"` Config `yaml:",inline"` } // Validate the provider's configuration func (provider *AlertProvider) Validate() error { registeredGroups := make(map[string]bool) if provider.Overrides != nil { for _, override := range provider.Overrides { if isAlreadyRegistered := registeredGroups[override.Group]; isAlreadyRegistered || override.Group == "" { return ErrDuplicateGroupOverride } registeredGroups[override.Group] = true } } return provider.DefaultConfig.Validate() } // Send an alert using the provider func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error { cfg, err := provider.GetConfig(ep.Group, alert) if err != nil { return err } subject, body := provider.buildMessageSubjectAndBody(ep, alert, result, resolved) payload := provider.buildSendGridPayload(cfg, subject, body) payloadBytes, err := json.Marshal(payload) if err != nil { return err } request, err := http.NewRequest(http.MethodPost, ApiURL, bytes.NewBuffer(payloadBytes)) if err != nil { return err } request.Header.Set("Content-Type", "application/json") request.Header.Set("Authorization", "Bearer "+cfg.APIKey) response, err := client.GetHTTPClient(cfg.ClientConfig).Do(request) if err != nil { return err } defer response.Body.Close() if response.StatusCode >= 400 { body, _ := io.ReadAll(response.Body) return fmt.Errorf("call to sendgrid alert returned status code %d: %s", response.StatusCode, string(body)) } return nil } type SendGridPayload struct { Personalizations []Personalization `json:"personalizations"` From Email `json:"from"` Subject string `json:"subject"` Content []Content `json:"content"` } type Personalization struct { To []Email `json:"to"` } type Email struct { Email string `json:"email"` } type Content struct { Type string `json:"type"` Value string `json:"value"` } // buildSendGridPayload builds the SendGrid API payload func (provider *AlertProvider) buildSendGridPayload(cfg *Config, subject, body string) SendGridPayload { toEmails := strings.Split(cfg.To, ",") var recipients []Email for _, email := range toEmails { recipients = append(recipients, Email{Email: strings.TrimSpace(email)}) } return SendGridPayload{ Personalizations: []Personalization{ { To: recipients, }, }, From: Email{ Email: cfg.From, }, Subject: subject, Content: []Content{ { Type: "text/plain", Value: body, }, { Type: "text/html", Value: strings.ReplaceAll(body, "\n", "
"), }, }, } } // buildMessageSubjectAndBody builds the message subject and body func (provider *AlertProvider) buildMessageSubjectAndBody(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) (string, string) { var subject, message string if resolved { subject = fmt.Sprintf("[%s] Alert resolved", ep.DisplayName()) message = fmt.Sprintf("An alert for %s has been resolved after passing successfully %d time(s) in a row", ep.DisplayName(), alert.SuccessThreshold) } else { subject = fmt.Sprintf("[%s] Alert triggered", ep.DisplayName()) message = fmt.Sprintf("An alert for %s has been triggered due to having failed %d time(s) in a row", ep.DisplayName(), alert.FailureThreshold) } var formattedConditionResults string if len(result.ConditionResults) > 0 { formattedConditionResults = "\n\nCondition results:\n" for _, conditionResult := range result.ConditionResults { var prefix string if conditionResult.Success { prefix = "✅" } else { prefix = "❌" } formattedConditionResults += fmt.Sprintf("%s %s\n", prefix, conditionResult.Condition) } } var description string if alertDescription := alert.GetDescription(); len(alertDescription) > 0 { description = "\n\nAlert description: " + alertDescription } var extraLabels string if len(ep.ExtraLabels) > 0 { extraLabels = "\n\nExtra labels:\n" for key, value := range ep.ExtraLabels { extraLabels += fmt.Sprintf(" %s: %s\n", key, value) } } return subject, message + description + extraLabels + formattedConditionResults } // GetDefaultAlert returns the provider's default alert configuration func (provider *AlertProvider) GetDefaultAlert() *alert.Alert { return provider.DefaultAlert } // GetConfig returns the configuration for the provider with the overrides applied func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Config, error) { cfg := provider.DefaultConfig // Handle group overrides if provider.Overrides != nil { for _, override := range provider.Overrides { if group == override.Group { cfg.Merge(&override.Config) break } } } // Handle alert overrides if len(alert.ProviderOverride) != 0 { overrideConfig := Config{} if err := yaml.Unmarshal(alert.ProviderOverrideAsBytes(), &overrideConfig); err != nil { return nil, err } cfg.Merge(&overrideConfig) } // Validate the configuration err := cfg.Validate() return &cfg, err } // ValidateOverrides validates the alert's provider override and, if present, the group override func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error { _, err := provider.GetConfig(group, alert) return err }