telegram.go 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. package notifiers
  2. import (
  3. "bytes"
  4. "fmt"
  5. "io"
  6. "mime/multipart"
  7. "os"
  8. "github.com/grafana/grafana/pkg/bus"
  9. "github.com/grafana/grafana/pkg/infra/log"
  10. m "github.com/grafana/grafana/pkg/models"
  11. "github.com/grafana/grafana/pkg/services/alerting"
  12. )
  13. const (
  14. captionLengthLimit = 1024
  15. )
  16. var (
  17. telegramApiUrl = "https://api.telegram.org/bot%s/%s"
  18. )
  19. func init() {
  20. alerting.RegisterNotifier(&alerting.NotifierPlugin{
  21. Type: "telegram",
  22. Name: "Telegram",
  23. Description: "Sends notifications to Telegram",
  24. Factory: NewTelegramNotifier,
  25. OptionsTemplate: `
  26. <h3 class="page-heading">Telegram API settings</h3>
  27. <div class="gf-form">
  28. <span class="gf-form-label width-9">BOT API Token</span>
  29. <input type="text" required
  30. class="gf-form-input"
  31. ng-model="ctrl.model.settings.bottoken"
  32. placeholder="Telegram BOT API Token"></input>
  33. </div>
  34. <div class="gf-form">
  35. <span class="gf-form-label width-9">Chat ID</span>
  36. <input type="text" required
  37. class="gf-form-input"
  38. ng-model="ctrl.model.settings.chatid"
  39. data-placement="right">
  40. </input>
  41. <info-popover mode="right-absolute">
  42. Integer Telegram Chat Identifier
  43. </info-popover>
  44. </div>
  45. `,
  46. })
  47. }
  48. type TelegramNotifier struct {
  49. NotifierBase
  50. BotToken string
  51. ChatID string
  52. UploadImage bool
  53. log log.Logger
  54. }
  55. func NewTelegramNotifier(model *m.AlertNotification) (alerting.Notifier, error) {
  56. if model.Settings == nil {
  57. return nil, alerting.ValidationError{Reason: "No Settings Supplied"}
  58. }
  59. botToken := model.Settings.Get("bottoken").MustString()
  60. chatId := model.Settings.Get("chatid").MustString()
  61. uploadImage := model.Settings.Get("uploadImage").MustBool()
  62. if botToken == "" {
  63. return nil, alerting.ValidationError{Reason: "Could not find Bot Token in settings"}
  64. }
  65. if chatId == "" {
  66. return nil, alerting.ValidationError{Reason: "Could not find Chat Id in settings"}
  67. }
  68. return &TelegramNotifier{
  69. NotifierBase: NewNotifierBase(model),
  70. BotToken: botToken,
  71. ChatID: chatId,
  72. UploadImage: uploadImage,
  73. log: log.New("alerting.notifier.telegram"),
  74. }, nil
  75. }
  76. func (this *TelegramNotifier) buildMessage(evalContext *alerting.EvalContext, sendImageInline bool) *m.SendWebhookSync {
  77. if sendImageInline {
  78. cmd, err := this.buildMessageInlineImage(evalContext)
  79. if err == nil {
  80. return cmd
  81. }
  82. this.log.Error("Could not generate Telegram message with inline image.", "err", err)
  83. }
  84. return this.buildMessageLinkedImage(evalContext)
  85. }
  86. func (this *TelegramNotifier) buildMessageLinkedImage(evalContext *alerting.EvalContext) *m.SendWebhookSync {
  87. message := fmt.Sprintf("<b>%s</b>\nState: %s\nMessage: %s\n", evalContext.GetNotificationTitle(), evalContext.Rule.Name, evalContext.Rule.Message)
  88. ruleUrl, err := evalContext.GetRuleUrl()
  89. if err == nil {
  90. message = message + fmt.Sprintf("URL: %s\n", ruleUrl)
  91. }
  92. if evalContext.ImagePublicUrl != "" {
  93. message = message + fmt.Sprintf("Image: %s\n", evalContext.ImagePublicUrl)
  94. }
  95. metrics := generateMetricsMessage(evalContext)
  96. if metrics != "" {
  97. message = message + fmt.Sprintf("\n<i>Metrics:</i>%s", metrics)
  98. }
  99. cmd := this.generateTelegramCmd(message, "text", "sendMessage", func(w *multipart.Writer) {
  100. fw, _ := w.CreateFormField("parse_mode")
  101. fw.Write([]byte("html"))
  102. })
  103. return cmd
  104. }
  105. func (this *TelegramNotifier) buildMessageInlineImage(evalContext *alerting.EvalContext) (*m.SendWebhookSync, error) {
  106. var imageFile *os.File
  107. var err error
  108. imageFile, err = os.Open(evalContext.ImageOnDiskPath)
  109. defer func() {
  110. err := imageFile.Close()
  111. if err != nil {
  112. this.log.Error("Could not close Telegram inline image.", "err", err)
  113. }
  114. }()
  115. if err != nil {
  116. return nil, err
  117. }
  118. ruleUrl, err := evalContext.GetRuleUrl()
  119. if err != nil {
  120. return nil, err
  121. }
  122. metrics := generateMetricsMessage(evalContext)
  123. message := generateImageCaption(evalContext, ruleUrl, metrics)
  124. cmd := this.generateTelegramCmd(message, "caption", "sendPhoto", func(w *multipart.Writer) {
  125. fw, _ := w.CreateFormFile("photo", evalContext.ImageOnDiskPath)
  126. io.Copy(fw, imageFile)
  127. })
  128. return cmd, nil
  129. }
  130. func (this *TelegramNotifier) generateTelegramCmd(message string, messageField string, apiAction string, extraConf func(writer *multipart.Writer)) *m.SendWebhookSync {
  131. var body bytes.Buffer
  132. w := multipart.NewWriter(&body)
  133. fw, _ := w.CreateFormField("chat_id")
  134. fw.Write([]byte(this.ChatID))
  135. fw, _ = w.CreateFormField(messageField)
  136. fw.Write([]byte(message))
  137. extraConf(w)
  138. w.Close()
  139. this.log.Info("Sending telegram notification", "chat_id", this.ChatID, "bot_token", this.BotToken, "apiAction", apiAction)
  140. url := fmt.Sprintf(telegramApiUrl, this.BotToken, apiAction)
  141. cmd := &m.SendWebhookSync{
  142. Url: url,
  143. Body: body.String(),
  144. HttpMethod: "POST",
  145. HttpHeader: map[string]string{
  146. "Content-Type": w.FormDataContentType(),
  147. },
  148. }
  149. return cmd
  150. }
  151. func generateMetricsMessage(evalContext *alerting.EvalContext) string {
  152. metrics := ""
  153. fieldLimitCount := 4
  154. for index, evt := range evalContext.EvalMatches {
  155. metrics += fmt.Sprintf("\n%s: %s", evt.Metric, evt.Value)
  156. if index > fieldLimitCount {
  157. break
  158. }
  159. }
  160. return metrics
  161. }
  162. func generateImageCaption(evalContext *alerting.EvalContext, ruleUrl string, metrics string) string {
  163. message := evalContext.GetNotificationTitle()
  164. if len(evalContext.Rule.Message) > 0 {
  165. message = fmt.Sprintf("%s\nMessage: %s", message, evalContext.Rule.Message)
  166. }
  167. if len(message) > captionLengthLimit {
  168. message = message[0:captionLengthLimit]
  169. }
  170. if len(ruleUrl) > 0 {
  171. urlLine := fmt.Sprintf("\nURL: %s", ruleUrl)
  172. message = appendIfPossible(message, urlLine, captionLengthLimit)
  173. }
  174. if metrics != "" {
  175. metricsLines := fmt.Sprintf("\n\nMetrics:%s", metrics)
  176. message = appendIfPossible(message, metricsLines, captionLengthLimit)
  177. }
  178. return message
  179. }
  180. func appendIfPossible(message string, extra string, sizeLimit int) string {
  181. if len(extra)+len(message) <= sizeLimit {
  182. return message + extra
  183. }
  184. log.Debug("Line too long for image caption. value: %s", extra)
  185. return message
  186. }
  187. func (this *TelegramNotifier) Notify(evalContext *alerting.EvalContext) error {
  188. var cmd *m.SendWebhookSync
  189. if evalContext.ImagePublicUrl == "" && this.UploadImage {
  190. cmd = this.buildMessage(evalContext, true)
  191. } else {
  192. cmd = this.buildMessage(evalContext, false)
  193. }
  194. if err := bus.DispatchCtx(evalContext.Ctx, cmd); err != nil {
  195. this.log.Error("Failed to send webhook", "error", err, "webhook", this.Name)
  196. return err
  197. }
  198. return nil
  199. }