2020-09-19 22:29:08 +02:00
package slack
2020-09-19 22:22:12 +02:00
import (
2021-12-03 03:05:17 +01:00
"bytes"
2020-09-19 22:22:12 +02:00
"fmt"
2021-12-03 07:44:17 +01:00
"io"
2020-11-23 22:20:06 +01:00
"net/http"
2020-11-18 01:34:35 +01:00
2021-10-08 03:28:04 +02:00
"github.com/TwiN/gatus/v3/alerting/alert"
2021-12-03 03:05:17 +01:00
"github.com/TwiN/gatus/v3/client"
2021-10-08 03:28:04 +02:00
"github.com/TwiN/gatus/v3/core"
2020-09-19 22:22:12 +02:00
)
2020-09-26 21:15:50 +02:00
// AlertProvider is the configuration necessary for sending an alert using Slack
2020-09-19 22:29:08 +02:00
type AlertProvider struct {
2021-04-24 22:59:33 +02:00
WebhookURL string ` yaml:"webhook-url" ` // Slack webhook URL
2021-05-16 03:31:32 +02:00
2021-10-23 22:47:12 +02:00
// DefaultAlert is the default alert configuration to use for endpoints with an alert of the appropriate type
2021-05-19 04:29:15 +02:00
DefaultAlert * alert . Alert ` yaml:"default-alert" `
2020-09-19 22:22:12 +02:00
}
2020-09-26 21:15:50 +02:00
// IsValid returns whether the provider's configuration is valid
2020-09-19 22:29:08 +02:00
func ( provider * AlertProvider ) IsValid ( ) bool {
2020-10-23 22:29:20 +02:00
return len ( provider . WebhookURL ) > 0
2020-09-19 22:22:12 +02:00
}
2021-12-03 03:05:17 +01:00
// Send an alert using the provider
func ( provider * AlertProvider ) Send ( endpoint * core . Endpoint , alert * alert . Alert , result * core . Result , resolved bool ) error {
buffer := bytes . NewBuffer ( [ ] byte ( provider . buildRequestBody ( endpoint , alert , result , resolved ) ) )
request , err := http . NewRequest ( http . MethodPost , provider . WebhookURL , buffer )
if err != nil {
return err
}
request . Header . Set ( "Content-Type" , "application/json" )
response , err := client . GetHTTPClient ( nil ) . Do ( request )
if err != nil {
return err
}
if response . StatusCode > 399 {
2021-12-03 07:44:17 +01:00
body , _ := io . ReadAll ( response . Body )
2021-12-03 03:05:17 +01:00
return fmt . Errorf ( "call to provider alert returned status code %d: %s" , response . StatusCode , string ( body ) )
}
return err
}
// buildRequestBody builds the request body for the provider
func ( provider * AlertProvider ) buildRequestBody ( endpoint * core . Endpoint , alert * alert . Alert , result * core . Result , resolved bool ) string {
2020-11-18 01:34:35 +01:00
var message , color , results string
2020-09-19 22:22:12 +02:00
if resolved {
2021-12-12 22:33:16 +01:00
message = fmt . Sprintf ( "An alert for *%s* has been resolved after passing successfully %d time(s) in a row" , endpoint . DisplayName ( ) , alert . SuccessThreshold )
2020-09-19 22:22:12 +02:00
color = "#36A64F"
} else {
2021-12-12 22:33:16 +01:00
message = fmt . Sprintf ( "An alert for *%s* has been triggered due to having failed %d time(s) in a row" , endpoint . DisplayName ( ) , alert . FailureThreshold )
2020-09-19 22:22:12 +02:00
color = "#DD0000"
}
for _ , conditionResult := range result . ConditionResults {
var prefix string
if conditionResult . Success {
2021-01-20 23:47:21 +01:00
prefix = ":white_check_mark:"
2020-09-19 22:22:12 +02:00
} else {
prefix = ":x:"
}
2021-02-20 01:06:20 +01:00
results += fmt . Sprintf ( "%s - `%s`\\n" , prefix , conditionResult . Condition )
2020-09-19 22:22:12 +02:00
}
2021-07-30 01:54:40 +02:00
var description string
if alertDescription := alert . GetDescription ( ) ; len ( alertDescription ) > 0 {
description = ":\\n> " + alertDescription
}
2021-12-03 03:05:17 +01:00
return fmt . Sprintf ( ` {
2020-09-19 22:22:12 +02:00
"text" : "" ,
"attachments" : [
{
"title" : ":helmet_with_white_cross: Gatus" ,
2021-07-30 01:54:40 +02:00
"text" : "%s%s" ,
2020-09-19 22:22:12 +02:00
"short" : false ,
"color" : "%s" ,
"fields" : [
{
"title" : "Condition results" ,
"value" : "%s" ,
"short" : false
}
]
2020-11-14 22:17:19 +01:00
}
2020-09-19 22:22:12 +02:00
]
2021-12-03 03:05:17 +01:00
} ` , message , description , color , results )
2020-09-19 22:22:12 +02:00
}
2021-05-16 03:31:32 +02:00
// GetDefaultAlert returns the provider's default alert configuration
2021-05-19 04:29:15 +02:00
func ( provider AlertProvider ) GetDefaultAlert ( ) * alert . Alert {
2021-05-16 03:31:32 +02:00
return provider . DefaultAlert
}