Merge branch 'master' into add_conditions_to_custom_alerting

Author: TwiN

README.md

@@ -71,6 +71,7 @@ Have any feedback or questions? [Create a discussion](https://github.com/TwiN/ga
     - [Configuring Matrix alerts](#configuring-matrix-alerts)
     - [Configuring Mattermost alerts](#configuring-mattermost-alerts)
     - [Configuring Messagebird alerts](#configuring-messagebird-alerts)
+    - [Configuring n8n alerts](#configuring-n8n-alerts)
     - [Configuring New Relic alerts](#configuring-new-relic-alerts)
     - [Configuring Ntfy alerts](#configuring-ntfy-alerts)
     - [Configuring Opsgenie alerts](#configuring-opsgenie-alerts)
@@ -745,6 +746,9 @@ endpoints:
       - "[STATUS] == 200"
 ```
 
+> ⚠️ **WARNING**:: Tunneling may introduce additional latency, especially if the connection to the tunnel is retried frequently. 
+> This may lead to inaccurate response time measurements.
+
 
 ### Alerting
 Gatus supports multiple alerting providers, such as Slack and PagerDuty, and supports different alerts for each
@@ -814,6 +818,7 @@ endpoints:
 | `alerting.matrix`          | Configuration for alerts of type `matrix`. <br />See [Configuring Matrix alerts](#configuring-matrix-alerts).                           | `{}`    |
 | `alerting.mattermost`      | Configuration for alerts of type `mattermost`. <br />See [Configuring Mattermost alerts](#configuring-mattermost-alerts).               | `{}`    |
 | `alerting.messagebird`     | Configuration for alerts of type `messagebird`. <br />See [Configuring Messagebird alerts](#configuring-messagebird-alerts).            | `{}`    |
+| `alerting.n8n`             | Configuration for alerts of type `n8n`. <br />See [Configuring n8n alerts](#configuring-n8n-alerts).                                    | `{}`    |
 | `alerting.newrelic`        | Configuration for alerts of type `newrelic`. <br />See [Configuring New Relic alerts](#configuring-new-relic-alerts).                   | `{}`    |
 | `alerting.ntfy`            | Configuration for alerts of type `ntfy`. <br />See [Configuring Ntfy alerts](#configuring-ntfy-alerts).                                 | `{}`    |
 | `alerting.opsgenie`        | Configuration for alerts of type `opsgenie`. <br />See [Configuring Opsgenie alerts](#configuring-opsgenie-alerts).                     | `{}`    |
@@ -1576,8 +1581,8 @@ alerting:
     region: "US"  # or "EU" for European region
 
 endpoints:
-  - name: website
-    url: "https://twin.sh/health"
+  - name: example
+    url: "https://example.org"
     interval: 5m
     conditions:
       - "[STATUS] == 200"
@@ -1587,6 +1592,50 @@ endpoints:
 ```
 
 
+#### Configuring n8n alerts
+| Parameter                        | Description                                                                                | Default       |
+|:---------------------------------|:-------------------------------------------------------------------------------------------|:--------------|
+| `alerting.n8n`                   | Configuration for alerts of type `n8n`                                                     | `{}`          |
+| `alerting.n8n.webhook-url`       | n8n webhook URL                                                                            | Required `""` |
+| `alerting.n8n.title`             | Title of the alert sent to n8n                                                             | `""`          |
+| `alerting.n8n.default-alert`     | Default alert configuration. <br />See [Setting a default alert](#setting-a-default-alert) | N/A           |
+| `alerting.n8n.overrides`         | List of overrides that may be prioritized over the default configuration                   | `[]`          |
+| `alerting.n8n.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration        | `""`          |
+| `alerting.n8n.overrides[].*`     | See `alerting.n8n.*` parameters                                                            | `{}`          |
+
+[n8n](https://n8n.io/) is a workflow automation platform that allows you to automate tasks across different applications and services using webhooks.
+
+Example:
+```yaml
+alerting:
+  n8n:
+    webhook-url: "https://your-n8n-instance.com/webhook/your-webhook-id"
+    title: "Gatus Monitoring"
+    default-alert:
+      send-on-resolved: true
+
+endpoints:
+  - name: example
+    url: "https://example.org"
+    interval: 5m
+    conditions:
+      - "[STATUS] == 200"
+    alerts:
+      - type: n8n
+        description: "Health check alert"
+```
+
+The JSON payload sent to the n8n webhook will include:
+- `title`: The configured title
+- `endpoint_name`: Name of the endpoint
+- `endpoint_group`: Group of the endpoint (if any)
+- `endpoint_url`: URL being monitored
+- `alert_description`: Custom alert description
+- `resolved`: Boolean indicating if the alert is resolved
+- `message`: Human-readable alert message
+- `condition_results`: Array of condition results with their success status
+
+
 #### Configuring Ntfy alerts
 | Parameter                            | Description                                                                                                                                  | Default           |
 |:-------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------|:------------------|
@@ -2983,12 +3032,13 @@ endpoints:
       password: "password"
     body: |
       {
-        "command": "uptime"
+        "command": "echo '{\"memory\": {\"used\": 512}}'"
       }
     interval: 1m
     conditions:
       - "[CONNECTED] == true"
       - "[STATUS] == 0"
+      - "[BODY].memory.used > 500"
 ```
 
 you can also use no authentication to monitor the endpoint by not specifying the username
@@ -3011,6 +3061,7 @@ endpoints:
 The following placeholders are supported for endpoints of type SSH:
 - `[CONNECTED]` resolves to `true` if the SSH connection was successful, `false` otherwise
 - `[STATUS]` resolves the exit code of the command executed on the remote server (e.g. `0` for success)
+- `[BODY]` resolves to the stdout output of the command executed on the remote server
 - `[IP]` resolves to the IP address of the server
 - `[RESPONSE_TIME]` resolves to the time it took to establish the connection and execute the command
 

alerting/alert/type.go

@@ -65,6 +65,9 @@ const (
 	// TypeNewRelic is the Type for the newrelic alerting provider
 	TypeNewRelic Type = "newrelic"
 
+	// TypeN8N is the Type for the n8n alerting provider
+	TypeN8N Type = "n8n"
+
 	// TypeNtfy is the Type for the ntfy alerting provider
 	TypeNtfy Type = "ntfy"
 

alerting/config.go

@@ -25,6 +25,7 @@ import (
 	"github.com/TwiN/gatus/v5/alerting/provider/matrix"
 	"github.com/TwiN/gatus/v5/alerting/provider/mattermost"
 	"github.com/TwiN/gatus/v5/alerting/provider/messagebird"
+	"github.com/TwiN/gatus/v5/alerting/provider/n8n"
 	"github.com/TwiN/gatus/v5/alerting/provider/newrelic"
 	"github.com/TwiN/gatus/v5/alerting/provider/ntfy"
 	"github.com/TwiN/gatus/v5/alerting/provider/opsgenie"
@@ -66,7 +67,6 @@ type Config struct {
 	// Email is the configuration for the email alerting provider
 	Email *email.AlertProvider `yaml:"email,omitempty"`
 
-
 	// GitHub is the configuration for the github alerting provider
 	GitHub *github.AlertProvider `yaml:"github,omitempty"`
 
@@ -81,13 +81,13 @@ type Config struct {
 
 	// Gotify is the configuration for the gotify alerting provider
 	Gotify *gotify.AlertProvider `yaml:"gotify,omitempty"`
-  
+
 	// HomeAssistant is the configuration for the homeassistant alerting provider
 	HomeAssistant *homeassistant.AlertProvider `yaml:"homeassistant,omitempty"`
 
 	// IFTTT is the configuration for the ifttt alerting provider
 	IFTTT *ifttt.AlertProvider `yaml:"ifttt,omitempty"`
-  
+
 	// Ilert is the configuration for the ilert alerting provider
 	Ilert *ilert.AlertProvider `yaml:"ilert,omitempty"`
 
@@ -112,6 +112,9 @@ type Config struct {
 	// NewRelic is the configuration for the newrelic alerting provider
 	NewRelic *newrelic.AlertProvider `yaml:"newrelic,omitempty"`
 
+	// N8N is the configuration for the n8n alerting provider
+	N8N *n8n.AlertProvider `yaml:"n8n,omitempty"`
+
 	// Ntfy is the configuration for the ntfy alerting provider
 	Ntfy *ntfy.AlertProvider `yaml:"ntfy,omitempty"`
 

alerting/provider/awsses/awsses.go

@@ -1,18 +1,18 @@
 package awsses
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"strings"
 
 	"github.com/TwiN/gatus/v5/alerting/alert"
 	"github.com/TwiN/gatus/v5/config/endpoint"
-	"github.com/TwiN/logr"
-	"github.com/aws/aws-sdk-go/aws"
-	"github.com/aws/aws-sdk-go/aws/awserr"
-	"github.com/aws/aws-sdk-go/aws/credentials"
-	"github.com/aws/aws-sdk-go/aws/session"
-	"github.com/aws/aws-sdk-go/service/ses"
+	"github.com/aws/aws-sdk-go-v2/aws"
+	"github.com/aws/aws-sdk-go-v2/config"
+	"github.com/aws/aws-sdk-go-v2/credentials"
+	"github.com/aws/aws-sdk-go-v2/service/ses"
+	"github.com/aws/aws-sdk-go-v2/service/ses/types"
 	"gopkg.in/yaml.v3"
 )
 
@@ -102,63 +102,50 @@ func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, r
 	if err != nil {
 		return err
 	}
-	awsSession, err := provider.createSession(cfg)
+	ctx := context.Background()
+	svc, err := provider.createClient(ctx, cfg)
 	if err != nil {
 		return err
 	}
-	svc := ses.New(awsSession)
 	subject, body := provider.buildMessageSubjectAndBody(ep, alert, result, resolved)
 	emails := strings.Split(cfg.To, ",")
-
 	input := &ses.SendEmailInput{
-		Destination: &ses.Destination{
-			ToAddresses: aws.StringSlice(emails),
+		Destination: &types.Destination{
+			ToAddresses: emails,
 		},
-		Message: &ses.Message{
-			Body: &ses.Body{
-				Text: &ses.Content{
+		Message: &types.Message{
+			Body: &types.Body{
+				Text: &types.Content{
 					Charset: aws.String(CharSet),
 					Data:    aws.String(body),
 				},
 			},
-			Subject: &ses.Content{
+			Subject: &types.Content{
 				Charset: aws.String(CharSet),
 				Data:    aws.String(subject),
 			},
 		},
 		Source: aws.String(cfg.From),
 	}
-	if _, err = svc.SendEmail(input); err != nil {
-		if aerr, ok := err.(awserr.Error); ok {
-			switch aerr.Code() {
-			case ses.ErrCodeMessageRejected:
-				logr.Error(ses.ErrCodeMessageRejected + ": " + aerr.Error())
-			case ses.ErrCodeMailFromDomainNotVerifiedException:
-				logr.Error(ses.ErrCodeMailFromDomainNotVerifiedException + ": " + aerr.Error())
-			case ses.ErrCodeConfigurationSetDoesNotExistException:
-				logr.Error(ses.ErrCodeConfigurationSetDoesNotExistException + ": " + aerr.Error())
-			default:
-				logr.Error(aerr.Error())
-			}
-		} else {
-			// Print the error, cast err to awserr.Error to get the Code and
-			// Message from an error.
-			logr.Error(err.Error())
-		}
-
+	if _, err = svc.SendEmail(ctx, input); err != nil {
 		return err
 	}
 	return nil
 }
 
-func (provider *AlertProvider) createSession(cfg *Config) (*session.Session, error) {
-	awsConfig := &aws.Config{
-		Region: aws.String(cfg.Region),
+func (provider *AlertProvider) createClient(ctx context.Context, cfg *Config) (*ses.Client, error) {
+	var opts []func(*config.LoadOptions) error
+	if len(cfg.Region) > 0 {
+		opts = append(opts, config.WithRegion(cfg.Region))
 	}
 	if len(cfg.AccessKeyID) > 0 && len(cfg.SecretAccessKey) > 0 {
-		awsConfig.Credentials = credentials.NewStaticCredentials(cfg.AccessKeyID, cfg.SecretAccessKey, "")
+		opts = append(opts, config.WithCredentialsProvider(credentials.NewStaticCredentialsProvider(cfg.AccessKeyID, cfg.SecretAccessKey, "")))
+	}
+	awsConfig, err := config.LoadDefaultConfig(ctx, opts...)
+	if err != nil {
+		return nil, err
 	}
-	return session.NewSession(awsConfig)
+	return ses.NewFromConfig(awsConfig), nil
 }
 
 // buildMessageSubjectAndBody builds the message subject and body

alerting/provider/incidentio/dedup.go

@@ -0,0 +1,18 @@
+package incidentio
+
+import (
+	"crypto/sha256"
+	"encoding/hex"
+	"fmt"
+	"time"
+
+	"github.com/TwiN/gatus/v5/alerting/alert"
+	"github.com/TwiN/gatus/v5/config/endpoint"
+)
+
+// generateDeduplicationKey generates a unique deduplication_key for incident.io
+func generateDeduplicationKey(ep *endpoint.Endpoint, alert *alert.Alert) string {
+	data := fmt.Sprintf("%s|%s|%s|%d", ep.Key(), alert.Type, alert.GetDescription(), time.Now().UnixNano())
+	hash := sha256.Sum256([]byte(data))
+	return hex.EncodeToString(hash[:])
+}

alerting/provider/incidentio/incidentio.go

@@ -153,27 +153,44 @@ func (provider *AlertProvider) buildRequestBody(cfg *Config, ep *endpoint.Endpoi
 		} else {
 			prefix = "🔴"
 		}
-		// No need for \n since incident.io trims it anyways.
 		formattedConditionResults += fmt.Sprintf(" %s %s ", prefix, conditionResult.Condition)
 	}
 	if len(alert.GetDescription()) > 0 {
 		message += " with the following description: " + alert.GetDescription()
 	}
 	message += fmt.Sprintf(" and the following conditions: %s ", formattedConditionResults)
-	var body []byte
+
+	// Generate deduplication key if empty (first firing)
+	if alert.ResolveKey == "" {
+		// Generate unique key (endpoint key, alert type, timestamp)
+		alert.ResolveKey = generateDeduplicationKey(ep, alert)
+	}
+	// Extract alert_source_config_id from URL
 	alertSourceID := strings.TrimPrefix(cfg.URL, restAPIUrl)
-	body, _ = json.Marshal(Body{
+	// Merge metadata: cfg.Metadata + ep.ExtraLabels (if present)
+	mergedMetadata := map[string]interface{}{}
+	// Copy cfg.Metadata
+	for k, v := range cfg.Metadata {
+		mergedMetadata[k] = v
+	}
+	// Add extra labels from endpoint (if present)
+	if ep.ExtraLabels != nil && len(ep.ExtraLabels) > 0 {
+		for k, v := range ep.ExtraLabels {
+			mergedMetadata[k] = v
+		}
+	}
+
+	body, _ := json.Marshal(Body{
 		AlertSourceConfigID: alertSourceID,
 		Title:               "Gatus: " + ep.DisplayName(),
 		Status:              status,
 		DeduplicationKey:    alert.ResolveKey,
 		Description:         message,
 		SourceURL:           cfg.SourceURL,
-		Metadata:            cfg.Metadata,
+		Metadata:            mergedMetadata,
 	})
 	fmt.Printf("%v", string(body))
 	return body
-
 }
 func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Config, error) {
 	cfg := provider.DefaultConfig