2022-07-15 21:43:48 -07:00
package matrix
import (
"bytes"
2022-10-20 15:48:51 -04:00
"encoding/json"
2024-12-16 20:32:13 -05:00
"errors"
2022-07-15 21:43:48 -07:00
"fmt"
"io"
"math/rand"
"net/http"
"net/url"
2022-12-06 01:41:09 -05:00
"github.com/TwiN/gatus/v5/alerting/alert"
"github.com/TwiN/gatus/v5/client"
2024-05-09 22:56:16 -04:00
"github.com/TwiN/gatus/v5/config/endpoint"
2024-12-16 20:32:13 -05:00
"gopkg.in/yaml.v3"
2022-07-15 21:43:48 -07:00
)
2024-12-16 20:32:13 -05:00
const defaultServerURL = "https://matrix-client.matrix.org"
var (
ErrAccessTokenNotSet = errors . New ( "access-token not set" )
ErrInternalRoomID = errors . New ( "internal-room-id not set" )
ErrDuplicateGroupOverride = errors . New ( "duplicate group override" )
)
type Config struct {
// ServerURL is the custom homeserver to use (optional)
ServerURL string `yaml:"server-url"`
// AccessToken is the bot user's access token to send messages
AccessToken string `yaml:"access-token"`
// InternalRoomID is the room that the bot user has permissions to send messages to
InternalRoomID string `yaml:"internal-room-id"`
}
func ( cfg * Config ) Validate () error {
if len ( cfg . ServerURL ) == 0 {
cfg . ServerURL = defaultServerURL
}
if len ( cfg . AccessToken ) == 0 {
return ErrAccessTokenNotSet
}
if len ( cfg . InternalRoomID ) == 0 {
return ErrInternalRoomID
}
return nil
}
func ( cfg * Config ) Merge ( override * Config ) {
if len ( override . ServerURL ) > 0 {
cfg . ServerURL = override . ServerURL
}
if len ( override . AccessToken ) > 0 {
cfg . AccessToken = override . AccessToken
}
if len ( override . InternalRoomID ) > 0 {
cfg . InternalRoomID = override . InternalRoomID
}
}
2022-07-15 21:43:48 -07:00
// AlertProvider is the configuration necessary for sending an alert using Matrix
type AlertProvider struct {
2024-12-16 20:32:13 -05:00
DefaultConfig Config `yaml:",inline"`
2022-07-15 21:43:48 -07:00
// 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 {
2024-12-16 20:32:13 -05:00
Group string `yaml:"group"`
Config `yaml:",inline"`
2022-07-15 21:43:48 -07:00
}
2024-12-16 20:32:13 -05:00
// Validate the provider's configuration
func ( provider * AlertProvider ) Validate () error {
2022-07-15 21:43:48 -07:00
registeredGroups := make ( map [ string ] bool )
if provider . Overrides != nil {
for _ , override := range provider . Overrides {
if isAlreadyRegistered := registeredGroups [ override . Group ]; isAlreadyRegistered || override . Group == "" || len ( override . AccessToken ) == 0 || len ( override . InternalRoomID ) == 0 {
2024-12-16 20:32:13 -05:00
return ErrDuplicateGroupOverride
2022-07-15 21:43:48 -07:00
}
registeredGroups [ override . Group ] = true
}
}
2024-12-16 20:32:13 -05:00
return provider . DefaultConfig . Validate ()
2022-07-15 21:43:48 -07:00
}
// Send an alert using the provider
2024-05-09 22:56:16 -04:00
func ( provider * AlertProvider ) Send ( ep * endpoint . Endpoint , alert * alert . Alert , result * endpoint . Result , resolved bool ) error {
2024-12-16 20:32:13 -05:00
cfg , err := provider . GetConfig ( ep . Group , alert )
if err != nil {
return err
2022-07-15 21:43:48 -07:00
}
2024-12-16 20:32:13 -05:00
buffer := bytes . NewBuffer ( provider . buildRequestBody ( ep , alert , result , resolved ))
2022-07-19 10:42:28 -07:00
// The Matrix endpoint requires a unique transaction ID for each event sent
2022-07-15 21:43:48 -07:00
txnId := randStringBytes ( 24 )
request , err := http . NewRequest (
http . MethodPut ,
2022-07-19 10:40:07 -07:00
fmt . Sprintf ( "%s/_matrix/client/v3/rooms/%s/send/m.room.message/%s?access_token=%s" ,
2024-12-16 20:32:13 -05:00
cfg . ServerURL ,
url . PathEscape ( cfg . InternalRoomID ),
2022-07-15 21:43:48 -07:00
txnId ,
2024-12-16 20:32:13 -05:00
url . QueryEscape ( cfg . AccessToken ),
2022-07-15 21:43:48 -07:00
),
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
}
2022-10-20 15:16:27 -04:00
defer response . Body . Close ()
2022-07-15 21:43:48 -07:00
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
}
2022-10-20 15:48:51 -04:00
type Body struct {
MsgType string `json:"msgtype"`
Format string `json:"format"`
Body string `json:"body"`
FormattedBody string `json:"formatted_body"`
}
2022-07-15 21:43:48 -07:00
// buildRequestBody builds the request body for the provider
2024-05-09 22:56:16 -04:00
func ( provider * AlertProvider ) buildRequestBody ( ep * endpoint . Endpoint , alert * alert . Alert , result * endpoint . Result , resolved bool ) [] byte {
2022-10-20 15:48:51 -04:00
body , _ := json . Marshal ( Body {
MsgType : "m.text" ,
Format : "org.matrix.custom.html" ,
2024-05-09 22:56:16 -04:00
Body : buildPlaintextMessageBody ( ep , alert , result , resolved ),
FormattedBody : buildHTMLMessageBody ( ep , alert , result , resolved ),
2022-10-20 15:48:51 -04:00
})
return body
2022-07-15 21:43:48 -07:00
}
// buildPlaintextMessageBody builds the message body in plaintext to include in request
2024-05-09 22:56:16 -04:00
func buildPlaintextMessageBody ( ep * endpoint . Endpoint , alert * alert . Alert , result * endpoint . Result , resolved bool ) string {
2024-04-10 20:46:17 -04:00
var message string
2022-07-15 21:43:48 -07:00
if resolved {
2024-05-09 22:56:16 -04:00
message = fmt . Sprintf ( "An alert for `%s` has been resolved after passing successfully %d time(s) in a row" , ep . DisplayName (), alert . SuccessThreshold )
2022-07-15 21:43:48 -07:00
} else {
2024-05-09 22:56:16 -04:00
message = fmt . Sprintf ( "An alert for `%s` has been triggered due to having failed %d time(s) in a row" , ep . DisplayName (), alert . FailureThreshold )
2022-07-15 21:43:48 -07:00
}
2024-04-10 20:46:17 -04:00
var formattedConditionResults string
2022-07-15 21:43:48 -07:00
for _ , conditionResult := range result . ConditionResults {
var prefix string
if conditionResult . Success {
prefix = "✓"
} else {
prefix = "✕"
}
2024-04-10 20:46:17 -04:00
formattedConditionResults += fmt . Sprintf ( "\n%s - %s" , prefix , conditionResult . Condition )
2022-07-15 21:43:48 -07:00
}
var description string
if alertDescription := alert . GetDescription (); len ( alertDescription ) > 0 {
2022-10-20 15:48:51 -04:00
description = "\n" + alertDescription
2022-07-15 21:43:48 -07:00
}
2024-04-10 20:46:17 -04:00
return fmt . Sprintf ( "%s%s\n%s" , message , description , formattedConditionResults )
2022-07-15 21:43:48 -07:00
}
// buildHTMLMessageBody builds the message body in HTML to include in request
2024-05-09 22:56:16 -04:00
func buildHTMLMessageBody ( ep * endpoint . Endpoint , alert * alert . Alert , result * endpoint . Result , resolved bool ) string {
2024-04-10 20:46:17 -04:00
var message string
2022-07-15 21:43:48 -07:00
if resolved {
2024-05-09 22:56:16 -04:00
message = fmt . Sprintf ( "An alert for <code>%s</code> has been resolved after passing successfully %d time(s) in a row" , ep . DisplayName (), alert . SuccessThreshold )
2022-07-15 21:43:48 -07:00
} else {
2024-05-09 22:56:16 -04:00
message = fmt . Sprintf ( "An alert for <code>%s</code> has been triggered due to having failed %d time(s) in a row" , ep . DisplayName (), alert . FailureThreshold )
2022-07-15 21:43:48 -07:00
}
2024-04-10 20:46:17 -04:00
var formattedConditionResults string
if len ( result . ConditionResults ) > 0 {
formattedConditionResults = "\n<h5>Condition results</h5><ul>"
for _ , conditionResult := range result . ConditionResults {
var prefix string
if conditionResult . Success {
prefix = "✅"
} else {
prefix = "❌"
}
formattedConditionResults += fmt . Sprintf ( "<li>%s - <code>%s</code></li>" , prefix , conditionResult . Condition )
2022-07-15 21:43:48 -07:00
}
2024-04-10 20:46:17 -04:00
formattedConditionResults += "</ul>"
2022-07-15 21:43:48 -07:00
}
var description string
if alertDescription := alert . GetDescription (); len ( alertDescription ) > 0 {
2022-10-20 15:48:51 -04:00
description = fmt . Sprintf ( "\n<blockquote>%s</blockquote>" , alertDescription )
2022-07-15 21:43:48 -07:00
}
2024-04-10 20:46:17 -04:00
return fmt . Sprintf ( "<h3>%s</h3>%s%s" , message , description , formattedConditionResults )
2022-07-15 21:43:48 -07:00
}
func randStringBytes ( n int ) string {
2022-07-19 10:42:28 -07:00
// All the compatible characters to use in a transaction ID
const availableCharacterBytes = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
2022-07-15 21:43:48 -07:00
b := make ([] byte , n )
for i := range b {
2022-07-19 10:42:28 -07:00
b [ i ] = availableCharacterBytes [ rand . Intn ( len ( availableCharacterBytes ))]
2022-07-15 21:43:48 -07:00
}
return string ( b )
}
// GetDefaultAlert returns the provider's default alert configuration
2024-02-07 20:09:45 -05:00
func ( provider * AlertProvider ) GetDefaultAlert () * alert . Alert {
2022-07-15 21:43:48 -07:00
return provider . DefaultAlert
}
2024-12-16 20:32:13 -05:00
// 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
}