feat: add telegram alert channel (#28)

Author: Ellipse0934

api/api.go

@@ -173,10 +173,10 @@ func New(opts Options) (*API, error) {
 // true for the concurrency limit, with the exception that it is only applied to
 // GET requests.
 func (api *API) Register(r *route.Router, routePrefix string, reloadCh chan<- chan error, updateConfigCh chan interface{}, updateConfigErrCh chan error) *http.ServeMux {
-	
+
 	// reloadCh:  can initiate reload of alertmanager with updated config
 	// on request
-	// updateConfigCh: writes current config from memory to disk 
+	// updateConfigCh: writes current config from memory to disk
 	api.v1.Register(r.WithPrefix("/api/v1"), reloadCh, updateConfigCh, updateConfigErrCh)
 
 	mux := http.NewServeMux()

api/v1/config_api.go

@@ -16,6 +16,7 @@ import (
 	"github.com/prometheus/alertmanager/notify/opsgenie"
 	"github.com/prometheus/alertmanager/notify/pagerduty"
 	"github.com/prometheus/alertmanager/notify/slack"
+	"github.com/prometheus/alertmanager/notify/telegram"
 	"github.com/prometheus/alertmanager/notify/webhook"
 	"github.com/prometheus/alertmanager/template"
 	"github.com/prometheus/alertmanager/types"
@@ -297,6 +298,23 @@ func (api *API) testReceiver(w http.ResponseWriter, req *http.Request) {
 			api.respondError(w, apiError{err: err, typ: errorInternal}, fmt.Sprintf("failed to send test message to channel (%s)", receiver.Name))
 			return
 		}
+	} else if receiver.TelegramConfigs != nil {
+		telegramConfig := receiver.TelegramConfigs[0]
+		telegramConfig.HTTPConfig = &commoncfg.HTTPClientConfig{}
+		telegramConfig.APIUrl = defaultGlobalConfig.TelegramAPIUrl
+		telegramConfig.ParseMode = "HTML"
+		notifier, err := telegram.New(telegramConfig, tmpl, api.logger)
+		if err != nil {
+			api.respondError(w, apiError{err: err, typ: errorInternal}, "failed to prepare message for select config")
+			return
+		}
+		ctx := getCtx(receiver.Name)
+		dummyAlert := getDummyAlert()
+		_, err = notifier.Notify(ctx, &dummyAlert)
+		if err != nil {
+			api.respondError(w, apiError{err: err, typ: errorInternal}, fmt.Sprintf("failed to send test message to channel (%s)", receiver.Name))
+		}
+		return
 	} else if receiver.EmailConfigs != nil {
 		emailConfig := receiver.EmailConfigs[0]
 		emailConfig.From = defaultGlobalConfig.SMTPFrom

asset/asset.go

@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+//go:build dev
 // +build dev
 
 package asset

asset/asset_generate.go

@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+//go:build ignore
 // +build ignore
 
 package main

asset/assets_vfsdata.go

@@ -56,6 +56,7 @@ import (
 	"github.com/prometheus/alertmanager/notify/pushover"
 	"github.com/prometheus/alertmanager/notify/slack"
 	"github.com/prometheus/alertmanager/notify/sns"
+	"github.com/prometheus/alertmanager/notify/telegram"
 	"github.com/prometheus/alertmanager/notify/victorops"
 	"github.com/prometheus/alertmanager/notify/webhook"
 	"github.com/prometheus/alertmanager/notify/wechat"
@@ -158,6 +159,9 @@ func buildReceiverIntegrations(nc *config.Receiver, tmpl *template.Template, log
 	for i, c := range nc.OpsGenieConfigs {
 		add("opsgenie", i, c, func(l log.Logger) (notify.Notifier, error) { return opsgenie.New(c, tmpl, l) })
 	}
+	for i, c := range nc.TelegramConfigs {
+		add("telegram", i, c, func(l log.Logger) (notify.Notifier, error) { return telegram.New(c, tmpl, l) })
+	}
 	for i, c := range nc.WechatConfigs {
 		add("wechat", i, c, func(l log.Logger) (notify.Notifier, error) { return wechat.New(c, tmpl, l) })
 	}

cmd/alertmanager/main.go

@@ -228,6 +228,9 @@ func resolveFilepaths(baseDir string, cfg *Config) {
 		for _, cfg := range receiver.OpsGenieConfigs {
 			cfg.HTTPConfig.SetDirectory(baseDir)
 		}
+		for _, cfg := range receiver.TelegramConfigs {
+			cfg.HTTPConfig.SetDirectory(baseDir)
+		}
 		for _, cfg := range receiver.PagerdutyConfigs {
 			cfg.HTTPConfig.SetDirectory(baseDir)
 		}
@@ -511,6 +514,14 @@ func (c *Config) Validate() error {
 				ogc.APIKeyFile = c.Global.OpsGenieAPIKeyFile
 			}
 		}
+		for _, telegram := range rcv.TelegramConfigs {
+			if telegram.HTTPConfig == nil {
+				telegram.HTTPConfig = c.Global.HTTPConfig
+			}
+			if telegram.APIUrl == nil {
+				telegram.APIUrl = c.Global.TelegramAPIUrl
+			}
+		}
 		for _, wcc := range rcv.WechatConfigs {
 			if wcc.HTTPConfig == nil {
 				wcc.HTTPConfig = c.Global.HTTPConfig
@@ -770,6 +781,7 @@ func DefaultGlobalConfig() GlobalConfig {
 		SMTPRequireTLS:   true,
 		PagerdutyURL:     mustParseURL("https://events.pagerduty.com/v2/enqueue"),
 		OpsGenieAPIURL:   mustParseURL("https://api.opsgenie.com/"),
+		TelegramAPIUrl:   mustParseURL("https://api.telegram.org"),
 		WeChatAPIURL:     mustParseURL("https://qyapi.weixin.qq.com/cgi-bin/"),
 		VictorOpsAPIURL:  mustParseURL("https://alert.victorops.com/integrations/generic/20131114/alert/"),
 	}
@@ -889,6 +901,7 @@ type GlobalConfig struct {
 	OpsGenieAPIURL     *URL   `yaml:"opsgenie_api_url,omitempty" json:"opsgenie_api_url,omitempty"`
 	OpsGenieAPIKey     Secret `yaml:"opsgenie_api_key,omitempty" json:"opsgenie_api_key,omitempty"`
 	OpsGenieAPIKeyFile string `yaml:"opsgenie_api_key_file,omitempty" json:"opsgenie_api_key_file,omitempty"`
+	TelegramAPIUrl     *URL   `yaml:"telegram_api_url,omitempty" json:"telegram_api_url,omitempty"`
 	WeChatAPIURL       *URL   `yaml:"wechat_api_url,omitempty" json:"wechat_api_url,omitempty"`
 	WeChatAPISecret    Secret `yaml:"wechat_api_secret,omitempty" json:"wechat_api_secret,omitempty"`
 	WeChatAPICorpID    string `yaml:"wechat_api_corp_id,omitempty" json:"wechat_api_corp_id,omitempty"`
@@ -1052,6 +1065,7 @@ type Receiver struct {
 	SlackConfigs     []*SlackConfig     `yaml:"slack_configs,omitempty" json:"slack_configs,omitempty"`
 	WebhookConfigs   []*WebhookConfig   `yaml:"webhook_configs,omitempty" json:"webhook_configs,omitempty"`
 	OpsGenieConfigs  []*OpsGenieConfig  `yaml:"opsgenie_configs,omitempty" json:"opsgenie_configs,omitempty"`
+	TelegramConfigs  []*TelegramConfig  `yaml:"telegram_configs,omitempty" json:"telegram_configs,omitempty"`
 	WechatConfigs    []*WechatConfig    `yaml:"wechat_configs,omitempty" json:"wechat_configs,omitempty"`
 	PushoverConfigs  []*PushoverConfig  `yaml:"pushover_configs,omitempty" json:"pushover_configs,omitempty"`
 	VictorOpsConfigs []*VictorOpsConfig `yaml:"victorops_configs,omitempty" json:"victorops_configs,omitempty"`

config/config.go

@@ -1,17 +1,16 @@
 package config
 
 import (
+	"gopkg.in/yaml.v2"
 	"io/ioutil"
 	"path/filepath"
-	"gopkg.in/yaml.v2"
 )
 
 // ConfigLoader loads config for co-ordinator
 type ConfigLoader interface {
 	Load(c *Config) error
 }
 
-
 // configFileLoader is default config loader that reads
 // from yaml file. This is primarily meant for test coverage
 type configFileLoader struct {
@@ -34,9 +33,8 @@ func (cfl *configFileLoader) Load(c *Config) error {
 	if err != nil {
 		return err
 	}
-	
+
 	c.original = string(content)
 	resolveFilepaths(filepath.Dir(cfl.filePath), c)
 	return c.Validate()
 }
-

config/config_loader.go

@@ -4,25 +4,26 @@ import "fmt"
 
 const (
 	AddRouteAction = iota + 1
-	EditRouteAction 
-	DeleteRouteAction 
+	EditRouteAction
+	DeleteRouteAction
 )
+
 // ConfigChangeRequest is useful when managing configuration changes
 type ConfigChangeRequest struct {
-	Action int 
-	Route *Route
+	Action   int
+	Route    *Route
 	Receiver *Receiver
 }
 
-func (c *ConfigChangeRequest) Validate() error { 
+func (c *ConfigChangeRequest) Validate() error {
 	if c.Action == 0 {
 		return fmt.Errorf("action field must be set for validating config change request")
 	}
 
 	switch c.Action {
-		case AddRouteAction, EditRouteAction:
-			return c.Receiver.Validate()
-		default:
-			return nil
+	case AddRouteAction, EditRouteAction:
+		return c.Receiver.Validate()
+	default:
+		return nil
 	}
 }

config/config_requests.go

@@ -25,8 +25,8 @@ import (
 
 	commoncfg "github.com/prometheus/common/config"
 	"github.com/prometheus/common/model"
-	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 	"gopkg.in/yaml.v2"
 )
 
@@ -445,8 +445,9 @@ receivers:
 		t.Errorf("\nexpected:\n%q\ngot:\n%q", expected, err.Error())
 	}
 }
-/* Amol/SigNoz 21/03/22 Skipping this test 
-	as we need to keep the secrets in memory to support dynamic changes 
+
+/* Amol/SigNoz 21/03/22 Skipping this test
+	as we need to keep the secrets in memory to support dynamic changes
 
 func TestHideConfigSecrets(t *testing.T) {
 	c, err := LoadFile("testdata/conf.good.yml")
@@ -1167,59 +1168,59 @@ func TestAddAndDeleteRoute(t *testing.T) {
 		Receiver: "test-add-route",
 	}
 
-	receiver := Receiver {
+	receiver := Receiver{
 		Name: "test-add-route",
 		WebhookConfigs: []*WebhookConfig{
-			&WebhookConfig {
+			&WebhookConfig{
 				URL: (*URL)(mustParseURL("https://webhook")),
 			},
 		},
 	}
 
 	config.AddRoute(&route, &receiver)
-	
+
 	assert := assert.New(t)
 	assert.NotNil(t, config)
 	if assert.NotNil(t, config.Route) {
 		if assert.NotNil(t, config.Route.Routes) {
-			expectedRoutes := []*Route {
+			expectedRoutes := []*Route{
 				&route,
 			}
-			
+
 			assert.Equal(config.Route.Routes, expectedRoutes, "unexpected attributes found on route")
 		}
 	}
-	
+
 	if assert.NotNil(t, config.Receivers) {
 		if assert.Equal(len(config.Receivers), 2, "unexpected receivers found") {
 			assert.Equal(config.Receivers[1], &receiver, "unexpected attributes found on the receiver")
 		}
 	}
-	
+
 	route.Receiver = "test-add-route-2"
 	receiver.Name = "test-add-route-2"
 
 	config.AddRoute(&route, &receiver)
 
 	assert.NoError(config.DeleteRoute("test-add-route"), "failed to delete route test-add-route")
-	
-	// check if existing receiver still exists 
+
+	// check if existing receiver still exists
 	check1 := false
 
-	// check if deleted receiver does not eixst 
+	// check if deleted receiver does not eixst
 	check2 := true
-	
+
 	for _, r := range config.Receivers {
 		if r.Name == "test-add-route-2" {
-			check1 = true; 
+			check1 = true
 		}
-		if r.Name == "test-add-route"{
-			// deleted receiver exists 
+		if r.Name == "test-add-route" {
+			// deleted receiver exists
 			check2 = false
 		}
 	}
 
 	assert.Equal(check1, true, "existing route deleted even when not asked")
 	assert.Equal(check2, true, "deleted receiver still exists")
 	assert.Equal(config.Route.Routes[0], &route, "deleting route did not work")
-}
+}