| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179 |
- package notifiers
- import (
- "encoding/json"
- "strconv"
- "strings"
- "fmt"
- "github.com/grafana/grafana/pkg/bus"
- "github.com/grafana/grafana/pkg/infra/log"
- "github.com/grafana/grafana/pkg/models"
- "github.com/grafana/grafana/pkg/services/alerting"
- )
- func init() {
- alerting.RegisterNotifier(&alerting.NotifierPlugin{
- Type: "hipchat",
- Name: "HipChat",
- Description: "Sends notifications uto a HipChat Room",
- Factory: NewHipChatNotifier,
- OptionsTemplate: `
- <h3 class="page-heading">HipChat settings</h3>
- <div class="gf-form max-width-30">
- <span class="gf-form-label width-8">Hip Chat Url</span>
- <input type="text" required class="gf-form-input max-width-30" ng-model="ctrl.model.settings.url" placeholder="HipChat URL (ex https://grafana.hipchat.com)"></input>
- </div>
- <div class="gf-form max-width-30">
- <span class="gf-form-label width-8">API Key</span>
- <input type="text" required class="gf-form-input max-width-30" ng-model="ctrl.model.settings.apikey" placeholder="HipChat API Key"></input>
- </div>
- <div class="gf-form max-width-30">
- <span class="gf-form-label width-8">Room ID</span>
- <input type="text"
- class="gf-form-input max-width-30"
- ng-model="ctrl.model.settings.roomid"
- data-placement="right">
- </input>
- </div>
- `,
- })
- }
- const (
- maxFieldCount int = 4
- )
- // NewHipChatNotifier is the constructor functions
- // for the HipChatNotifier
- func NewHipChatNotifier(model *models.AlertNotification) (alerting.Notifier, error) {
- url := model.Settings.Get("url").MustString()
- if strings.HasSuffix(url, "/") {
- url = url[:len(url)-1]
- }
- if url == "" {
- return nil, alerting.ValidationError{Reason: "Could not find url property in settings"}
- }
- apikey := model.Settings.Get("apikey").MustString()
- roomID := model.Settings.Get("roomid").MustString()
- return &HipChatNotifier{
- NotifierBase: NewNotifierBase(model),
- URL: url,
- APIKey: apikey,
- RoomID: roomID,
- log: log.New("alerting.notifier.hipchat"),
- }, nil
- }
- // HipChatNotifier is responsible for sending
- // alert notifications to Hipchat.
- type HipChatNotifier struct {
- NotifierBase
- URL string
- APIKey string
- RoomID string
- log log.Logger
- }
- // Notify sends an alert notification to HipChat
- func (hc *HipChatNotifier) Notify(evalContext *alerting.EvalContext) error {
- hc.log.Info("Executing hipchat notification", "ruleId", evalContext.Rule.ID, "notification", hc.Name)
- ruleURL, err := evalContext.GetRuleURL()
- if err != nil {
- hc.log.Error("Failed get rule link", "error", err)
- return err
- }
- attributes := make([]map[string]interface{}, 0)
- for index, evt := range evalContext.EvalMatches {
- metricName := evt.Metric
- if len(metricName) > 50 {
- metricName = metricName[:50]
- }
- attributes = append(attributes, map[string]interface{}{
- "label": metricName,
- "value": map[string]interface{}{
- "label": strconv.FormatFloat(evt.Value.Float64, 'f', -1, 64),
- },
- })
- if index > maxFieldCount {
- break
- }
- }
- if evalContext.Error != nil {
- attributes = append(attributes, map[string]interface{}{
- "label": "Error message",
- "value": map[string]interface{}{
- "label": evalContext.Error.Error(),
- },
- })
- }
- message := ""
- if evalContext.Rule.State != models.AlertStateOK { //don't add message when going back to alert state ok.
- message += " " + evalContext.Rule.Message
- }
- if message == "" {
- message = evalContext.GetNotificationTitle() + " in state " + evalContext.GetStateModel().Text
- }
- //HipChat has a set list of colors
- var color string
- switch evalContext.Rule.State {
- case models.AlertStateOK:
- color = "green"
- case models.AlertStateNoData:
- color = "gray"
- case models.AlertStateAlerting:
- color = "red"
- }
- // Add a card with link to the dashboard
- card := map[string]interface{}{
- "style": "application",
- "url": ruleURL,
- "id": "1",
- "title": evalContext.GetNotificationTitle(),
- "description": message,
- "icon": map[string]interface{}{
- "url": "https://grafana.com/assets/img/fav32.png",
- },
- "date": evalContext.EndTime.Unix(),
- "attributes": attributes,
- }
- if evalContext.ImagePublicURL != "" {
- card["thumbnail"] = map[string]interface{}{
- "url": evalContext.ImagePublicURL,
- "url@2x": evalContext.ImagePublicURL,
- "width": 1193,
- "height": 564,
- }
- }
- body := map[string]interface{}{
- "message": message,
- "notify": "true",
- "message_format": "html",
- "color": color,
- "card": card,
- }
- hipURL := fmt.Sprintf("%s/v2/room/%s/notification?auth_token=%s", hc.URL, hc.RoomID, hc.APIKey)
- data, _ := json.Marshal(&body)
- hc.log.Info("Request payload", "json", string(data))
- cmd := &models.SendWebhookSync{Url: hipURL, Body: string(data)}
- if err := bus.DispatchCtx(evalContext.Ctx, cmd); err != nil {
- hc.log.Error("Failed to send hipchat notification", "error", err, "webhook", hc.Name)
- return err
- }
- return nil
- }
|