webhook.go 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. package notifiers
  2. import (
  3. "github.com/grafana/grafana/pkg/bus"
  4. "github.com/grafana/grafana/pkg/components/simplejson"
  5. "github.com/grafana/grafana/pkg/infra/log"
  6. "github.com/grafana/grafana/pkg/models"
  7. "github.com/grafana/grafana/pkg/services/alerting"
  8. )
  9. func init() {
  10. alerting.RegisterNotifier(&alerting.NotifierPlugin{
  11. Type: "webhook",
  12. Name: "webhook",
  13. Description: "Sends HTTP POST request to a URL",
  14. Factory: NewWebHookNotifier,
  15. OptionsTemplate: `
  16. <h3 class="page-heading">Webhook settings</h3>
  17. <div class="gf-form">
  18. <span class="gf-form-label width-10">Url</span>
  19. <input type="text" required class="gf-form-input max-width-26" ng-model="ctrl.model.settings.url"></input>
  20. </div>
  21. <div class="gf-form">
  22. <span class="gf-form-label width-10">Http Method</span>
  23. <div class="gf-form-select-wrapper width-14">
  24. <select class="gf-form-input" ng-model="ctrl.model.settings.httpMethod" ng-options="t for t in ['POST', 'PUT']">
  25. </select>
  26. </div>
  27. </div>
  28. <div class="gf-form">
  29. <span class="gf-form-label width-10">Username</span>
  30. <input type="text" class="gf-form-input max-width-14" ng-model="ctrl.model.settings.username"></input>
  31. </div>
  32. <div class="gf-form">
  33. <span class="gf-form-label width-10">Password</span>
  34. <input type="text" class="gf-form-input max-width-14" ng-model="ctrl.model.settings.password"></input>
  35. </div>
  36. `,
  37. })
  38. }
  39. // NewWebHookNotifier is the constructor for
  40. // the WebHook notifier.
  41. func NewWebHookNotifier(model *models.AlertNotification) (alerting.Notifier, error) {
  42. url := model.Settings.Get("url").MustString()
  43. if url == "" {
  44. return nil, alerting.ValidationError{Reason: "Could not find url property in settings"}
  45. }
  46. return &WebhookNotifier{
  47. NotifierBase: NewNotifierBase(model),
  48. URL: url,
  49. User: model.Settings.Get("username").MustString(),
  50. Password: model.Settings.Get("password").MustString(),
  51. HTTPMethod: model.Settings.Get("httpMethod").MustString("POST"),
  52. log: log.New("alerting.notifier.webhook"),
  53. }, nil
  54. }
  55. // WebhookNotifier is responsible for sending
  56. // alert notifications as webhooks.
  57. type WebhookNotifier struct {
  58. NotifierBase
  59. URL string
  60. User string
  61. Password string
  62. HTTPMethod string
  63. log log.Logger
  64. }
  65. // Notify send alert notifications as
  66. // webhook as http requests.
  67. func (wn *WebhookNotifier) Notify(evalContext *alerting.EvalContext) error {
  68. wn.log.Info("Sending webhook")
  69. bodyJSON := simplejson.New()
  70. bodyJSON.Set("title", evalContext.GetNotificationTitle())
  71. bodyJSON.Set("ruleId", evalContext.Rule.ID)
  72. bodyJSON.Set("ruleName", evalContext.Rule.Name)
  73. bodyJSON.Set("state", evalContext.Rule.State)
  74. bodyJSON.Set("evalMatches", evalContext.EvalMatches)
  75. tags := make(map[string]string)
  76. for _, tag := range evalContext.Rule.AlertRuleTags {
  77. tags[tag.Key] = tag.Value
  78. }
  79. bodyJSON.Set("tags", tags)
  80. ruleURL, err := evalContext.GetRuleURL()
  81. if err == nil {
  82. bodyJSON.Set("ruleUrl", ruleURL)
  83. }
  84. if evalContext.ImagePublicURL != "" {
  85. bodyJSON.Set("imageUrl", evalContext.ImagePublicURL)
  86. }
  87. if evalContext.Rule.Message != "" {
  88. bodyJSON.Set("message", evalContext.Rule.Message)
  89. }
  90. body, _ := bodyJSON.MarshalJSON()
  91. cmd := &models.SendWebhookSync{
  92. Url: wn.URL,
  93. User: wn.User,
  94. Password: wn.Password,
  95. Body: string(body),
  96. HttpMethod: wn.HTTPMethod,
  97. }
  98. if err := bus.DispatchCtx(evalContext.Ctx, cmd); err != nil {
  99. wn.log.Error("Failed to send webhook", "error", err, "webhook", wn.Name)
  100. return err
  101. }
  102. return nil
  103. }