webhook.go 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  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. m "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. func NewWebHookNotifier(model *m.AlertNotification) (alerting.Notifier, error) {
  40. url := model.Settings.Get("url").MustString()
  41. if url == "" {
  42. return nil, alerting.ValidationError{Reason: "Could not find url property in settings"}
  43. }
  44. return &WebhookNotifier{
  45. NotifierBase: NewNotifierBase(model),
  46. Url: url,
  47. User: model.Settings.Get("username").MustString(),
  48. Password: model.Settings.Get("password").MustString(),
  49. HttpMethod: model.Settings.Get("httpMethod").MustString("POST"),
  50. log: log.New("alerting.notifier.webhook"),
  51. }, nil
  52. }
  53. type WebhookNotifier struct {
  54. NotifierBase
  55. Url string
  56. User string
  57. Password string
  58. HttpMethod string
  59. log log.Logger
  60. }
  61. func (this *WebhookNotifier) Notify(evalContext *alerting.EvalContext) error {
  62. this.log.Info("Sending webhook")
  63. bodyJSON := simplejson.New()
  64. bodyJSON.Set("title", evalContext.GetNotificationTitle())
  65. bodyJSON.Set("ruleId", evalContext.Rule.Id)
  66. bodyJSON.Set("ruleName", evalContext.Rule.Name)
  67. bodyJSON.Set("state", evalContext.Rule.State)
  68. bodyJSON.Set("evalMatches", evalContext.EvalMatches)
  69. ruleUrl, err := evalContext.GetRuleUrl()
  70. if err == nil {
  71. bodyJSON.Set("ruleUrl", ruleUrl)
  72. }
  73. if evalContext.ImagePublicUrl != "" {
  74. bodyJSON.Set("imageUrl", evalContext.ImagePublicUrl)
  75. }
  76. if evalContext.Rule.Message != "" {
  77. bodyJSON.Set("message", evalContext.Rule.Message)
  78. }
  79. body, _ := bodyJSON.MarshalJSON()
  80. cmd := &m.SendWebhookSync{
  81. Url: this.Url,
  82. User: this.User,
  83. Password: this.Password,
  84. Body: string(body),
  85. HttpMethod: this.HttpMethod,
  86. }
  87. if err := bus.DispatchCtx(evalContext.Ctx, cmd); err != nil {
  88. this.log.Error("Failed to send webhook", "error", err, "webhook", this.Name)
  89. return err
  90. }
  91. return nil
  92. }