After configuring the SMTP, attempt to send the email. (#1684)

* After configuring the SMTP, attempt to send the email.

* refactor code

* refactor code

* Update router_notify_config.go

---------
Co-authored-by: NshardingHe <wangzihe@flashcat.cloud>
Co-authored-by: NYening Qin <710leo@gmail.com>

alert/alert.go

@@ -91,5 +91,5 @@ func Start(alertc aconf.Alert, pushgwc pconf.Pushgw, syncStats *memsto.Stats, al
 	go consumer.LoopConsume()
 
 	go queue.ReportQueueSize(alertStats)
-	go sender.StartEmailSender(notifyConfigCache.GetSMTP()) // todo
+	go sender.InitEmailSender(notifyConfigCache.GetSMTP())
 }

alert/dispatch/dispatch.go

@@ -86,12 +86,12 @@ func (e *Dispatch) relaodTpls() error {
 
 	senders := map[string]sender.Sender{
 		models.Email:      sender.NewSender(models.Email, tmpTpls, smtp),
-		models.Dingtalk:   sender.NewSender(models.Dingtalk, tmpTpls, smtp),
-		models.Wecom:      sender.NewSender(models.Wecom, tmpTpls, smtp),
-		models.Feishu:     sender.NewSender(models.Feishu, tmpTpls, smtp),
-		models.Mm:         sender.NewSender(models.Mm, tmpTpls, smtp),
-		models.Telegram:   sender.NewSender(models.Telegram, tmpTpls, smtp),
-		models.FeishuCard: sender.NewSender(models.FeishuCard, tmpTpls, smtp),
+		models.Dingtalk:   sender.NewSender(models.Dingtalk, tmpTpls),
+		models.Wecom:      sender.NewSender(models.Wecom, tmpTpls),
+		models.Feishu:     sender.NewSender(models.Feishu, tmpTpls),
+		models.Mm:         sender.NewSender(models.Mm, tmpTpls),
+		models.Telegram:   sender.NewSender(models.Telegram, tmpTpls),
+		models.FeishuCard: sender.NewSender(models.FeishuCard, tmpTpls),
 	}
 
 	e.RwLock.RLock()

alert/sender/email.go

@@ -2,6 +2,7 @@ package sender
 
 import (
 	"crypto/tls"
+	"errors"
 	"html/template"
 	"time"
 
@@ -47,7 +48,7 @@ func extract(users []*models.User) []string {
 	return tos
 }
 
-func (es *EmailSender) SendEmail(subject, content string, tos []string, stmp aconf.SMTPConfig) {
+func SendEmail(subject, content string, tos []string, stmp aconf.SMTPConfig) error {
 	conf := stmp
 
 	d := gomail.NewDialer(conf.Host, conf.Port, conf.User, conf.Pass)
@@ -64,8 +65,9 @@ func (es *EmailSender) SendEmail(subject, content string, tos []string, stmp aco
 
 	err := d.DialAndSend(m)
 	if err != nil {
-		logger.Errorf("email_sender: failed to send: %v", err)
+		return errors.New("email_sender: failed to send: " + err.Error())
 	}
+	return nil
 }
 
 func (es *EmailSender) WriteEmail(subject, content string, tos []string) {
@@ -96,14 +98,16 @@ var mailQuit = make(chan struct{})
 func RestartEmailSender(smtp aconf.SMTPConfig) {
 	close(mailQuit)
 	mailQuit = make(chan struct{})
-	StartEmailSender(smtp)
+	startEmailSender(smtp)
 }
 
-func StartEmailSender(smtp aconf.SMTPConfig) {
+func InitEmailSender(smtp aconf.SMTPConfig) {
 	mailch = make(chan *gomail.Message, 100000)
+	startEmailSender(smtp)
+}
 
+func startEmailSender(smtp aconf.SMTPConfig) {
 	conf := smtp
-
 	if conf.Host == "" || conf.Port == 0 {
 		logger.Warning("SMTP configurations invalid")
 		return

alert/sender/sender.go

@@ -23,7 +23,7 @@ type (
 	}
 )
 
-func NewSender(key string, tpls map[string]*template.Template, smtp aconf.SMTPConfig) Sender {
+func NewSender(key string, tpls map[string]*template.Template, smtp ...aconf.SMTPConfig) Sender {
 	switch key {
 	case models.Dingtalk:
 		return &DingtalkSender{tpl: tpls[models.Dingtalk]}
@@ -34,7 +34,7 @@ func NewSender(key string, tpls map[string]*template.Template, smtp aconf.SMTPCo
 	case models.FeishuCard:
 		return &FeishuCardSender{tpl: tpls[models.FeishuCard]}
 	case models.Email:
-		return &EmailSender{subjectTpl: tpls["mailsubject"], contentTpl: tpls[models.Email], smtp: smtp}
+		return &EmailSender{subjectTpl: tpls[models.EmailSubject], contentTpl: tpls[models.Email], smtp: smtp[0]}
 	case models.Mm:
 		return &MmSender{tpl: tpls[models.Mm]}
 	case models.Telegram:

center/router/router.go

@@ -372,6 +372,7 @@ func (rt *Router) Config(r *gin.Engine) {
 
 		pages.GET("/notify-config", rt.auth(), rt.admin(), rt.notifyConfigGet)
 		pages.PUT("/notify-config", rt.auth(), rt.admin(), rt.notifyConfigPut)
+		pages.GET("/smtp-config-test", rt.auth(), rt.admin(), rt.attemptSendEmail)
 
 		pages.GET("/es-index-pattern", rt.auth(), rt.esIndexPatternGet)
 		pages.GET("/es-index-pattern-list", rt.auth(), rt.esIndexPatternGetList)

center/router/router_notify_config.go

@@ -2,15 +2,17 @@ package router
 
 import (
 	"encoding/json"
-
+	"strings"
+	
 	"github.com/ccfos/nightingale/v6/alert/aconf"
 	"github.com/ccfos/nightingale/v6/alert/sender"
 	"github.com/ccfos/nightingale/v6/memsto"
 	"github.com/ccfos/nightingale/v6/models"
-	"github.com/pelletier/go-toml/v2"
-
+	
 	"github.com/gin-gonic/gin"
+	"github.com/pelletier/go-toml/v2"
 	"github.com/toolkits/pkg/ginx"
+	"github.com/toolkits/pkg/str"
 )
 
 func (rt *Router) webhookGets(c *gin.Context) {
@@ -191,3 +193,15 @@ func (rt *Router) notifyConfigPut(c *gin.Context) {
 
 	ginx.NewRender(c).Message(nil)
 }
+
+//After configuring the aconf.SMTPConfig, attempt to send the email.
+func (rt *Router) attemptSendEmail(c *gin.Context) {
+	//input is an email address
+	email := ginx.QueryStr(c, "email")
+	if email = strings.TrimSpace(email); email != "" && !str.IsMail(email) {
+		ginx.Bomb(200, "email(%s) invalid", email)
+	}
+	smtp := rt.NotifyConfigCache.GetSMTP()
+
+	ginx.NewRender(c).Message(sender.SendEmail("Email test", "email content", []string{email}, smtp))
+}

center/router/router_notify_tpl.go

@@ -21,7 +21,7 @@ func (rt *Router) notifyTplGets(c *gin.Context) {
 	for _, channel := range models.DefaultChannels {
 		m[channel] = struct{}{}
 	}
-	m["mailsubject"] = struct{}{}
+	m[models.EmailSubject] = struct{}{}
 
 	lst, err := models.NotifyTplGets(rt.Ctx)
 	for i := 0; i < len(lst); i++ {

models/notify_tpl.go

@@ -222,7 +222,7 @@ func getNotifyTpl(tplDir string) map[string]string {
 }
 
 var TplMap = map[string]string{
-	"dingtalk": `#### {{if .IsRecovered}}<font color="#008800">S{{.Severity}} - Recovered - {{.RuleName}}</font>{{else}}<font color="#FF0000">S{{.Severity}} - Triggered - {{.RuleName}}</font>{{end}}
+	Dingtalk: `#### {{if .IsRecovered}}<font color="#008800">S{{.Severity}} - Recovered - {{.RuleName}}</font>{{else}}<font color="#FF0000">S{{.Severity}} - Triggered - {{.RuleName}}</font>{{end}}
 
 ---
 
@@ -234,7 +234,7 @@ var TplMap = map[string]string{
 - {{if .IsRecovered}}**恢复时间**: {{timeformat .LastEvalTime}}{{else}}**触发时间**: {{timeformat .TriggerTime}}{{end}}
 - **发送时间**: {{timestamp}}
 	`,
-	"email": `<!DOCTYPE html>
+	Email: `<!DOCTYPE html>
 	<html lang="en">
 	<head>
 		<meta charset="UTF-8">
@@ -451,14 +451,14 @@ var TplMap = map[string]string{
 	</div>
 	</body>
 	</html>`,
-	"feishu": `级别状态: S{{.Severity}} {{if .IsRecovered}}Recovered{{else}}Triggered{{end}}   
+	Feishu: `级别状态: S{{.Severity}} {{if .IsRecovered}}Recovered{{else}}Triggered{{end}}   
 规则名称: {{.RuleName}}{{if .RuleNote}}   
 规则备注: {{.RuleNote}}{{end}}   
 监控指标: {{.TagsJSON}}
 {{if .IsRecovered}}恢复时间：{{timeformat .LastEvalTime}}{{else}}触发时间: {{timeformat .TriggerTime}}
 触发时值: {{.TriggerValue}}{{end}}
 发送时间: {{timestamp}}`,
-	"feishucard": `{{ if .IsRecovered }}
+	FeishuCard: `{{ if .IsRecovered }}
 {{- if ne .Cate "host"}}
 **告警集群:** {{.Cluster}}{{end}}   
 **级别状态:** S{{.Severity}} Recovered   
@@ -475,15 +475,15 @@ var TplMap = map[string]string{
 **触发时值:** {{.TriggerValue}}   
 {{if .RuleNote }}**告警描述:** **{{.RuleNote}}**{{end}}   
 {{- end -}}`,
-	"mailsubject": `{{if .IsRecovered}}Recovered{{else}}Triggered{{end}}: {{.RuleName}} {{.TagsJSON}}`,
-	"mm": `级别状态: S{{.Severity}} {{if .IsRecovered}}Recovered{{else}}Triggered{{end}}   
+	EmailSubject: `{{if .IsRecovered}}Recovered{{else}}Triggered{{end}}: {{.RuleName}} {{.TagsJSON}}`,
+	Mm: `级别状态: S{{.Severity}} {{if .IsRecovered}}Recovered{{else}}Triggered{{end}}   
 规则名称: {{.RuleName}}{{if .RuleNote}}   
 规则备注: {{.RuleNote}}{{end}}   
 监控指标: {{.TagsJSON}}   
 {{if .IsRecovered}}恢复时间：{{timeformat .LastEvalTime}}{{else}}触发时间: {{timeformat .TriggerTime}}   
 触发时值: {{.TriggerValue}}{{end}}   
 发送时间: {{timestamp}}`,
-	"telegram": `**级别状态**: {{if .IsRecovered}}<font color="info">S{{.Severity}} Recovered</font>{{else}}<font color="warning">S{{.Severity}} Triggered</font>{{end}}   
+	Telegram: `**级别状态**: {{if .IsRecovered}}<font color="info">S{{.Severity}} Recovered</font>{{else}}<font color="warning">S{{.Severity}} Triggered</font>{{end}}   
 **规则标题**: {{.RuleName}}{{if .RuleNote}}   
 **规则备注**: {{.RuleNote}}{{end}}{{if .TargetIdent}}   
 **监控对象**: {{.TargetIdent}}{{end}}   
@@ -492,7 +492,7 @@ var TplMap = map[string]string{
 {{if .IsRecovered}}**恢复时间**: {{timeformat .LastEvalTime}}{{else}}**首次触发时间**: {{timeformat .FirstTriggerTime}}{{end}}   
 {{$time_duration := sub now.Unix .FirstTriggerTime }}{{if .IsRecovered}}{{$time_duration = sub .LastEvalTime .FirstTriggerTime }}{{end}}**距离首次告警**: {{humanizeDurationInterface $time_duration}}
 **发送时间**: {{timestamp}}`,
-	"wecom": `**级别状态**: {{if .IsRecovered}}<font color="info">S{{.Severity}} Recovered</font>{{else}}<font color="warning">S{{.Severity}} Triggered</font>{{end}}   
+	Wecom: `**级别状态**: {{if .IsRecovered}}<font color="info">S{{.Severity}} Recovered</font>{{else}}<font color="warning">S{{.Severity}} Triggered</font>{{end}}   
 **规则标题**: {{.RuleName}}{{if .RuleNote}}   
 **规则备注**: {{.RuleNote}}{{end}}{{if .TargetIdent}}   
 **监控对象**: {{.TargetIdent}}{{end}}