add slack support

Author: hatamiarash7

README.md

@@ -41,7 +41,7 @@ You can use multiple notifiers at the same time. Just define them to the `config
 
 - [x] Squadcast
 - [x] Telegram
-- [ ] Slack ( WIP )
+- [x] Slack
 - [ ] Webhook ( WIP )
 
 ### Squadcast
@@ -77,6 +77,21 @@ notifier:
               topic: "56789"
 ```
 
+### Slack
+
+1. Create a new Application in Slack
+2. Use `Incoming Webhook` as type
+3. Define the webhook in `config.yml` file
+
+   ```yaml
+   notifier:
+      slack:
+         enable: true
+         teams:
+            team1: "<WEBHOOK-URL>"
+            team2: "<WEBHOOK-URL>"
+   ```
+
 ## Monitoring
 
 We have some metrics for monitoring our service in `/metrics` path.
@@ -88,6 +103,8 @@ We have some metrics for monitoring our service in `/metrics` path.
 | `UPTIME_webhook_telegram_failure`  | Total number of failure Telegram notify     |
 | `UPTIME_webhook_squadcast_success` | Total number of successful Squadcast notify |
 | `UPTIME_webhook_squadcast_failure` | Total number of failure Squadcast notify    |
+| `UPTIME_webhook_slack_success`     | Total number of successful Slack notify     |
+| `UPTIME_webhook_slack_failure`     | Total number of failure Slack notify        |
 
 ---
 

configs/config.go

@@ -37,6 +37,10 @@ type Config struct {
 			Token     string                    `yaml:"token"`
 			Teams     map[string][]TelegramTeam `yaml:"teams"`
 		} `yaml:"telegram"`
+		Slack struct {
+			IsEnabled bool `yaml:"enable"`
+			Teams     map[string]string
+		} `yaml:"slack"`
 	}
 
 	Version string

configs/config.yml.example

@@ -34,3 +34,8 @@ notifier:
       team2:
         - chat: "-124564"
           topic: "56789"
+  slack:
+    enable: true
+    teams:
+      team1: ""
+      team2: ""

internal/models/slack.go

@@ -0,0 +1,6 @@
+package models
+
+// TelegramMessage is a struct for Telegram message
+type SlackMessage struct {
+	Text string `json:"text,omitempty"`
+}

internal/platform/monitoring/event.go

@@ -14,6 +14,10 @@ const (
 	IncSquadcastSendSuccess
 	// IncSquadcastSendFailure will show the total failure squadcast sends
 	IncSquadcastSendFailure
+	// IncSlackSendSuccess will show the total success squadcast sends
+	IncSlackSendSuccess
+	// IncSlackSendFailure will show the total failure squadcast sends
+	IncSlackSendFailure
 	// SetActiveJobsInAlertPool will show the total active jobs in alert pool
 	SetActiveJobsInAlertPool
 	// SetAlertPoolCapacity will show the total capacity of alert pool

internal/platform/monitoring/mock.go

@@ -27,6 +27,10 @@ func (i MockMonitor) Record(events []Event) {
 			log.Info("====IncSquadcastSendSuccess=====")
 		case IncSquadcastSendFailure:
 			log.Info("====IncSquadcastSendFailure=====")
+		case IncSlackSendSuccess:
+			log.Info("====IncSlackSendSuccess=====")
+		case IncSlackSendFailure:
+			log.Info("====IncSlackSendFailure=====")
 		case SetActiveJobsInAlertPool:
 			log.Info("====SetActiveJobsInAlertPool=====")
 		case SetAlertPoolCapacity:

internal/platform/monitoring/prometheus.go

@@ -18,6 +18,8 @@ var (
 	telegramFailure      prometheus.Counter
 	squadcastSuccess     prometheus.Counter
 	squadcastFailure     prometheus.Counter
+	slackSuccess         prometheus.Counter
+	slackFailure         prometheus.Counter
 	alertPoolCapacity    prometheus.Gauge
 	alertPoolRunningJobs prometheus.Gauge
 )
@@ -66,6 +68,20 @@ func NewPrometheusMonitor() Monitor {
 		Help:      "Total number of failure notify requests to Squadcast.",
 	})
 
+	slackSuccess = promauto.NewCounter(prometheus.CounterOpts{
+		Namespace: namespace,
+		Subsystem: subsystem,
+		Name:      "slack_success",
+		Help:      "Total number of successful notify requests to Slack.",
+	})
+
+	slackFailure = promauto.NewCounter(prometheus.CounterOpts{
+		Namespace: namespace,
+		Subsystem: subsystem,
+		Name:      "slack_failure",
+		Help:      "Total number of failure notify requests to Slack.",
+	})
+
 	alertPoolCapacity = promauto.NewGauge(prometheus.GaugeOpts{
 		Namespace: namespace,
 		Subsystem: subsystem,
@@ -97,6 +113,10 @@ func (i PrometheusMonitor) Record(events []Event) {
 			squadcastSuccess.Inc()
 		case IncSquadcastSendFailure:
 			squadcastFailure.Inc()
+		case IncSlackSendSuccess:
+			slackSuccess.Inc()
+		case IncSlackSendFailure:
+			slackFailure.Inc()
 		case SetActiveJobsInAlertPool:
 			alertPoolRunningJobs.Set(float64(event.GetParam(0).(int)))
 		case SetAlertPoolCapacity:

internal/platform/repositories/alert/alert_repository.go

@@ -46,5 +46,11 @@ func (r *Repository) CreateAlert(ctx context.Context, alert models.Alert) error
 		}
 	}
 
+	if r.config.Notifier.Slack.IsEnabled {
+		if err := r.CreateSlackMessage(alert); err != nil {
+			return err
+		}
+	}
+
 	return nil
 }

internal/platform/repositories/alert/helper.go

@@ -86,6 +86,33 @@ func formatSquadcastMessage(alert models.Alert) models.SquadcastIncident {
 	return payload
 }
 
+func formatSlackMessage(alert models.Alert) models.SlackMessage {
+	var text string
+
+	if alert.Event == "alert_raised" {
+		text = "🔥 *Alert - " + alert.Data.Alert.State + "*\n\n"
+		text += "📌 *Source:* Uptime\n\n"
+		text += "🏷 *Title:* The \"" + alert.Data.Service.ShortName + "\" is down\n\n"
+		text += "📄 *Description:* Your `" + alert.Data.Service.DisplayName +
+			"` service is down" +
+			" at *" + alert.Data.Alert.CreatedAt.Format("2006-01-02 15:04:05") + "*\n\n"
+		text += "💻 *Address:* " + alert.Data.Device.Address + "\n\n"
+		text += "🔍 *Result:* " + alert.Data.Alert.ShortOutput + "\n"
+	} else {
+		text = "✅ *Resolved*\n\n"
+		text += "📌 *Source:* Uptime\n\n"
+		text += "🏷 *Title:* The \"" + alert.Data.Service.ShortName + "\" is up\n\n"
+		text += "💻 *Address:* " + alert.Data.Device.Address + "\n\n"
+		text += "⏱️ *Time:* " + alert.Data.Date.Format("2006-01-02 15:04:05") + "\n\n"
+	}
+
+	payload := models.SlackMessage{
+		Text: text,
+	}
+
+	return payload
+}
+
 func getAlertColor(state string) models.SquadcastTag {
 	var color string
 

internal/platform/repositories/alert/pool.go

@@ -81,3 +81,27 @@ func (r *Repository) CallTelegram(url string, body []byte) error {
 		}
 	})
 }
+
+// CallSlack will send a Slack http request
+func (r *Repository) CallSlack(url string, body []byte) error {
+	u, err := net_url.ParseRequestURI(url)
+
+	if err != nil {
+		log.WithError(err).Errorf("[SLACK] Error parsing URL: %s", url)
+		r.monitoring.Record([]monitoring.Event{monitoring.NewEvent(monitoring.IncSlackSendFailure)})
+		return err
+	}
+
+	return r.pool.Submit(func() {
+		result, err := sendPOSTRequest(u.String(), body, r.version)
+
+		if err != nil {
+			log.WithError(err).Error("[SLACK] Error sending request to " + u.String())
+			r.monitoring.Record([]monitoring.Event{monitoring.NewEvent(monitoring.IncSlackSendFailure)})
+			return
+		}
+
+		log.Debugf("[SLACK] Result: %s", result)
+		r.monitoring.Record([]monitoring.Event{monitoring.NewEvent(monitoring.IncSlackSendSuccess)})
+	})
+}