Skip to content

N
nexpie-grafana-theme
Commit b8f559ae by Torkel Ödegaard
Options

feat(plugins): made notifiers more pluggable and easier to support many of them,… 

feat(plugins): made notifiers more pluggable and easier to support many of them, new ones can now be added without modifying any existing file, #7162
parent d6a24317
Showing with 245 additions and 174 deletions
pkg/api/alerting.go
...@@ -172,6 +172,10 @@ func DelAlert(c *middleware.Context) Response { ...@@ -172,6 +172,10 @@ func DelAlert(c *middleware.Context) Response {
return Json(200, resp) return Json(200, resp)
} }
func GetAlertNotifiers(c *middleware.Context) Response {
return Json(200, alerting.GetNotifiers())
}
func GetAlertNotifications(c *middleware.Context) Response { func GetAlertNotifications(c *middleware.Context) Response {
query := &models.GetAllAlertNotificationsQuery{OrgId: c.OrgId} query := &models.GetAllAlertNotificationsQuery{OrgId: c.OrgId}
......
pkg/api/api.go
...@@ -262,6 +262,7 @@ func Register(r *macaron.Macaron) { ...@@ -262,6 +262,7 @@ func Register(r *macaron.Macaron) {
}) })
r.Get("/alert-notifications", wrap(GetAlertNotifications)) r.Get("/alert-notifications", wrap(GetAlertNotifications))
r.Get("/alert-notifiers", wrap(GetAlertNotifiers))
r.Group("/alert-notifications", func() { r.Group("/alert-notifications", func() {
r.Post("/test", bind(dtos.NotificationTestCommand{}), wrap(NotificationTest)) r.Post("/test", bind(dtos.NotificationTestCommand{}), wrap(NotificationTest))
......
pkg/api/index.go
...@@ -106,7 +106,7 @@ func setIndexViewData(c *middleware.Context) (*dtos.IndexViewData, error) { ...@@ -106,7 +106,7 @@ func setIndexViewData(c *middleware.Context) (*dtos.IndexViewData, error) {
if c.OrgRole == m.ROLE_ADMIN || c.OrgRole == m.ROLE_EDITOR { if c.OrgRole == m.ROLE_ADMIN || c.OrgRole == m.ROLE_EDITOR {
alertChildNavs := []*dtos.NavLink{ alertChildNavs := []*dtos.NavLink{
{Text: "Alert List", Url: setting.AppSubUrl + "/alerting/list"}, {Text: "Alert List", Url: setting.AppSubUrl + "/alerting/list"},
{Text: "Notifications", Url: setting.AppSubUrl + "/alerting/notifications"}, {Text: "Notification channels", Url: setting.AppSubUrl + "/alerting/notifications"},
} }
data.MainNavLinks = append(data.MainNavLinks, &dtos.NavLink{ data.MainNavLinks = append(data.MainNavLinks, &dtos.NavLink{
......
pkg/services/alerting/notifier.go
...@@ -13,6 +13,14 @@ import ( ...@@ -13,6 +13,14 @@ import (
m "github.com/grafana/grafana/pkg/models" m "github.com/grafana/grafana/pkg/models"
) )
type NotifierPlugin struct {
Type string `json:"type"`
Name string `json:"name"`
Description string `json:"description"`
OptionsTemplate string `json:"optionsTemplate"`
Factory NotifierFactory `json:"-"`
}
type RootNotifier struct { type RootNotifier struct {
log log.Logger log log.Logger
} }
...@@ -130,12 +138,12 @@ func (n *RootNotifier) getNotifiers(orgId int64, notificationIds []int64, contex ...@@ -130,12 +138,12 @@ func (n *RootNotifier) getNotifiers(orgId int64, notificationIds []int64, contex
} }
func (n *RootNotifier) createNotifierFor(model *m.AlertNotification) (Notifier, error) { func (n *RootNotifier) createNotifierFor(model *m.AlertNotification) (Notifier, error) {
factory, found := notifierFactories[model.Type] notifierPlugin, found := notifierFactories[model.Type]
if !found { if !found {
return nil, errors.New("Unsupported notification type") return nil, errors.New("Unsupported notification type")
} }
return factory(model) return notifierPlugin.Factory(model)
} }
func shouldUseNotification(notifier Notifier, context *EvalContext) bool { func shouldUseNotification(notifier Notifier, context *EvalContext) bool {
...@@ -152,8 +160,18 @@ func shouldUseNotification(notifier Notifier, context *EvalContext) bool { ...@@ -152,8 +160,18 @@ func shouldUseNotification(notifier Notifier, context *EvalContext) bool {
type NotifierFactory func(notification *m.AlertNotification) (Notifier, error) type NotifierFactory func(notification *m.AlertNotification) (Notifier, error)
var notifierFactories map[string]NotifierFactory = make(map[string]NotifierFactory) var notifierFactories map[string]*NotifierPlugin = make(map[string]*NotifierPlugin)
func RegisterNotifier(plugin *NotifierPlugin) {
notifierFactories[plugin.Type] = plugin
}
func GetNotifiers() []*NotifierPlugin {
list := make([]*NotifierPlugin, 0)
for _, value := range notifierFactories {
list = append(list, value)
}
func RegisterNotifier(typeName string, factory NotifierFactory) { return list
notifierFactories[typeName] = factory
} }
pkg/services/alerting/notifiers/email.go
...@@ -13,7 +13,21 @@ import ( ...@@ -13,7 +13,21 @@ import (
) )
func init() { func init() {
alerting.RegisterNotifier("email", NewEmailNotifier) alerting.RegisterNotifier(&alerting.NotifierPlugin{
Type: "email",
Name: "Email",
Description: "Sends notifications using Grafana server configured STMP settings",
Factory: NewEmailNotifier,
OptionsTemplate: `
<h3 class="page-heading">Email addresses</h3>
<div class="gf-form">
<textarea rows="7" class="gf-form-input width-25" required ng-model="ctrl.model.settings.addresses"></textarea>
</div>
<div class="gf-form">
<span>You can enter multiple email addresses using a ";" separator</span>
</div>
`,
})
} }
type EmailNotifier struct { type EmailNotifier struct {
......
pkg/services/alerting/notifiers/opsgenie.go
...@@ -13,7 +13,28 @@ import ( ...@@ -13,7 +13,28 @@ import (
) )
func init() { func init() {
alerting.RegisterNotifier("opsgenie", NewOpsGenieNotifier) alerting.RegisterNotifier(&alerting.NotifierPlugin{
Type: "opsgenie",
Name: "OpsGenie",
Description: "Sends notifications to OpsGenie",
Factory: NewOpsGenieNotifier,
OptionsTemplate: `
<h3 class="page-heading">OpsGenie settings</h3>
<div class="gf-form">
<span class="gf-form-label width-14">API Key</span>
<input type="text" required class="gf-form-input max-width-22" ng-model="ctrl.model.settings.apiKey" placeholder="OpsGenie API Key"></input>
</div>
<div class="gf-form">
<gf-form-switch
class="gf-form"
label="Auto close incidents"
label-class="width-14"
checked="ctrl.model.settings.autoClose"
tooltip="Automatically close alerts in OpseGenie once the alert goes back to ok.">
</gf-form-switch>
</div>
`,
})
} }
var ( var (
......
pkg/services/alerting/notifiers/pagerduty.go
...@@ -12,7 +12,28 @@ import ( ...@@ -12,7 +12,28 @@ import (
) )
func init() { func init() {
alerting.RegisterNotifier("pagerduty", NewPagerdutyNotifier) alerting.RegisterNotifier(&alerting.NotifierPlugin{
Type: "pagerduty",
Name: "PagerDuty",
Description: "Sends notifications to PagerDuty",
Factory: NewPagerdutyNotifier,
OptionsTemplate: `
<h3 class="page-heading">PagerDuty settings</h3>
<div class="gf-form">
<span class="gf-form-label width-14">Integration Key</span>
<input type="text" required class="gf-form-input max-width-22" ng-model="ctrl.model.settings.integrationKey" placeholder="Pagerduty integeration Key"></input>
</div>
<div class="gf-form">
<gf-form-switch
class="gf-form"
label="Auto resolve incidents"
label-class="width-14"
checked="ctrl.model.settings.autoResolve"
tooltip="Resolve incidents in pagerduty once the alert goes back to ok.">
</gf-form-switch>
</div>
`,
})
} }
var ( var (
......
pkg/services/alerting/notifiers/slack.go
...@@ -13,7 +13,42 @@ import ( ...@@ -13,7 +13,42 @@ import (
) )
func init() { func init() {
alerting.RegisterNotifier("slack", NewSlackNotifier) alerting.RegisterNotifier(&alerting.NotifierPlugin{
Type: "slack",
Name: "Slack",
Description: "Sends notifications using Grafana server configured STMP settings",
Factory: NewSlackNotifier,
OptionsTemplate: `
<h3 class="page-heading">Slack 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="Slack incoming webhook url"></input>
</div>
<div class="gf-form max-width-30">
<span class="gf-form-label width-6">Recipient</span>
<input type="text"
class="gf-form-input max-width-30"
ng-model="ctrl.model.settings.recipient"
data-placement="right">
</input>
<info-popover mode="right-absolute">
Override default channel or user, use #channel-name or @username
</info-popover>
</div>
<div class="gf-form max-width-30">
<span class="gf-form-label width-6">Mention</span>
<input type="text"
class="gf-form-input max-width-30"
ng-model="ctrl.model.settings.mention"
data-placement="right">
</input>
<info-popover mode="right-absolute">
Mention a user or a group using @ when notifying in a channel
</info-popover>
</div>
`,
})
} }
func NewSlackNotifier(model *m.AlertNotification) (alerting.Notifier, error) { func NewSlackNotifier(model *m.AlertNotification) (alerting.Notifier, error) {
......
pkg/services/alerting/notifiers/telegram.go
...@@ -16,7 +16,34 @@ var ( ...@@ -16,7 +16,34 @@ var (
) )
func init() { func init() {
alerting.RegisterNotifier("telegram", NewTelegramNotifier) alerting.RegisterNotifier(&alerting.NotifierPlugin{
Type: "telegram",
Name: "Telegram",
Description: "Sends notifications to Telegram",
Factory: NewOpsGenieNotifier,
OptionsTemplate: `
<h3 class="page-heading">Telegram API settings</h3>
<div class="gf-form">
<span class="gf-form-label width-9">BOT API Token</span>
<input type="text" required
class="gf-form-input"
ng-model="ctrl.model.settings.bottoken"
placeholder="Telegram BOT API Token"></input>
</div>
<div class="gf-form">
<span class="gf-form-label width-9">Chat ID</span>
<input type="text" required
class="gf-form-input"
ng-model="ctrl.model.settings.chatid"
data-placement="right">
</input>
<info-popover mode="right-absolute">
Integer Telegram Chat Identifier
</info-popover>
</div>
`,
})
} }
type TelegramNotifier struct { type TelegramNotifier struct {
......
pkg/services/alerting/notifiers/victorops.go
...@@ -16,7 +16,19 @@ import ( ...@@ -16,7 +16,19 @@ import (
const AlertStateCritical = "CRITICAL" const AlertStateCritical = "CRITICAL"
func init() { func init() {
alerting.RegisterNotifier("victorops", NewVictoropsNotifier) alerting.RegisterNotifier(&alerting.NotifierPlugin{
Type: "victorops",
Name: "VictorOps",
Description: "Sends notifications to VictorOps",
Factory: NewVictoropsNotifier,
OptionsTemplate: `
<h3 class="page-heading">VictorOps settings</h3>
<div class="gf-form">
<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="VictorOps url"></input>
</div>
`,
})
} }
// NewVictoropsNotifier creates an instance of VictoropsNotifier that // NewVictoropsNotifier creates an instance of VictoropsNotifier that
......
pkg/services/alerting/notifiers/webhook.go
...@@ -10,7 +10,35 @@ import ( ...@@ -10,7 +10,35 @@ import (
) )
func init() { func init() {
alerting.RegisterNotifier("webhook", NewWebHookNotifier) alerting.RegisterNotifier(&alerting.NotifierPlugin{
Type: "webhook",
Name: "webhook",
Description: "Sends HTTP POST request to a URL",
Factory: NewWebHookNotifier,
OptionsTemplate: `
<h3 class="page-heading">Webhook settings</h3>
<div class="gf-form">
<span class="gf-form-label width-10">Url</span>
<input type="text" required class="gf-form-input max-width-26" ng-model="ctrl.model.settings.url"></input>
</div>
<div class="gf-form">
<span class="gf-form-label width-10">Http Method</span>
<div class="gf-form-select-wrapper width-14">
<select class="gf-form-input" ng-model="ctrl.model.settings.httpMethod" ng-options="t for t in ['POST', 'PUT']">
</select>
</div>
</div>
<div class="gf-form">
<span class="gf-form-label width-10">Username</span>
<input type="text" class="gf-form-input max-width-14" ng-model="ctrl.model.settings.username"></input>
</div>
<div class="gf-form">
<span class="gf-form-label width-10">Password</span>
<input type="text" class="gf-form-input max-width-14" ng-model="ctrl.model.settings.password"></input>
</div>
`,
})
} }
func NewWebHookNotifier(model *m.AlertNotification) (alerting.Notifier, error) { func NewWebHookNotifier(model *m.AlertNotification) (alerting.Notifier, error) {
......
public/app/features/alerting/notification_edit_ctrl.ts
...@@ -2,38 +2,46 @@ ...@@ -2,38 +2,46 @@
import angular from 'angular'; import angular from 'angular';
import _ from 'lodash'; import _ from 'lodash';
import coreModule from '../../core/core_module';
import config from 'app/core/config'; import config from 'app/core/config';
import {appEvents, coreModule} from 'app/core/core';
export class AlertNotificationEditCtrl { export class AlertNotificationEditCtrl {
model: any;
theForm: any; theForm: any;
testSeverity: string = "critical"; testSeverity: string = "critical";
notifiers: any;
notifierTemplateId: string;
model: any;
defaults: any = {
type: 'email',
settings: {
httpMethod: 'POST',
autoResolve: true,
},
isDefault: false
};
/** @ngInject */ /** @ngInject */
constructor(private $routeParams, private backendSrv, private $scope, private $location) { constructor(private $routeParams, private backendSrv, private $location, private $templateCache) {
if ($routeParams.id) { this.backendSrv.get(`/api/alert-notifiers`).then(notifiers => {
this.loadNotification($routeParams.id); this.notifiers = notifiers;
} else {
this.model = {
type: 'email',
settings: {
httpMethod: 'POST',
autoResolve: true,
},
isDefault: false
};
}
}
loadNotification(id) { // add option templates
this.backendSrv.get(`/api/alert-notifications/${id}`).then(result => { for (let notifier of this.notifiers) {
this.model = result; this.$templateCache.put(this.getNotifierTemplateId(notifier.type), notifier.optionsTemplate);
}); }
}
isNew() { if (!this.$routeParams.id) {
return this.model.id === undefined; return this.model;
}
return this.backendSrv.get(`/api/alert-notifications/${this.$routeParams.id}`).then(result => {
return result;
});
}).then(model => {
this.model = model;
this.notifierTemplateId = this.getNotifierTemplateId(this.model.type);
});
} }
save() { save() {
...@@ -44,18 +52,23 @@ export class AlertNotificationEditCtrl { ...@@ -44,18 +52,23 @@ export class AlertNotificationEditCtrl {
if (this.model.id) { if (this.model.id) {
this.backendSrv.put(`/api/alert-notifications/${this.model.id}`, this.model).then(res => { this.backendSrv.put(`/api/alert-notifications/${this.model.id}`, this.model).then(res => {
this.model = res; this.model = res;
this.$scope.appEvent('alert-success', ['Notification updated', '']); appEvents.emit('alert-success', ['Notification updated', '']);
}); });
} else { } else {
this.backendSrv.post(`/api/alert-notifications`, this.model).then(res => { this.backendSrv.post(`/api/alert-notifications`, this.model).then(res => {
this.$scope.appEvent('alert-success', ['Notification created', '']); appEvents.emit('alert-success', ['Notification created', '']);
this.$location.path('alerting/notifications'); this.$location.path('alerting/notifications');
}); });
} }
} }
getNotifierTemplateId(type) {
return `notifier-options-${type}`;
}
typeChanged() { typeChanged() {
this.model.settings = {}; this.model.settings = {};
this.notifierTemplateId = this.getNotifierTemplateId(this.model.type);
} }
testNotification() { testNotification() {
...@@ -70,9 +83,9 @@ export class AlertNotificationEditCtrl { ...@@ -70,9 +83,9 @@ export class AlertNotificationEditCtrl {
}; };
this.backendSrv.post(`/api/alert-notifications/test`, payload) this.backendSrv.post(`/api/alert-notifications/test`, payload)
.then(res => { .then(res => {
this.$scope.appEvent('alert-succes', ['Test notification sent', '']); appEvents.emit('alert-succes', ['Test notification sent', '']);
}); });
} }
} }
......
public/app/features/alerting/partials/notification_edit.html
<navbar icon="icon-gf icon-gf-alert" title="Alerting" title-url="alerting"> <navbar icon="icon-gf icon-gf-alert" title="Alerting" title-url="alerting">
<a href="alerting/notifications" class="navbar-page-btn"> <a href="alerting/notifications" class="navbar-page-btn">
<i class="fa fa-fw fa-envelope-o"></i> <i class="fa fa-fw fa-rss"></i>
Notifications Notification channels
</a> </a>
</navbar> </navbar>
<div class="page-container" > <div class="page-container">
<div class="page-header"> <div class="page-header">
<h1>Alert notification</h1> <h1 ng-show="ctrl.model.id">Edit Channel</h1>
<h1 ng-show="!ctrl.model.id">New Channel</h1>
</div> </div>
<form name="ctrl.theForm"> <form name="ctrl.theForm" ng-if="ctrl.notifiers">
<div class="gf-form-group"> <div class="gf-form-group">
<div class="gf-form"> <div class="gf-form">
<span class="gf-form-label width-12">Name</span> <span class="gf-form-label width-12">Name</span>
...@@ -19,7 +20,7 @@ ...@@ -19,7 +20,7 @@
<div class="gf-form"> <div class="gf-form">
<span class="gf-form-label width-12">Type</span> <span class="gf-form-label width-12">Type</span>
<div class="gf-form-select-wrapper width-15"> <div class="gf-form-select-wrapper width-15">
<select class="gf-form-input" ng-model="ctrl.model.type" ng-options="t for t in ['webhook', 'email', 'slack', 'pagerduty', 'victorops', 'opsgenie', 'telegram']" ng-change="ctrl.typeChanged(notification, $index)"> <select class="gf-form-input" ng-model="ctrl.model.type" ng-options="t.type as t.name for t in ctrl.notifiers" ng-change="ctrl.typeChanged(notification, $index)">
</select> </select>
</div> </div>
</div> </div>
...@@ -34,131 +35,7 @@ ...@@ -34,131 +35,7 @@
</div> </div>
</div> </div>
<div class="gf-form-group" ng-if="ctrl.model.type === 'webhook'"> <div class="gf-form-group" ng-include src="ctrl.notifierTemplateId">
<h3 class="page-heading">Webhook settings</h3>
<div class="gf-form">
<span class="gf-form-label width-10">Url</span>
<input type="text" required class="gf-form-input max-width-26" ng-model="ctrl.model.settings.url"></input>
</div>
<div class="gf-form">
<span class="gf-form-label width-10">Http Method</span>
<div class="gf-form-select-wrapper width-14">
<select class="gf-form-input" ng-model="ctrl.model.settings.httpMethod" ng-options="t for t in ['POST', 'PUT']">
</select>
</div>
</div>
<div class="gf-form">
<span class="gf-form-label width-10">Username</span>
<input type="text" class="gf-form-input max-width-14" ng-model="ctrl.model.settings.username"></input>
</div>
<div class="gf-form">
<span class="gf-form-label width-10">Password</span>
<input type="text" class="gf-form-input max-width-14" ng-model="ctrl.model.settings.password"></input>
</div>
</div>
<div class="gf-form-group" ng-if="ctrl.model.type === 'slack'">
<h3 class="page-heading">Slack 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="Slack incoming webhook url"></input>
</div>
<div class="gf-form max-width-30">
<span class="gf-form-label width-6">Recipient</span>
<input type="text"
class="gf-form-input max-width-30"
ng-model="ctrl.model.settings.recipient"
data-placement="right">
</input>
<info-popover mode="right-absolute">
Override default channel or user, use #channel-name or @username
</info-popover>
</div>
<div class="gf-form max-width-30">
<span class="gf-form-label width-6">Mention</span>
<input type="text"
class="gf-form-input max-width-30"
ng-model="ctrl.model.settings.mention"
data-placement="right">
</input>
<info-popover mode="right-absolute">
Mention a user or a group using @ when notifying in a channel
</info-popover>
</div>
</div>
<div class="gf-form-group" ng-if="ctrl.model.type === 'victorops'">
<h3 class="page-heading">VictorOps settings</h3>
<div class="gf-form">
<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="Victorops url"></input>
</div>
</div>
<div class="gf-form-group section" ng-if="ctrl.model.type === 'email'">
<h3 class="page-heading">Email addresses</h3>
<div class="gf-form">
<textarea rows="7" class="gf-form-input width-25" required ng-model="ctrl.model.settings.addresses"></textarea>
</div>
<div class="gf-form">
<span>You can enter multiple email addresses using a ";" separator</span>
</div>
</div>
<div class="gf-form-group" ng-if="ctrl.model.type === 'pagerduty'">
<h3 class="page-heading">Pagerduty settings</h3>
<div class="gf-form">
<span class="gf-form-label width-14">Integration Key</span>
<input type="text" required class="gf-form-input max-width-22" ng-model="ctrl.model.settings.integrationKey" placeholder="Pagerduty integeration Key"></input>
</div>
<div class="gf-form">
<gf-form-switch
class="gf-form"
label="Auto resolve incidents"
label-class="width-14"
checked="ctrl.model.settings.autoResolve"
tooltip="Resolve incidents in pagerduty once the alert goes back to ok.">
</gf-form-switch>
</div>
</div>
<div class="gf-form-group" ng-if="ctrl.model.type === 'opsgenie'">
<h3 class="page-heading">OpsGenie settings</h3>
<div class="gf-form">
<span class="gf-form-label width-14">API Key</span>
<input type="text" required class="gf-form-input max-width-22" ng-model="ctrl.model.settings.apiKey" placeholder="OpsGenie API Key"></input>
</div>
<div class="gf-form">
<gf-form-switch
class="gf-form"
label="Auto close incidents"
label-class="width-14"
checked="ctrl.model.settings.autoClose"
tooltip="Automatically close alerts in OpseGenie once the alert goes back to ok.">
</gf-form-switch>
</div>
</div>
<div class="gf-form-group" ng-if="ctrl.model.type === 'telegram'">
<h3 class="page-heading">Telegram API settings</h3>
<div class="gf-form">
<span class="gf-form-label width-14">BOT API Token</span>
<input type="text" required
class="gf-form-input"
ng-model="ctrl.model.settings.bottoken"
placeholder="Telegram BOT API Token"></input>
</div>
<div class="gf-form">
<span class="gf-form-label width-6">Chat ID</span>
<input type="text" required
class="gf-form-input"
ng-model="ctrl.model.settings.chatid"
data-placement="right">
</input>
<info-popover mode="right-absolute">
Integer Telegram Chat Identifier
</info-popover>
</div>
</div> </div>
<div class="gf-form-group"> <div class="gf-form-group">
......
public/app/features/alerting/partials/notifications_list.html
...@@ -3,10 +3,10 @@ ...@@ -3,10 +3,10 @@
<div class="page-container" > <div class="page-container" >
<div class="page-header"> <div class="page-header">
<h1>Alert notifications</h1> <h1>Notification channels</h1>
<a href="alerting/notification/new" class="btn btn-success pull-right"> <a href="alerting/notification/new" class="btn btn-success pull-right">
<i class="fa fa-plus"></i> <i class="fa fa-plus"></i>
New Notification New Channel
</a> </a>
</div> </div>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment