mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Add Microsoft Teams notifier
This commit is contained in:
123
pkg/services/alerting/notifiers/teams.go
Normal file
123
pkg/services/alerting/notifiers/teams.go
Normal file
@@ -0,0 +1,123 @@
|
|||||||
|
package notifiers
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
|
||||||
|
"github.com/grafana/grafana/pkg/bus"
|
||||||
|
"github.com/grafana/grafana/pkg/log"
|
||||||
|
m "github.com/grafana/grafana/pkg/models"
|
||||||
|
"github.com/grafana/grafana/pkg/services/alerting"
|
||||||
|
)
|
||||||
|
|
||||||
|
func init() {
|
||||||
|
alerting.RegisterNotifier(&alerting.NotifierPlugin{
|
||||||
|
Type: "teams",
|
||||||
|
Name: "Microsoft Teams",
|
||||||
|
Description: "Sends notifications using Incomming Webhook connector to Microsoft Teams",
|
||||||
|
Factory: NewTeamsNotifier,
|
||||||
|
OptionsTemplate: `
|
||||||
|
<h3 class="page-heading">Teams settings</h3>
|
||||||
|
<div class="gf-form max-width-30">
|
||||||
|
<span class="gf-form-label width-6">Url</span>
|
||||||
|
<input type="text" required class="gf-form-input max-width-30" ng-model="ctrl.model.settings.url" placeholder="Teams incoming webhook url"></input>
|
||||||
|
</div>
|
||||||
|
`,
|
||||||
|
})
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewTeamsNotifier(model *m.AlertNotification) (alerting.Notifier, error) {
|
||||||
|
url := model.Settings.Get("url").MustString()
|
||||||
|
if url == "" {
|
||||||
|
return nil, alerting.ValidationError{Reason: "Could not find url property in settings"}
|
||||||
|
}
|
||||||
|
|
||||||
|
return &TeamsNotifier{
|
||||||
|
NotifierBase: NewNotifierBase(model.Id, model.IsDefault, model.Name, model.Type, model.Settings),
|
||||||
|
Url: url,
|
||||||
|
log: log.New("alerting.notifier.teams"),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type TeamsNotifier struct {
|
||||||
|
NotifierBase
|
||||||
|
Url string
|
||||||
|
Recipient string
|
||||||
|
Mention string
|
||||||
|
log log.Logger
|
||||||
|
}
|
||||||
|
|
||||||
|
func (this *TeamsNotifier) Notify(evalContext *alerting.EvalContext) error {
|
||||||
|
this.log.Info("Executing teams notification", "ruleId", evalContext.Rule.Id, "notification", this.Name)
|
||||||
|
|
||||||
|
ruleUrl, err := evalContext.GetRuleUrl()
|
||||||
|
if err != nil {
|
||||||
|
this.log.Error("Failed get rule link", "error", err)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
fields := make([]map[string]interface{}, 0)
|
||||||
|
fieldLimitCount := 4
|
||||||
|
for index, evt := range evalContext.EvalMatches {
|
||||||
|
fields = append(fields, map[string]interface{}{
|
||||||
|
"name": evt.Metric,
|
||||||
|
"value": evt.Value,
|
||||||
|
})
|
||||||
|
if index > fieldLimitCount {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if evalContext.Error != nil {
|
||||||
|
fields = append(fields, map[string]interface{}{
|
||||||
|
"name": "Error message",
|
||||||
|
"value": evalContext.Error.Error(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
message := this.Mention
|
||||||
|
if evalContext.Rule.State != m.AlertStateOK { //dont add message when going back to alert state ok.
|
||||||
|
message += " " + evalContext.Rule.Message
|
||||||
|
}
|
||||||
|
|
||||||
|
body := map[string]interface{}{
|
||||||
|
"@type": "MessageCard",
|
||||||
|
"@context": "http://schema.org/extensions",
|
||||||
|
"summary": message,
|
||||||
|
"title": evalContext.GetNotificationTitle(),
|
||||||
|
"themeColor": evalContext.GetStateModel().Color,
|
||||||
|
"sections": []map[string]interface{}{
|
||||||
|
{
|
||||||
|
"title": "Details",
|
||||||
|
"facts": fields,
|
||||||
|
"images": []map[string]interface{}{
|
||||||
|
{
|
||||||
|
"image": evalContext.ImagePublicUrl,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"text": message,
|
||||||
|
"potentialAction": []map[string]interface{}{
|
||||||
|
{
|
||||||
|
"@context": "http://schema.org",
|
||||||
|
"@type": "ViewAction",
|
||||||
|
"name": "View Rule",
|
||||||
|
"target": []string{
|
||||||
|
ruleUrl,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
data, _ := json.Marshal(&body)
|
||||||
|
print(string(data))
|
||||||
|
cmd := &m.SendWebhookSync{Url: this.Url, Body: string(data)}
|
||||||
|
|
||||||
|
if err := bus.DispatchCtx(evalContext.Ctx, cmd); err != nil {
|
||||||
|
this.log.Error("Failed to send teams notification", "error", err, "webhook", this.Name)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
75
pkg/services/alerting/notifiers/teams_test.go
Normal file
75
pkg/services/alerting/notifiers/teams_test.go
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
package notifiers
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/grafana/grafana/pkg/components/simplejson"
|
||||||
|
m "github.com/grafana/grafana/pkg/models"
|
||||||
|
. "github.com/smartystreets/goconvey/convey"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestTeamsNotifier(t *testing.T) {
|
||||||
|
Convey("Teams notifier tests", t, func() {
|
||||||
|
|
||||||
|
Convey("Parsing alert notification from settings", func() {
|
||||||
|
Convey("empty settings should return error", func() {
|
||||||
|
json := `{ }`
|
||||||
|
|
||||||
|
settingsJSON, _ := simplejson.NewJson([]byte(json))
|
||||||
|
model := &m.AlertNotification{
|
||||||
|
Name: "ops",
|
||||||
|
Type: "teams",
|
||||||
|
Settings: settingsJSON,
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := NewTeamsNotifier(model)
|
||||||
|
So(err, ShouldNotBeNil)
|
||||||
|
})
|
||||||
|
|
||||||
|
Convey("from settings", func() {
|
||||||
|
json := `
|
||||||
|
{
|
||||||
|
"url": "http://google.com"
|
||||||
|
}`
|
||||||
|
|
||||||
|
settingsJSON, _ := simplejson.NewJson([]byte(json))
|
||||||
|
model := &m.AlertNotification{
|
||||||
|
Name: "ops",
|
||||||
|
Type: "teams",
|
||||||
|
Settings: settingsJSON,
|
||||||
|
}
|
||||||
|
|
||||||
|
not, err := NewTeamsNotifier(model)
|
||||||
|
teamsNotifier := not.(*TeamsNotifier)
|
||||||
|
|
||||||
|
So(err, ShouldBeNil)
|
||||||
|
So(teamsNotifier.Name, ShouldEqual, "ops")
|
||||||
|
So(teamsNotifier.Type, ShouldEqual, "teams")
|
||||||
|
So(teamsNotifier.Url, ShouldEqual, "http://google.com")
|
||||||
|
})
|
||||||
|
|
||||||
|
Convey("from settings with Recipient and Mention", func() {
|
||||||
|
json := `
|
||||||
|
{
|
||||||
|
"url": "http://google.com"
|
||||||
|
}`
|
||||||
|
|
||||||
|
settingsJSON, _ := simplejson.NewJson([]byte(json))
|
||||||
|
model := &m.AlertNotification{
|
||||||
|
Name: "ops",
|
||||||
|
Type: "teams",
|
||||||
|
Settings: settingsJSON,
|
||||||
|
}
|
||||||
|
|
||||||
|
not, err := NewTeamsNotifier(model)
|
||||||
|
teamsNotifier := not.(*TeamsNotifier)
|
||||||
|
|
||||||
|
So(err, ShouldBeNil)
|
||||||
|
So(teamsNotifier.Name, ShouldEqual, "ops")
|
||||||
|
So(teamsNotifier.Type, ShouldEqual, "teams")
|
||||||
|
So(teamsNotifier.Url, ShouldEqual, "http://google.com")
|
||||||
|
})
|
||||||
|
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
@@ -95,6 +95,7 @@ export class AlertTabCtrl {
|
|||||||
case "hipchat": return "fa fa-mail-forward";
|
case "hipchat": return "fa fa-mail-forward";
|
||||||
case "pushover": return "fa fa-mobile";
|
case "pushover": return "fa fa-mobile";
|
||||||
case "kafka": return "fa fa-random";
|
case "kafka": return "fa fa-random";
|
||||||
|
case "teams": return "fa fa-windows";
|
||||||
}
|
}
|
||||||
return 'fa fa-bell';
|
return 'fa fa-bell';
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user