dingding.go 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. package notifiers
  2. import (
  3. "fmt"
  4. "net/url"
  5. "strings"
  6. "github.com/grafana/grafana/pkg/bus"
  7. "github.com/grafana/grafana/pkg/components/simplejson"
  8. "github.com/grafana/grafana/pkg/infra/log"
  9. "github.com/grafana/grafana/pkg/models"
  10. "github.com/grafana/grafana/pkg/services/alerting"
  11. )
  12. const defaultDingdingMsgType = "link"
  13. const dingdingOptionsTemplate = `
  14. <h3 class="page-heading">DingDing settings</h3>
  15. <div class="gf-form">
  16. <span class="gf-form-label width-10">Url</span>
  17. <input type="text" required class="gf-form-input max-width-70" ng-model="ctrl.model.settings.url" placeholder="https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxxx"></input>
  18. </div>
  19. <div class="gf-form">
  20. <span class="gf-form-label width-10">MessageType</span>
  21. <select class="gf-form-input max-width-14" ng-model="ctrl.model.settings.msgType" ng-options="s for s in ['link','actionCard']" ng-init="ctrl.model.settings.msgType=ctrl.model.settings.msgType || '` + defaultDingdingMsgType + `'"></select>
  22. </div>
  23. `
  24. func init() {
  25. alerting.RegisterNotifier(&alerting.NotifierPlugin{
  26. Type: "dingding",
  27. Name: "DingDing",
  28. Description: "Sends HTTP POST request to DingDing",
  29. Factory: newDingDingNotifier,
  30. OptionsTemplate: dingdingOptionsTemplate,
  31. })
  32. }
  33. func newDingDingNotifier(model *models.AlertNotification) (alerting.Notifier, error) {
  34. url := model.Settings.Get("url").MustString()
  35. if url == "" {
  36. return nil, alerting.ValidationError{Reason: "Could not find url property in settings"}
  37. }
  38. msgType := model.Settings.Get("msgType").MustString(defaultDingdingMsgType)
  39. return &DingDingNotifier{
  40. NotifierBase: NewNotifierBase(model),
  41. MsgType: msgType,
  42. URL: url,
  43. log: log.New("alerting.notifier.dingding"),
  44. }, nil
  45. }
  46. // DingDingNotifier is responsible for sending alert notifications to ding ding.
  47. type DingDingNotifier struct {
  48. NotifierBase
  49. MsgType string
  50. URL string
  51. log log.Logger
  52. }
  53. // Notify sends the alert notification to dingding.
  54. func (dd *DingDingNotifier) Notify(evalContext *alerting.EvalContext) error {
  55. dd.log.Info("Sending dingding")
  56. messageURL, err := evalContext.GetRuleURL()
  57. if err != nil {
  58. dd.log.Error("Failed to get messageUrl", "error", err, "dingding", dd.Name)
  59. messageURL = ""
  60. }
  61. q := url.Values{
  62. "pc_slide": {"false"},
  63. "url": {messageURL},
  64. }
  65. // Use special link to auto open the message url outside of Dingding
  66. // Refer: https://open-doc.dingtalk.com/docs/doc.htm?treeId=385&articleId=104972&docType=1#s9
  67. messageURL = "dingtalk://dingtalkclient/page/link?" + q.Encode()
  68. dd.log.Info("messageUrl:" + messageURL)
  69. message := evalContext.Rule.Message
  70. picURL := evalContext.ImagePublicURL
  71. title := evalContext.GetNotificationTitle()
  72. if message == "" {
  73. message = title
  74. }
  75. for i, match := range evalContext.EvalMatches {
  76. message += fmt.Sprintf("\\n%2d. %s: %s", i+1, match.Metric, match.Value)
  77. }
  78. var bodyStr string
  79. if dd.MsgType == "actionCard" {
  80. // Embed the pic into the markdown directly because actionCard doesn't have a picUrl field
  81. if picURL != "" {
  82. message = "![](" + picURL + ")\\n\\n" + message
  83. }
  84. bodyStr = `{
  85. "msgtype": "actionCard",
  86. "actionCard": {
  87. "text": "` + strings.Replace(message, `"`, "'", -1) + `",
  88. "title": "` + strings.Replace(title, `"`, "'", -1) + `",
  89. "singleTitle": "More",
  90. "singleURL": "` + messageURL + `"
  91. }
  92. }`
  93. } else {
  94. bodyStr = `{
  95. "msgtype": "link",
  96. "link": {
  97. "text": "` + message + `",
  98. "title": "` + title + `",
  99. "picUrl": "` + picURL + `",
  100. "messageUrl": "` + messageURL + `"
  101. }
  102. }`
  103. }
  104. bodyJSON, err := simplejson.NewJson([]byte(bodyStr))
  105. if err != nil {
  106. dd.log.Error("Failed to create Json data", "error", err, "dingding", dd.Name)
  107. }
  108. body, err := bodyJSON.MarshalJSON()
  109. if err != nil {
  110. return err
  111. }
  112. cmd := &models.SendWebhookSync{
  113. Url: dd.URL,
  114. Body: string(body),
  115. }
  116. if err := bus.DispatchCtx(evalContext.Ctx, cmd); err != nil {
  117. dd.log.Error("Failed to send DingDing", "error", err, "dingding", dd.Name)
  118. return err
  119. }
  120. return nil
  121. }