package googlechat import ( "bytes" "encoding/json" "errors" "fmt" "io" "net/http" "github.com/TwiN/gatus/v5/alerting/alert" "github.com/TwiN/gatus/v5/client" "github.com/TwiN/gatus/v5/config/endpoint" "gopkg.in/yaml.v3" ) var ( ErrWebhookURLNotSet = errors.New("webhook-url not set") ErrDuplicateGroupOverride = errors.New("duplicate group override") ) type Config struct { WebhookURL string `yaml:"webhook-url"` ClientConfig *client.Config `yaml:"client,omitempty"` } func (cfg *Config) Validate() error { if len(cfg.WebhookURL) == 0 { return ErrWebhookURLNotSet } return nil } func (cfg *Config) Merge(override *Config) { if override.ClientConfig != nil { cfg.ClientConfig = override.ClientConfig } if len(override.WebhookURL) > 0 { cfg.WebhookURL = override.WebhookURL } } // AlertProvider is the configuration necessary for sending an alert using Google chat 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 == "" || len(override.WebhookURL) == 0 { 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 } buffer := bytes.NewBuffer(provider.buildRequestBody(ep, alert, result, resolved)) request, err := http.NewRequest(http.MethodPost, cfg.WebhookURL, buffer) if err != nil { return err } request.Header.Set("Content-Type", "application/json") response, err := client.GetHTTPClient(cfg.ClientConfig).Do(request) if err != nil { return err } defer response.Body.Close() if response.StatusCode > 399 { body, _ := io.ReadAll(response.Body) return fmt.Errorf("call to provider alert returned status code %d: %s", response.StatusCode, string(body)) } return err } type Body struct { Cards []Cards `json:"cards"` } type Cards struct { Sections []Sections `json:"sections"` } type Sections struct { Widgets []Widgets `json:"widgets"` } type Widgets struct { KeyValue *KeyValue `json:"keyValue,omitempty"` Buttons []Buttons `json:"buttons,omitempty"` } type KeyValue struct { TopLabel string `json:"topLabel,omitempty"` Content string `json:"content,omitempty"` ContentMultiline string `json:"contentMultiline,omitempty"` BottomLabel string `json:"bottomLabel,omitempty"` Icon string `json:"icon,omitempty"` } type Buttons struct { TextButton TextButton `json:"textButton"` } type TextButton struct { Text string `json:"text"` OnClick OnClick `json:"onClick"` } type OnClick struct { OpenLink OpenLink `json:"openLink"` } type OpenLink struct { URL string `json:"url"` } // buildRequestBody builds the request body for the provider func (provider *AlertProvider) buildRequestBody(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) []byte { var message, color string if resolved { color = "#36A64F" message = fmt.Sprintf("An alert has been resolved after passing successfully %d time(s) in a row", color, alert.SuccessThreshold) } else { color = "#DD0000" message = fmt.Sprintf("An alert has been triggered due to having failed %d time(s) in a row", color, alert.FailureThreshold) } var formattedConditionResults string for _, conditionResult := range result.ConditionResults { var prefix string if conditionResult.Success { prefix = "✅" } else { prefix = "❌" } formattedConditionResults += fmt.Sprintf("%s %s
", prefix, conditionResult.Condition) } var description string if alertDescription := alert.GetDescription(); len(alertDescription) > 0 { description = ":: " + alertDescription } payload := Body{ Cards: []Cards{ { Sections: []Sections{ { Widgets: []Widgets{ { KeyValue: &KeyValue{ TopLabel: ep.DisplayName(), Content: message, ContentMultiline: "true", BottomLabel: description, Icon: "BOOKMARK", }, }, }, }, }, }, }, } if len(formattedConditionResults) > 0 { payload.Cards[0].Sections[0].Widgets = append(payload.Cards[0].Sections[0].Widgets, Widgets{ KeyValue: &KeyValue{ TopLabel: "Condition results", Content: formattedConditionResults, ContentMultiline: "true", Icon: "DESCRIPTION", }, }) } if ep.Type() == endpoint.TypeHTTP { // We only include a button targeting the URL if the endpoint is an HTTP endpoint // If the URL isn't prefixed with https://, Google Chat will just display a blank message aynways. // See https://github.com/TwiN/gatus/issues/362 payload.Cards[0].Sections[0].Widgets = append(payload.Cards[0].Sections[0].Widgets, Widgets{ Buttons: []Buttons{ { TextButton: TextButton{ Text: "URL", OnClick: OnClick{OpenLink: OpenLink{URL: ep.URL}}, }, }, }, }) } bodyAsJSON, _ := json.Marshal(payload) return bodyAsJSON } // 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 }