-
-## Enabling app plugins
-After installing an app it have to be enabled before it show up as an datasource or panel. You can do that on the app page in the config tab.
-
-### Develop your own App
-
-> Our goal is not to have a very extensive documentation but rather have actual
-> code that people can look at. An example implementation of an app can be found
-> in this [example app repo](https://github.com/grafana/example-app)
-
diff --git a/docs/sources/plugins/developing/apps.md b/docs/sources/plugins/developing/apps.md
new file mode 100644
index 00000000000..a3fc35066f6
--- /dev/null
+++ b/docs/sources/plugins/developing/apps.md
@@ -0,0 +1,63 @@
++++
+title = "Developing App Plugins"
+keywords = ["grafana", "plugins", "documentation"]
+type = "docs"
+[menu.docs]
+name = "Developing App Plugins"
+parent = "developing"
+weight = 6
++++
+
+# Grafana Apps
+
+App plugins are a new kind of grafana plugin that can bundle datasource and panel plugins within one package. It also enable the plugin author to create custom pages within grafana. The custom pages enable the plugin author to include things like documentation, sign up forms or controlling other services using HTTP requests.
+
+Datasource and panel plugins will show up like normal plugins. The app pages will be available in the main menu.
+
+{{< imgbox img="/img/docs/v3/app-in-main-menu.png" caption="App in Main Menu" >}}
+
+## Enabling app plugins
+
+After installing an app, it has to be enabled before it shows up as a datasource or panel. You can do that on the app page in the config tab.
+
+## Developing an App Plugin
+
+An App is a bundle of panels, dashboards and/or data source(s). There is nothing different about developing panels and data sources for an app.
+
+Apps have to be enabled in Grafana and should import any included dashboards when the user enables it. A ConfigCtrl class should be created and the dashboards imported in the postUpdate hook. See example below:
+
+```javascript
+export class ConfigCtrl {
+ /** @ngInject */
+ constructor($scope, $injector, $q) {
+ this.$q = $q;
+ this.enabled = false;
+ this.appEditCtrl.setPostUpdateHook(this.postUpdate.bind(this));
+ }
+
+ postUpdate() {
+ if (!this.appModel.enabled) {
+ return this.$q.resolve();
+ }
+ return this.appEditCtrl.importDashboards().then(() => {
+ this.enabled = true;
+ return {
+ url: "plugins/raintank-kubernetes-app/page/clusters",
+ message: "Kubernetes App enabled!"
+ };
+ });
+ }
+}
+ConfigCtrl.templateUrl = 'components/config/config.html';
+```
+
+If possible a link to a dashboard or custom page should be shown after enabling the app to guide the user to the appropriate place.
+
+{{< imgbox img="/img/docs/app_plugin_after_enable.png" caption="After enabling" >}}
+
+### Develop your own App
+
+> Our goal is not to have a very extensive documentation but rather have actual
+> code that people can look at. An example implementation of an app can be found
+> in this [example app repo](https://github.com/grafana/example-app)
+
diff --git a/docs/sources/plugins/developing/code-styleguide.md b/docs/sources/plugins/developing/code-styleguide.md
new file mode 100644
index 00000000000..99d9f565c7d
--- /dev/null
+++ b/docs/sources/plugins/developing/code-styleguide.md
@@ -0,0 +1,182 @@
++++
+title = "Plugin Code Styleguide"
+type = "docs"
+[menu.docs]
+name = "Plugin Code Styleguide"
+parent = "developing"
+weight = 2
++++
+
+# Grafana Plugin Code Styleguide
+
+This guide has two parts. The first part describes the metadata and the second part is a styleguide for HTML/CSS and JavaScript in Grafana plugins and applies if you are using ES6 in your plugin. If using TypeScript then the [Angular TypeScript styleguide](https://angular.io/styleguide) is recommended.
+
+## Metadata
+
+The plugin metadata consists of a plugin.json file and the README.md file. These two files are used by Grafana and Grafana.net.
+
+### Plugin.json (mandatory)
+
+The plugin.json file is the same concept as the package.json file for an npm package. When Grafana starts it will scan the plugin folders and mount every folder that contains a plugin.json file unless the folder contains a subfolder named `dist`. In that case grafana will mount the `dist` folder instead.
+
+The most important fields are the first three, especially the id. The convention for the plugin id is **[github username/org]-[plugin name]-[datasource|app|panel]** and it has to be unique.
+
+Examples:
+
+```
+raintank-worldping-app
+grafana-simple-json-datasource
+grafana-piechart-panel
+mtanda-histogram-panel
+```
+
+The full file format for plugin.json is described [here]({{< relref "plugin.json.md" >}}).
+
+Minimal plugin.json:
+
+```javascript
+{
+ "type": "panel",
+ "name": "Clock",
+ "id": "yourorg-clock-panel",
+
+ "info": {
+ "description": "Clock panel for grafana",
+ "author": {
+ "name": "Raintank Inc.",
+ "url": "http://raintank.io"
+ },
+ "keywords": ["clock", "panel"],
+ "version": "1.0.0",
+ "updated": "2015-03-24"
+ },
+
+ "dependencies": {
+ "grafanaVersion": "3.x.x",
+ "plugins": [ ]
+ }
+}
+```
+
+### README.md
+
+The README.md file is rendered both on Grafana.net and in the plugins section in Grafana. The only difference from how GitHub renders markdown is that html is not allowed.
+
+## File and Directory Structure Conventions
+
+Here is a typical directory structure for a plugin.
+
+```
+johnnyb-awesome-datasource
+|-- dist
+|-- spec
+| |-- datasource_spec.js
+| |-- query_ctrl_spec.js
+| |-- test-main.js
+|-- src
+| |-- img
+| | |-- logo.svg
+| |-- partials
+| | |-- annotations.editor.html
+| | |-- config.html
+| | |-- query.editor.html
+| |-- datasource.js
+| |-- module.js
+| |-- plugin.json
+| |-- query_ctrl.js
+|-- Gruntfile.js
+|-- LICENSE
+|-- package.json
+|-- README.md
+```
+
+Most JavaScript projects have a build step and most Grafana plugins are built using Babel and ES6. The generated JavaScript should be placed in the `dist` directory and the source code in the `src` directory. We recommend that the plugin.json file be placed in the src directory and then copied over to the dist directory when building. The `README.md` can be placed in the root or in the dist directory.
+
+Directories:
+
+- `src/` contains plugin source files.
+- `src/partials` contains html templates.
+- `src/img` contains plugin logos and other images.
+- `spec/` contains tests (optional).
+- `dist/` contains built content.
+
+## HTML and CSS
+
+For the HTML on editor tabs, we recommend using the inbuilt Grafana styles rather than defining your own. This makes plugins feel like a more natural part of Grafana. If done correctly, the html will also be responsive and adapt to smaller screens. The `gf-form` css classes should be used for labels and inputs.
+
+Below is a minimal example of an editor row with one form group and two fields, a dropdown and a text input:
+
+```html
+
+
+
+
+```
+
+Note that there are some Angular attributes here. *ng-model* will update the panel data. *ng-change* will render the panel when you change the value. This change will occur on the onblur event due to the *ng-model-onblur* attribute. This means you can see the effect of your changes on the panel while editing.
+
+{{< imgbox img="/assets/img/blog/clock-panel-editor.png" caption="Panel Editor" >}}
+
+On the editor tab we use a drop down for 12/24 hour clock, an input field for font size and a color picker for the background color.
+
+The drop down/select has its own *gf-form-select-wrapper* css class and looks like this:
+
+```html
+
+
+
+```
+
+The color picker (or spectrum picker) is a component that already exists in Grafana. We use it like this for the background color:
+
+```html
+
+
+
+
- 
+ 
## What is Hubot?
+
[Hubot](https://hubot.github.com/) is an universal and extensible chat bot that can be used with many chat
services and has a huge library of third party plugins that allow you to automate anything from your
chat rooms.
## Install Hubot
+
Hubot is very easy to install and host. If you do not already have a bot up and running please
read the official [Getting Started With Hubot](https://hubot.github.com/docs/) guide.
@@ -63,6 +65,7 @@ The `hubot-grafana` plugin requires a number of environment variables to be set
export HUBOT_GRAFANA_S3_REGION=us-standard
### Grafana server side rendering
+
The hubot plugin will take advantage of the Grafana server side rendering feature that can
render any panel on the server using phantomjs. Grafana ships with a phantomjs binary (linux only).
@@ -70,11 +73,13 @@ To verify that this feature works try the `Direct link to rendered image` link i
If you do not get an image when opening this link verify that the required font packages are installed for phantomjs to work.
### Grafana API Key
-
+
+
+
You need to set the environment variable `HUBOT_GRAFANA_API_KEY` to a Grafana API Key.
You can add these from the API Keys page which you find in the Organization dropdown.
### Amazon S3
+
The `S3` options are optional but for the images to work properly in services like Slack and Hipchat they need
to publicly available. By specifying the `S3` options the hubot-grafana script will publish the rendered
panel to `S3` and it will use that URL when it posts to Slack or Hipchat.
@@ -99,6 +104,7 @@ panel to `S3` and it will use that URL when it posts to Slack or Hipchat.
- Get a templated dashboard with the `$host` parameter set to `carbon-a`
## Aliases
+
Some of the hubot commands above can lengthy and you might have to remember the dashboard slug (url id).
If you have a few favorite graphs you want to be able check up on often (let's say from your mobile) you
can create hubot command aliases with the hubot script `hubot-alias`.
@@ -115,7 +121,7 @@ Now you can add an alias like this:
Using the alias:
-
+ 
## Summary
diff --git a/package.json b/package.json
index dc3970bfe69..d38de899bf5 100644
--- a/package.json
+++ b/package.json
@@ -4,7 +4,7 @@
"company": "Coding Instinct AB"
},
"name": "grafana",
- "version": "4.2.0-pre1",
+ "version": "4.3.0-pre1",
"repository": {
"type": "git",
"url": "http://github.com/grafana/grafana.git"
diff --git a/packaging/publish/publish_both.sh b/packaging/publish/publish_both.sh
index 2f24ff6b3ea..3a70c6d9133 100755
--- a/packaging/publish/publish_both.sh
+++ b/packaging/publish/publish_both.sh
@@ -1,6 +1,6 @@
#! /usr/bin/env bash
-deb_ver=4.1.0-1484127817
-rpm_ver=4.1.0-1484127817
+deb_ver=4.1.2-1486989747
+rpm_ver=4.1.2-1486989747
wget https://grafanarel.s3.amazonaws.com/builds/grafana_${deb_ver}_amd64.deb
diff --git a/pkg/api/api.go b/pkg/api/api.go
index 7d3a5563892..026bae2d894 100644
--- a/pkg/api/api.go
+++ b/pkg/api/api.go
@@ -123,6 +123,7 @@ func (hs *HttpServer) registerRoutes() {
// users (admin permission required)
r.Group("/users", func() {
r.Get("/", wrap(SearchUsers))
+ r.Get("/search", wrap(SearchUsersWithPaging))
r.Get("/:id", wrap(GetUserById))
r.Get("/:id/orgs", wrap(GetUserOrgList))
// query parameters /users/lookup?loginOrEmail=admin@example.com
@@ -195,10 +196,11 @@ func (hs *HttpServer) registerRoutes() {
// Data sources
r.Group("/datasources", func() {
- r.Get("/", GetDataSources)
+ r.Get("/", wrap(GetDataSources))
r.Post("/", quota("data_source"), bind(m.AddDataSourceCommand{}), AddDataSource)
r.Put("/:id", bind(m.UpdateDataSourceCommand{}), wrap(UpdateDataSource))
- r.Delete("/:id", DeleteDataSource)
+ r.Delete("/:id", DeleteDataSourceById)
+ r.Delete("/name/:name", DeleteDataSourceByName)
r.Get("/:id", wrap(GetDataSourceById))
r.Get("/name/:name", wrap(GetDataSourceByName))
}, reqOrgAdmin)
diff --git a/pkg/api/api_test.go b/pkg/api/api_test.go
deleted file mode 100644
index ea3588b0e67..00000000000
--- a/pkg/api/api_test.go
+++ /dev/null
@@ -1,35 +0,0 @@
-package api
-
-import (
- "testing"
-)
-
-func TestHttpApi(t *testing.T) {
-
- // Convey("Given the grafana api", t, func() {
- // ConveyApiScenario("Can sign up", func(c apiTestContext) {
- // c.PostJson()
- // So(c.Resp, ShouldEqualJsonApiResponse, "User created and logged in")
- // })
- //
- // m := macaron.New()
- // m.Use(middleware.GetContextHandler())
- // m.Use(middleware.Sessioner(&session.Options{}))
- // Register(m)
- //
- // var context *middleware.Context
- // m.Get("/", func(c *middleware.Context) {
- // context = c
- // })
- //
- // resp := httptest.NewRecorder()
- // req, err := http.NewRequest("GET", "/", nil)
- // So(err, ShouldBeNil)
- //
- // m.ServeHTTP(resp, req)
- //
- // Convey("should red 200", func() {
- // So(resp.Code, ShouldEqual, 200)
- // })
- // })
-}
diff --git a/pkg/api/cloudwatch/cloudwatch.go b/pkg/api/cloudwatch/cloudwatch.go
index 1b796be874e..1cf4b671e2d 100644
--- a/pkg/api/cloudwatch/cloudwatch.go
+++ b/pkg/api/cloudwatch/cloudwatch.go
@@ -114,7 +114,10 @@ func getCredentials(dsInfo *datasourceInfo) (*credentials.Credentials, error) {
DurationSeconds: aws.Int64(900),
}
- stsSess := session.New()
+ stsSess, err := session.NewSession()
+ if err != nil {
+ return nil, err
+ }
stsCreds := credentials.NewChainCredentials(
[]credentials.Provider{
&credentials.EnvProvider{},
@@ -126,7 +129,11 @@ func getCredentials(dsInfo *datasourceInfo) (*credentials.Credentials, error) {
Credentials: stsCreds,
}
- svc := sts.New(session.New(stsConfig), stsConfig)
+ sess, err := session.NewSession(stsConfig)
+ if err != nil {
+ return nil, err
+ }
+ svc := sts.New(sess, stsConfig)
resp, err := svc.AssumeRole(params)
if err != nil {
return nil, err
@@ -139,7 +146,10 @@ func getCredentials(dsInfo *datasourceInfo) (*credentials.Credentials, error) {
}
}
- sess := session.New()
+ sess, err := session.NewSession()
+ if err != nil {
+ return nil, err
+ }
creds := credentials.NewChainCredentials(
[]credentials.Provider{
&credentials.StaticProvider{Value: credentials.Value{
@@ -185,7 +195,12 @@ func handleGetMetricStatistics(req *cwRequest, c *middleware.Context) {
c.JsonApiErr(500, "Unable to call AWS API", err)
return
}
- svc := cloudwatch.New(session.New(cfg), cfg)
+ sess, err := session.NewSession(cfg)
+ if err != nil {
+ c.JsonApiErr(500, "Unable to call AWS API", err)
+ return
+ }
+ svc := cloudwatch.New(sess, cfg)
reqParam := &struct {
Parameters struct {
@@ -232,7 +247,12 @@ func handleListMetrics(req *cwRequest, c *middleware.Context) {
c.JsonApiErr(500, "Unable to call AWS API", err)
return
}
- svc := cloudwatch.New(session.New(cfg), cfg)
+ sess, err := session.NewSession(cfg)
+ if err != nil {
+ c.JsonApiErr(500, "Unable to call AWS API", err)
+ return
+ }
+ svc := cloudwatch.New(sess, cfg)
reqParam := &struct {
Parameters struct {
@@ -273,7 +293,12 @@ func handleDescribeAlarms(req *cwRequest, c *middleware.Context) {
c.JsonApiErr(500, "Unable to call AWS API", err)
return
}
- svc := cloudwatch.New(session.New(cfg), cfg)
+ sess, err := session.NewSession(cfg)
+ if err != nil {
+ c.JsonApiErr(500, "Unable to call AWS API", err)
+ return
+ }
+ svc := cloudwatch.New(sess, cfg)
reqParam := &struct {
Parameters struct {
@@ -316,7 +341,12 @@ func handleDescribeAlarmsForMetric(req *cwRequest, c *middleware.Context) {
c.JsonApiErr(500, "Unable to call AWS API", err)
return
}
- svc := cloudwatch.New(session.New(cfg), cfg)
+ sess, err := session.NewSession(cfg)
+ if err != nil {
+ c.JsonApiErr(500, "Unable to call AWS API", err)
+ return
+ }
+ svc := cloudwatch.New(sess, cfg)
reqParam := &struct {
Parameters struct {
@@ -360,7 +390,12 @@ func handleDescribeAlarmHistory(req *cwRequest, c *middleware.Context) {
c.JsonApiErr(500, "Unable to call AWS API", err)
return
}
- svc := cloudwatch.New(session.New(cfg), cfg)
+ sess, err := session.NewSession(cfg)
+ if err != nil {
+ c.JsonApiErr(500, "Unable to call AWS API", err)
+ return
+ }
+ svc := cloudwatch.New(sess, cfg)
reqParam := &struct {
Parameters struct {
@@ -396,7 +431,12 @@ func handleDescribeInstances(req *cwRequest, c *middleware.Context) {
c.JsonApiErr(500, "Unable to call AWS API", err)
return
}
- svc := ec2.New(session.New(cfg), cfg)
+ sess, err := session.NewSession(cfg)
+ if err != nil {
+ c.JsonApiErr(500, "Unable to call AWS API", err)
+ return
+ }
+ svc := ec2.New(sess, cfg)
reqParam := &struct {
Parameters struct {
diff --git a/pkg/api/cloudwatch/metrics.go b/pkg/api/cloudwatch/metrics.go
index 0df8eaa089c..b41bb20d6c8 100644
--- a/pkg/api/cloudwatch/metrics.go
+++ b/pkg/api/cloudwatch/metrics.go
@@ -82,6 +82,7 @@ func init() {
"AWS/RDS": {"ActiveTransactions", "AuroraBinlogReplicaLag", "AuroraReplicaLag", "AuroraReplicaLagMaximum", "AuroraReplicaLagMinimum", "BinLogDiskUsage", "BlockedTransactions", "BufferCacheHitRatio", "CommitLatency", "CommitThroughput", "CPUCreditBalance", "CPUCreditUsage", "CPUUtilization", "DatabaseConnections", "DDLLatency", "DDLThroughput", "Deadlocks", "DiskQueueDepth", "DMLLatency", "DMLThroughput", "FailedSqlStatements", "FreeableMemory", "FreeStorageSpace", "LoginFailures", "NetworkReceiveThroughput", "NetworkTransmitThroughput", "ReadIOPS", "ReadLatency", "ReadThroughput", "ReplicaLag", "ResultSetCacheHitRatio", "SelectLatency", "SelectThroughput", "SwapUsage", "TotalConnections", "VolumeReadIOPS", "VolumeWriteIOPS", "WriteIOPS", "WriteLatency", "WriteThroughput"},
"AWS/Route53": {"HealthCheckStatus", "HealthCheckPercentageHealthy", "ConnectionTime", "SSLHandshakeTime", "TimeToFirstByte"},
"AWS/S3": {"BucketSizeBytes", "NumberOfObjects"},
+ "AWS/SES": {"Bounce", "Complaint", "Delivery", "Reject", "Send"},
"AWS/SNS": {"NumberOfMessagesPublished", "PublishSize", "NumberOfNotificationsDelivered", "NumberOfNotificationsFailed"},
"AWS/SQS": {"NumberOfMessagesSent", "SentMessageSize", "NumberOfMessagesReceived", "NumberOfEmptyReceives", "NumberOfMessagesDeleted", "ApproximateNumberOfMessagesDelayed", "ApproximateNumberOfMessagesVisible", "ApproximateNumberOfMessagesNotVisible"},
"AWS/StorageGateway": {"CacheHitPercent", "CachePercentUsed", "CachePercentDirty", "CloudBytesDownloaded", "CloudDownloadLatency", "CloudBytesUploaded", "UploadBufferFree", "UploadBufferPercentUsed", "UploadBufferUsed", "QueuedWrites", "ReadBytes", "ReadTime", "TotalCacheSize", "WriteBytes", "WriteTime", "TimeSinceLastRecoveryPoint", "WorkingStorageFree", "WorkingStoragePercentUsed", "WorkingStorageUsed",
@@ -123,6 +124,7 @@ func init() {
"AWS/RDS": {"DBInstanceIdentifier", "DBClusterIdentifier", "DatabaseClass", "EngineName"},
"AWS/Route53": {"HealthCheckId"},
"AWS/S3": {"BucketName", "StorageType"},
+ "AWS/SES": {},
"AWS/SNS": {"Application", "Platform", "TopicName"},
"AWS/SQS": {"QueueName"},
"AWS/StorageGateway": {"GatewayId", "GatewayName", "VolumeId"},
@@ -256,8 +258,11 @@ func getAllMetrics(cwData *datasourceInfo) (cloudwatch.ListMetricsOutput, error)
Region: aws.String(cwData.Region),
Credentials: creds,
}
-
- svc := cloudwatch.New(session.New(cfg), cfg)
+ sess, err := session.NewSession(cfg)
+ if err != nil {
+ return cloudwatch.ListMetricsOutput{}, err
+ }
+ svc := cloudwatch.New(sess, cfg)
params := &cloudwatch.ListMetricsInput{
Namespace: aws.String(cwData.Namespace),
diff --git a/pkg/api/dataproxy.go b/pkg/api/dataproxy.go
index dfdc867d4a4..b72f676dbbc 100644
--- a/pkg/api/dataproxy.go
+++ b/pkg/api/dataproxy.go
@@ -6,6 +6,7 @@ import (
"net/http"
"net/http/httputil"
"net/url"
+ "strings"
"time"
"github.com/grafana/grafana/pkg/api/cloudwatch"
@@ -107,6 +108,13 @@ func ProxyDataSourceRequest(c *middleware.Context) {
proxyPath := c.Params("*")
+ if ds.Type == m.DS_PROMETHEUS {
+ if c.Req.Request.Method != http.MethodGet || !strings.HasPrefix(proxyPath, "api/") {
+ c.JsonApiErr(403, "GET is only allowed on proxied Prometheus datasource", nil)
+ return
+ }
+ }
+
if ds.Type == m.DS_ES {
if c.Req.Request.Method == "DELETE" {
c.JsonApiErr(403, "Deletes not allowed on proxied Elasticsearch datasource", nil)
diff --git a/pkg/api/datasources.go b/pkg/api/datasources.go
index 43f4d308ed6..ddf8681c3c8 100644
--- a/pkg/api/datasources.go
+++ b/pkg/api/datasources.go
@@ -11,12 +11,11 @@ import (
"github.com/grafana/grafana/pkg/util"
)
-func GetDataSources(c *middleware.Context) {
+func GetDataSources(c *middleware.Context) Response {
query := m.GetDataSourcesQuery{OrgId: c.OrgId}
if err := bus.Dispatch(&query); err != nil {
- c.JsonApiErr(500, "Failed to query datasources", err)
- return
+ return ApiError(500, "Failed to query datasources", err)
}
result := make(dtos.DataSourceList, 0)
@@ -46,7 +45,8 @@ func GetDataSources(c *middleware.Context) {
}
sort.Sort(result)
- c.JSON(200, result)
+
+ return Json(200, &result)
}
func GetDataSourceById(c *middleware.Context) Response {
@@ -68,7 +68,7 @@ func GetDataSourceById(c *middleware.Context) Response {
return Json(200, &dtos)
}
-func DeleteDataSource(c *middleware.Context) {
+func DeleteDataSourceById(c *middleware.Context) {
id := c.ParamsInt64(":id")
if id <= 0 {
@@ -76,7 +76,26 @@ func DeleteDataSource(c *middleware.Context) {
return
}
- cmd := &m.DeleteDataSourceCommand{Id: id, OrgId: c.OrgId}
+ cmd := &m.DeleteDataSourceByIdCommand{Id: id, OrgId: c.OrgId}
+
+ err := bus.Dispatch(cmd)
+ if err != nil {
+ c.JsonApiErr(500, "Failed to delete datasource", err)
+ return
+ }
+
+ c.JsonOK("Data source deleted")
+}
+
+func DeleteDataSourceByName(c *middleware.Context) {
+ name := c.Params(":name")
+
+ if name == "" {
+ c.JsonApiErr(400, "Missing valid datasource name", nil)
+ return
+ }
+
+ cmd := &m.DeleteDataSourceByNameCommand{Name: name, OrgId: c.OrgId}
err := bus.Dispatch(cmd)
if err != nil {
diff --git a/pkg/api/datasources_test.go b/pkg/api/datasources_test.go
new file mode 100644
index 00000000000..5ae752bea91
--- /dev/null
+++ b/pkg/api/datasources_test.go
@@ -0,0 +1,132 @@
+package api
+
+import (
+ "encoding/json"
+ "net/http"
+ "net/http/httptest"
+ "path/filepath"
+ "testing"
+
+ "github.com/grafana/grafana/pkg/models"
+ macaron "gopkg.in/macaron.v1"
+
+ "github.com/go-macaron/session"
+ "github.com/grafana/grafana/pkg/bus"
+ "github.com/grafana/grafana/pkg/middleware"
+ . "github.com/smartystreets/goconvey/convey"
+)
+
+const (
+ TestOrgID = 1
+ TestUserID = 1
+)
+
+func TestDataSourcesProxy(t *testing.T) {
+ Convey("Given a user is logged in", t, func() {
+ loggedInUserScenario("When calling GET on", "/api/datasources/", func(sc *scenarioContext) {
+
+ // Stubs the database query
+ bus.AddHandler("test", func(query *models.GetDataSourcesQuery) error {
+ So(query.OrgId, ShouldEqual, TestOrgID)
+ query.Result = []*models.DataSource{
+ {Name: "mmm"},
+ {Name: "ZZZ"},
+ {Name: "BBB"},
+ {Name: "aaa"},
+ }
+ return nil
+ })
+
+ // handler func being tested
+ sc.handlerFunc = GetDataSources
+ sc.fakeReq("GET", "/api/datasources").exec()
+
+ respJSON := []map[string]interface{}{}
+ err := json.NewDecoder(sc.resp.Body).Decode(&respJSON)
+ So(err, ShouldBeNil)
+
+ Convey("should return list of datasources for org sorted alphabetically and case insensitively", func() {
+ So(respJSON[0]["name"], ShouldEqual, "aaa")
+ So(respJSON[1]["name"], ShouldEqual, "BBB")
+ So(respJSON[2]["name"], ShouldEqual, "mmm")
+ So(respJSON[3]["name"], ShouldEqual, "ZZZ")
+ })
+ })
+ })
+}
+
+func loggedInUserScenario(desc string, url string, fn scenarioFunc) {
+ Convey(desc+" "+url, func() {
+ defer bus.ClearBusHandlers()
+
+ sc := &scenarioContext{
+ url: url,
+ }
+ viewsPath, _ := filepath.Abs("../../public/views")
+
+ sc.m = macaron.New()
+ sc.m.Use(macaron.Renderer(macaron.RenderOptions{
+ Directory: viewsPath,
+ Delims: macaron.Delims{Left: "[[", Right: "]]"},
+ }))
+
+ sc.m.Use(middleware.GetContextHandler())
+ sc.m.Use(middleware.Sessioner(&session.Options{}))
+
+ sc.defaultHandler = wrap(func(c *middleware.Context) Response {
+ sc.context = c
+ sc.context.UserId = TestUserID
+ sc.context.OrgId = TestOrgID
+ sc.context.OrgRole = models.ROLE_EDITOR
+ if sc.handlerFunc != nil {
+ return sc.handlerFunc(sc.context)
+ }
+
+ return nil
+ })
+
+ sc.m.Get(url, sc.defaultHandler)
+
+ fn(sc)
+ })
+}
+
+func (sc *scenarioContext) fakeReq(method, url string) *scenarioContext {
+ sc.resp = httptest.NewRecorder()
+ req, err := http.NewRequest(method, url, nil)
+ So(err, ShouldBeNil)
+ sc.req = req
+
+ return sc
+}
+
+func (sc *scenarioContext) fakeReqWithParams(method, url string, queryParams map[string]string) *scenarioContext {
+ sc.resp = httptest.NewRecorder()
+ req, err := http.NewRequest(method, url, nil)
+ q := req.URL.Query()
+ for k, v := range queryParams {
+ q.Add(k, v)
+ }
+ req.URL.RawQuery = q.Encode()
+ So(err, ShouldBeNil)
+ sc.req = req
+
+ return sc
+}
+
+type scenarioContext struct {
+ m *macaron.Macaron
+ context *middleware.Context
+ resp *httptest.ResponseRecorder
+ handlerFunc handlerFunc
+ defaultHandler macaron.Handler
+ req *http.Request
+ url string
+}
+
+func (sc *scenarioContext) exec() {
+ sc.m.ServeHTTP(sc.resp, sc.req)
+}
+
+type scenarioFunc func(c *scenarioContext)
+type handlerFunc func(c *middleware.Context) Response
diff --git a/pkg/api/dtos/models.go b/pkg/api/dtos/models.go
index 13dbe4ea32a..564d86a25bf 100644
--- a/pkg/api/dtos/models.go
+++ b/pkg/api/dtos/models.go
@@ -91,7 +91,7 @@ func (slice DataSourceList) Len() int {
}
func (slice DataSourceList) Less(i, j int) bool {
- return slice[i].Name < slice[j].Name
+ return strings.ToLower(slice[i].Name) < strings.ToLower(slice[j].Name)
}
func (slice DataSourceList) Swap(i, j int) {
diff --git a/pkg/api/frontendsettings.go b/pkg/api/frontendsettings.go
index 3690784375d..c0e27897ff4 100644
--- a/pkg/api/frontendsettings.go
+++ b/pkg/api/frontendsettings.go
@@ -141,6 +141,7 @@ func getFrontendSettingsMap(c *middleware.Context) (map[string]interface{}, erro
"authProxyEnabled": setting.AuthProxyEnabled,
"ldapEnabled": setting.LdapEnabled,
"alertingEnabled": setting.AlertingEnabled,
+ "googleAnalyticsId": setting.GoogleAnalyticsId,
"buildInfo": map[string]interface{}{
"version": setting.BuildVersion,
"commit": setting.BuildCommit,
diff --git a/pkg/api/http_server.go b/pkg/api/http_server.go
index 442eae60e02..fe7ca21f402 100644
--- a/pkg/api/http_server.go
+++ b/pkg/api/http_server.go
@@ -2,6 +2,7 @@ package api
import (
"context"
+ "crypto/tls"
"errors"
"fmt"
"net/http"
@@ -24,6 +25,8 @@ type HttpServer struct {
macaron *macaron.Macaron
context context.Context
streamManager *live.StreamManager
+
+ httpSrv *http.Server
}
func NewHttpServer() *HttpServer {
@@ -45,11 +48,20 @@ func (hs *HttpServer) Start(ctx context.Context) error {
listenAddr := fmt.Sprintf("%s:%s", setting.HttpAddr, setting.HttpPort)
hs.log.Info("Initializing HTTP Server", "address", listenAddr, "protocol", setting.Protocol, "subUrl", setting.AppSubUrl)
+ hs.httpSrv = &http.Server{Addr: listenAddr, Handler: hs.macaron}
switch setting.Protocol {
case setting.HTTP:
- err = http.ListenAndServe(listenAddr, hs.macaron)
+ err = hs.httpSrv.ListenAndServe()
+ if err == http.ErrServerClosed {
+ hs.log.Debug("server was shutdown gracefully")
+ return nil
+ }
case setting.HTTPS:
- err = hs.listenAndServeTLS(listenAddr, setting.CertFile, setting.KeyFile)
+ err = hs.httpSrv.ListenAndServeTLS(setting.CertFile, setting.KeyFile)
+ if err == http.ErrServerClosed {
+ hs.log.Debug("server was shutdown gracefully")
+ return nil
+ }
default:
hs.log.Error("Invalid protocol", "protocol", setting.Protocol)
err = errors.New("Invalid Protocol")
@@ -58,6 +70,12 @@ func (hs *HttpServer) Start(ctx context.Context) error {
return err
}
+func (hs *HttpServer) Shutdown(ctx context.Context) error {
+ err := hs.httpSrv.Shutdown(ctx)
+ hs.log.Info("stopped http server")
+ return err
+}
+
func (hs *HttpServer) listenAndServeTLS(listenAddr, certfile, keyfile string) error {
if certfile == "" {
return fmt.Errorf("cert_file cannot be empty when using HTTPS")
@@ -75,7 +93,32 @@ func (hs *HttpServer) listenAndServeTLS(listenAddr, certfile, keyfile string) er
return fmt.Errorf(`Cannot find SSL key_file at %v`, setting.KeyFile)
}
- return http.ListenAndServeTLS(listenAddr, setting.CertFile, setting.KeyFile, hs.macaron)
+ tlsCfg := &tls.Config{
+ MinVersion: tls.VersionTLS12,
+ PreferServerCipherSuites: true,
+ CipherSuites: []uint16{
+ tls.TLS_RSA_WITH_AES_128_CBC_SHA,
+ tls.TLS_RSA_WITH_AES_256_CBC_SHA,
+ tls.TLS_RSA_WITH_AES_128_GCM_SHA256,
+ tls.TLS_RSA_WITH_AES_256_GCM_SHA384,
+ tls.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,
+ tls.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,
+ tls.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,
+ tls.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,
+ tls.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,
+ tls.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
+ tls.TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,
+ tls.TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
+ },
+ }
+ srv := &http.Server{
+ Addr: listenAddr,
+ Handler: hs.macaron,
+ TLSConfig: tlsCfg,
+ TLSNextProto: make(map[string]func(*http.Server, *tls.Conn, http.Handler), 0),
+ }
+
+ return srv.ListenAndServeTLS(setting.CertFile, setting.KeyFile)
}
func (hs *HttpServer) newMacaron() *macaron.Macaron {
@@ -107,6 +150,7 @@ func (hs *HttpServer) newMacaron() *macaron.Macaron {
m.Use(middleware.GetContextHandler())
m.Use(middleware.Sessioner(&setting.SessionOptions))
m.Use(middleware.RequestMetrics())
+ m.Use(middleware.OrgRedirect())
// needs to be after context handler
if setting.EnforceDomain {
diff --git a/pkg/api/login_oauth.go b/pkg/api/login_oauth.go
index 574d08af09f..2bf9c484803 100644
--- a/pkg/api/login_oauth.go
+++ b/pkg/api/login_oauth.go
@@ -10,6 +10,7 @@ import (
"io/ioutil"
"log"
"net/http"
+ "net/url"
"golang.org/x/net/context"
"golang.org/x/oauth2"
@@ -177,5 +178,11 @@ func OAuthLogin(ctx *middleware.Context) {
metrics.M_Api_Login_OAuth.Inc(1)
+ if redirectTo, _ := url.QueryUnescape(ctx.GetCookie("redirect_to")); len(redirectTo) > 0 {
+ ctx.SetCookie("redirect_to", "", -1, setting.AppSubUrl+"/")
+ ctx.Redirect(redirectTo)
+ return
+ }
+
ctx.Redirect(setting.AppSubUrl + "/")
}
diff --git a/pkg/api/metrics.go b/pkg/api/metrics.go
index dad3b159ad6..9194637af15 100644
--- a/pkg/api/metrics.go
+++ b/pkg/api/metrics.go
@@ -33,7 +33,7 @@ func QueryMetrics(c *middleware.Context, reqDto dtos.MetricRequest) Response {
})
}
- resp, err := tsdb.HandleRequest(context.TODO(), request)
+ resp, err := tsdb.HandleRequest(context.Background(), request)
if err != nil {
return ApiError(500, "Metric request error", err)
}
diff --git a/pkg/api/user.go b/pkg/api/user.go
index 7bce599d692..39e7fce1462 100644
--- a/pkg/api/user.go
+++ b/pkg/api/user.go
@@ -210,14 +210,48 @@ func ChangeUserPassword(c *middleware.Context, cmd m.ChangeUserPasswordCommand)
// GET /api/users
func SearchUsers(c *middleware.Context) Response {
- query := m.SearchUsersQuery{Query: "", Page: 0, Limit: 1000}
- if err := bus.Dispatch(&query); err != nil {
+ query, err := searchUser(c)
+ if err != nil {
+ return ApiError(500, "Failed to fetch users", err)
+ }
+
+ return Json(200, query.Result.Users)
+}
+
+// GET /api/search
+func SearchUsersWithPaging(c *middleware.Context) Response {
+ query, err := searchUser(c)
+ if err != nil {
return ApiError(500, "Failed to fetch users", err)
}
return Json(200, query.Result)
}
+func searchUser(c *middleware.Context) (*m.SearchUsersQuery, error) {
+ perPage := c.QueryInt("perpage")
+ if perPage <= 0 {
+ perPage = 1000
+ }
+ page := c.QueryInt("page")
+
+ if page < 1 {
+ page = 1
+ }
+
+ searchQuery := c.Query("query")
+
+ query := &m.SearchUsersQuery{Query: searchQuery, Page: page, Limit: perPage}
+ if err := bus.Dispatch(query); err != nil {
+ return nil, err
+ }
+
+ query.Result.Page = page
+ query.Result.PerPage = perPage
+
+ return query, nil
+}
+
func SetHelpFlag(c *middleware.Context) Response {
flag := c.ParamsInt64(":id")
diff --git a/pkg/api/user_test.go b/pkg/api/user_test.go
new file mode 100644
index 00000000000..6aa9dd9adbf
--- /dev/null
+++ b/pkg/api/user_test.go
@@ -0,0 +1,109 @@
+package api
+
+import (
+ "testing"
+
+ "github.com/grafana/grafana/pkg/models"
+
+ "github.com/grafana/grafana/pkg/bus"
+ "github.com/grafana/grafana/pkg/components/simplejson"
+ . "github.com/smartystreets/goconvey/convey"
+)
+
+func TestUserApiEndpoint(t *testing.T) {
+ Convey("Given a user is logged in", t, func() {
+ mockResult := models.SearchUserQueryResult{
+ Users: []*models.UserSearchHitDTO{
+ {Name: "user1"},
+ {Name: "user2"},
+ },
+ TotalCount: 2,
+ }
+
+ loggedInUserScenario("When calling GET on", "/api/users", func(sc *scenarioContext) {
+ var sentLimit int
+ var sendPage int
+ bus.AddHandler("test", func(query *models.SearchUsersQuery) error {
+ query.Result = mockResult
+
+ sentLimit = query.Limit
+ sendPage = query.Page
+
+ return nil
+ })
+
+ sc.handlerFunc = SearchUsers
+ sc.fakeReqWithParams("GET", sc.url, map[string]string{}).exec()
+
+ So(sentLimit, ShouldEqual, 1000)
+ So(sendPage, ShouldEqual, 1)
+
+ respJSON, err := simplejson.NewJson(sc.resp.Body.Bytes())
+ So(err, ShouldBeNil)
+ So(len(respJSON.MustArray()), ShouldEqual, 2)
+ })
+
+ loggedInUserScenario("When calling GET with page and limit querystring parameters on", "/api/users", func(sc *scenarioContext) {
+ var sentLimit int
+ var sendPage int
+ bus.AddHandler("test", func(query *models.SearchUsersQuery) error {
+ query.Result = mockResult
+
+ sentLimit = query.Limit
+ sendPage = query.Page
+
+ return nil
+ })
+
+ sc.handlerFunc = SearchUsers
+ sc.fakeReqWithParams("GET", sc.url, map[string]string{"perpage": "10", "page": "2"}).exec()
+
+ So(sentLimit, ShouldEqual, 10)
+ So(sendPage, ShouldEqual, 2)
+ })
+
+ loggedInUserScenario("When calling GET on", "/api/users/search", func(sc *scenarioContext) {
+ var sentLimit int
+ var sendPage int
+ bus.AddHandler("test", func(query *models.SearchUsersQuery) error {
+ query.Result = mockResult
+
+ sentLimit = query.Limit
+ sendPage = query.Page
+
+ return nil
+ })
+
+ sc.handlerFunc = SearchUsersWithPaging
+ sc.fakeReqWithParams("GET", sc.url, map[string]string{}).exec()
+
+ So(sentLimit, ShouldEqual, 1000)
+ So(sendPage, ShouldEqual, 1)
+
+ respJSON, err := simplejson.NewJson(sc.resp.Body.Bytes())
+ So(err, ShouldBeNil)
+
+ So(respJSON.Get("totalCount").MustInt(), ShouldEqual, 2)
+ So(len(respJSON.Get("users").MustArray()), ShouldEqual, 2)
+ })
+
+ loggedInUserScenario("When calling GET with page and perpage querystring parameters on", "/api/users/search", func(sc *scenarioContext) {
+ var sentLimit int
+ var sendPage int
+ bus.AddHandler("test", func(query *models.SearchUsersQuery) error {
+ query.Result = mockResult
+
+ sentLimit = query.Limit
+ sendPage = query.Page
+
+ return nil
+ })
+
+ sc.handlerFunc = SearchUsersWithPaging
+ sc.fakeReqWithParams("GET", sc.url, map[string]string{"perpage": "10", "page": "2"}).exec()
+
+ So(sentLimit, ShouldEqual, 10)
+ So(sendPage, ShouldEqual, 2)
+ })
+ })
+}
diff --git a/pkg/cmd/grafana-server/server.go b/pkg/cmd/grafana-server/server.go
index 94eb8e845ea..30da2342c2b 100644
--- a/pkg/cmd/grafana-server/server.go
+++ b/pkg/cmd/grafana-server/server.go
@@ -3,7 +3,6 @@ package main
import (
"context"
"os"
- "time"
"golang.org/x/sync/errgroup"
@@ -39,6 +38,8 @@ type GrafanaServerImpl struct {
shutdownFn context.CancelFunc
childRoutines *errgroup.Group
log log.Logger
+
+ httpServer *api.HttpServer
}
func (g *GrafanaServerImpl) Start() {
@@ -74,9 +75,9 @@ func (g *GrafanaServerImpl) Start() {
}
func (g *GrafanaServerImpl) startHttpServer() {
- httpServer := api.NewHttpServer()
+ g.httpServer = api.NewHttpServer()
- err := httpServer.Start(g.context)
+ err := g.httpServer.Start(g.context)
if err != nil {
g.log.Error("Fail to start server", "error", err)
@@ -88,24 +89,15 @@ func (g *GrafanaServerImpl) startHttpServer() {
func (g *GrafanaServerImpl) Shutdown(code int, reason string) {
g.log.Info("Shutdown started", "code", code, "reason", reason)
+ err := g.httpServer.Shutdown(g.context)
+ if err != nil {
+ g.log.Error("Failed to shutdown server", "error", err)
+ }
+
g.shutdownFn()
- err := g.childRoutines.Wait()
+ err = g.childRoutines.Wait()
g.log.Info("Shutdown completed", "reason", err)
log.Close()
os.Exit(code)
}
-
-// implement context.Context
-func (g *GrafanaServerImpl) Deadline() (deadline time.Time, ok bool) {
- return g.context.Deadline()
-}
-func (g *GrafanaServerImpl) Done() <-chan struct{} {
- return g.context.Done()
-}
-func (g *GrafanaServerImpl) Err() error {
- return g.context.Err()
-}
-func (g *GrafanaServerImpl) Value(key interface{}) interface{} {
- return g.context.Value(key)
-}
diff --git a/pkg/components/imguploader/s3uploader.go b/pkg/components/imguploader/s3uploader.go
index 5f476b9e366..4f8632f965c 100644
--- a/pkg/components/imguploader/s3uploader.go
+++ b/pkg/components/imguploader/s3uploader.go
@@ -35,7 +35,10 @@ func NewS3Uploader(region, bucket, acl, accessKey, secretKey string) *S3Uploader
}
func (u *S3Uploader) Upload(imageDiskPath string) (string, error) {
- sess := session.New()
+ sess, err := session.NewSession()
+ if err != nil {
+ return "", err
+ }
creds := credentials.NewChainCredentials(
[]credentials.Provider{
&credentials.StaticProvider{Value: credentials.Value{
@@ -58,7 +61,11 @@ func (u *S3Uploader) Upload(imageDiskPath string) (string, error) {
return "", err
}
- svc := s3.New(session.New(cfg), cfg)
+ sess, err = session.NewSession(cfg)
+ if err != nil {
+ return "", err
+ }
+ svc := s3.New(sess, cfg)
params := &s3.PutObjectInput{
Bucket: aws.String(u.bucket),
Key: aws.String(key),
diff --git a/pkg/components/imguploader/webdavuploader.go b/pkg/components/imguploader/webdavuploader.go
index 541a44d4b4a..93b3f9d2efa 100644
--- a/pkg/components/imguploader/webdavuploader.go
+++ b/pkg/components/imguploader/webdavuploader.go
@@ -4,9 +4,11 @@ import (
"bytes"
"fmt"
"io/ioutil"
+ "net"
"net/http"
"net/url"
"path"
+ "time"
"github.com/grafana/grafana/pkg/util"
)
@@ -17,6 +19,18 @@ type WebdavUploader struct {
password string
}
+var netTransport = &http.Transport{
+ Dial: (&net.Dialer{
+ Timeout: 60 * time.Second,
+ }).Dial,
+ TLSHandshakeTimeout: 5 * time.Second,
+}
+
+var netClient = &http.Client{
+ Timeout: time.Second * 60,
+ Transport: netTransport,
+}
+
func (u *WebdavUploader) Upload(pa string) (string, error) {
url, _ := url.Parse(u.url)
url.Path = path.Join(url.Path, util.GetRandomString(20)+".png")
@@ -28,7 +42,7 @@ func (u *WebdavUploader) Upload(pa string) (string, error) {
req.SetBasicAuth(u.username, u.password)
}
- res, err := http.DefaultClient.Do(req)
+ res, err := netClient.Do(req)
if err != nil {
return "", err
diff --git a/pkg/metrics/metrics.go b/pkg/metrics/metrics.go
index 1020f28f874..c23a53009a9 100644
--- a/pkg/metrics/metrics.go
+++ b/pkg/metrics/metrics.go
@@ -49,7 +49,9 @@ var (
M_Alerting_Notification_Sent_Victorops Counter
M_Alerting_Notification_Sent_OpsGenie Counter
M_Alerting_Notification_Sent_Telegram Counter
+ M_Alerting_Notification_Sent_Threema Counter
M_Alerting_Notification_Sent_Sensu Counter
+ M_Alerting_Notification_Sent_Pushover Counter
M_Aws_CloudWatch_GetMetricStatistics Counter
M_Aws_CloudWatch_ListMetrics Counter
@@ -118,8 +120,10 @@ func initMetricVars(settings *MetricSettings) {
M_Alerting_Notification_Sent_Victorops = RegCounter("alerting.notifications_sent", "type", "victorops")
M_Alerting_Notification_Sent_OpsGenie = RegCounter("alerting.notifications_sent", "type", "opsgenie")
M_Alerting_Notification_Sent_Telegram = RegCounter("alerting.notifications_sent", "type", "telegram")
+ M_Alerting_Notification_Sent_Threema = RegCounter("alerting.notifications_sent", "type", "threema")
M_Alerting_Notification_Sent_Sensu = RegCounter("alerting.notifications_sent", "type", "sensu")
M_Alerting_Notification_Sent_LINE = RegCounter("alerting.notifications_sent", "type", "LINE")
+ M_Alerting_Notification_Sent_Pushover = RegCounter("alerting.notifications_sent", "type", "pushover")
M_Aws_CloudWatch_GetMetricStatistics = RegCounter("aws.cloudwatch.get_metric_statistics")
M_Aws_CloudWatch_ListMetrics = RegCounter("aws.cloudwatch.list_metrics")
diff --git a/pkg/middleware/middleware_test.go b/pkg/middleware/middleware_test.go
index 5cffa0a2884..a1836a6744e 100644
--- a/pkg/middleware/middleware_test.go
+++ b/pkg/middleware/middleware_test.go
@@ -326,6 +326,7 @@ func middlewareScenario(desc string, fn scenarioFunc) {
// mock out gc goroutine
startSessionGC = func() {}
sc.m.Use(Sessioner(&session.Options{}))
+ sc.m.Use(OrgRedirect())
sc.defaultHandler = func(c *Context) {
sc.context = c
diff --git a/pkg/middleware/org_redirect.go b/pkg/middleware/org_redirect.go
new file mode 100644
index 00000000000..5945663d4d1
--- /dev/null
+++ b/pkg/middleware/org_redirect.go
@@ -0,0 +1,44 @@
+package middleware
+
+import (
+ "net/http"
+ "strconv"
+
+ "github.com/grafana/grafana/pkg/bus"
+ "github.com/grafana/grafana/pkg/models"
+
+ "gopkg.in/macaron.v1"
+)
+
+func OrgRedirect() macaron.Handler {
+ return func(res http.ResponseWriter, req *http.Request, c *macaron.Context) {
+ orgIdValue := req.URL.Query().Get("orgId")
+ orgId, err := strconv.ParseInt(orgIdValue, 10, 32)
+
+ if err != nil || orgId == 0 {
+ return
+ }
+
+ ctx, ok := c.Data["ctx"].(*Context)
+ if !ok || !ctx.IsSignedIn {
+ return
+ }
+
+ if orgId == ctx.OrgId {
+ return
+ }
+
+ cmd := models.SetUsingOrgCommand{UserId: ctx.UserId, OrgId: orgId}
+ if err := bus.Dispatch(&cmd); err != nil {
+ if ctx.IsApiRequest() {
+ ctx.JsonApiErr(404, "Not found", nil)
+ } else {
+ ctx.Error(404, "Not found")
+ }
+
+ return
+ }
+
+ c.Redirect(c.Req.URL.String(), 302)
+ }
+}
diff --git a/pkg/middleware/org_redirect_test.go b/pkg/middleware/org_redirect_test.go
new file mode 100644
index 00000000000..1f3d01f30f2
--- /dev/null
+++ b/pkg/middleware/org_redirect_test.go
@@ -0,0 +1,60 @@
+package middleware
+
+import (
+ "testing"
+
+ "fmt"
+
+ "github.com/grafana/grafana/pkg/bus"
+ "github.com/grafana/grafana/pkg/models"
+ . "github.com/smartystreets/goconvey/convey"
+)
+
+func TestOrgRedirectMiddleware(t *testing.T) {
+
+ Convey("Can redirect to correct org", t, func() {
+ middlewareScenario("when setting a correct org for the user", func(sc *scenarioContext) {
+ sc.fakeReq("GET", "/").handler(func(c *Context) {
+ c.Session.Set(SESS_KEY_USERID, int64(12))
+ }).exec()
+
+ bus.AddHandler("test", func(query *models.SetUsingOrgCommand) error {
+ return nil
+ })
+
+ bus.AddHandler("test", func(query *models.GetSignedInUserQuery) error {
+ query.Result = &models.SignedInUser{OrgId: 1, UserId: 12}
+ return nil
+ })
+
+ sc.m.Get("/", sc.defaultHandler)
+ sc.fakeReq("GET", "/?orgId=3").exec()
+
+ Convey("change org and redirect", func() {
+ So(sc.resp.Code, ShouldEqual, 302)
+ })
+ })
+
+ middlewareScenario("when setting an invalid org for user", func(sc *scenarioContext) {
+ sc.fakeReq("GET", "/").handler(func(c *Context) {
+ c.Session.Set(SESS_KEY_USERID, int64(12))
+ }).exec()
+
+ bus.AddHandler("test", func(query *models.SetUsingOrgCommand) error {
+ return fmt.Errorf("")
+ })
+
+ bus.AddHandler("test", func(query *models.GetSignedInUserQuery) error {
+ query.Result = &models.SignedInUser{OrgId: 1, UserId: 12}
+ return nil
+ })
+
+ sc.m.Get("/", sc.defaultHandler)
+ sc.fakeReq("GET", "/?orgId=3").exec()
+
+ Convey("not allowed to change org", func() {
+ So(sc.resp.Code, ShouldEqual, 404)
+ })
+ })
+ })
+}
diff --git a/pkg/middleware/session.go b/pkg/middleware/session.go
index 0700612ecc2..dad2ad20efc 100644
--- a/pkg/middleware/session.go
+++ b/pkg/middleware/session.go
@@ -1,6 +1,7 @@
package middleware
import (
+ "math/rand"
"time"
"github.com/go-macaron/session"
@@ -8,6 +9,7 @@ import (
_ "github.com/go-macaron/session/mysql"
_ "github.com/go-macaron/session/postgres"
_ "github.com/go-macaron/session/redis"
+ "github.com/grafana/grafana/pkg/log"
"gopkg.in/macaron.v1"
)
@@ -22,10 +24,12 @@ var sessionManager *session.Manager
var sessionOptions *session.Options
var startSessionGC func()
var getSessionCount func() int
+var sessionLogger = log.New("session")
func init() {
startSessionGC = func() {
sessionManager.GC()
+ sessionLogger.Debug("Session GC")
time.AfterFunc(time.Duration(sessionOptions.Gclifetime)*time.Second, startSessionGC)
}
getSessionCount = func() int {
@@ -67,7 +71,9 @@ func Sessioner(options *session.Options) macaron.Handler {
panic(err)
}
- go startSessionGC()
+ // start GC threads after some random seconds
+ rndSeconds := 10 + rand.Int63n(180)
+ time.AfterFunc(time.Duration(rndSeconds)*time.Second, startSessionGC)
return func(ctx *Context) {
ctx.Next()
diff --git a/pkg/models/alert.go b/pkg/models/alert.go
index 61976677764..fa3f4b466a8 100644
--- a/pkg/models/alert.go
+++ b/pkg/models/alert.go
@@ -35,6 +35,7 @@ const (
var (
ErrCannotChangeStateOnPausedAlert error = fmt.Errorf("Cannot change state on pause alert")
+ ErrRequiresNewState error = fmt.Errorf("update alert state requires a new state.")
)
func (s AlertStateType) IsValid() bool {
diff --git a/pkg/models/datasource.go b/pkg/models/datasource.go
index 4a90edd9bfd..804880a5d10 100644
--- a/pkg/models/datasource.go
+++ b/pkg/models/datasource.go
@@ -120,11 +120,16 @@ type UpdateDataSourceCommand struct {
Id int64 `json:"-"`
}
-type DeleteDataSourceCommand struct {
+type DeleteDataSourceByIdCommand struct {
Id int64
OrgId int64
}
+type DeleteDataSourceByNameCommand struct {
+ Name string
+ OrgId int64
+}
+
// ---------------------
// QUERIES
diff --git a/pkg/models/server.go b/pkg/models/server.go
index 876fc91dd01..4d683835256 100644
--- a/pkg/models/server.go
+++ b/pkg/models/server.go
@@ -1,10 +1,6 @@
package models
-import "context"
-
type GrafanaServer interface {
- context.Context
-
Start()
Shutdown(code int, reason string)
}
diff --git a/pkg/models/user.go b/pkg/models/user.go
index e14f4486ba3..e0a36be8c0a 100644
--- a/pkg/models/user.go
+++ b/pkg/models/user.go
@@ -130,7 +130,14 @@ type SearchUsersQuery struct {
Page int
Limit int
- Result []*UserSearchHitDTO
+ Result SearchUserQueryResult
+}
+
+type SearchUserQueryResult struct {
+ TotalCount int64 `json:"totalCount"`
+ Users []*UserSearchHitDTO `json:"users"`
+ Page int `json:"page"`
+ PerPage int `json:"perPage"`
}
type GetUserOrgListQuery struct {
diff --git a/pkg/services/alerting/engine.go b/pkg/services/alerting/engine.go
index b99b7506614..51d48287c14 100644
--- a/pkg/services/alerting/engine.go
+++ b/pkg/services/alerting/engine.go
@@ -98,7 +98,7 @@ func (e *Engine) processJob(grafanaCtx context.Context, job *Job) error {
}
}()
- alertCtx, cancelFn := context.WithTimeout(context.TODO(), alertTimeout)
+ alertCtx, cancelFn := context.WithTimeout(context.Background(), alertTimeout)
job.Running = true
evalContext := NewEvalContext(alertCtx, job.Rule)
diff --git a/pkg/services/alerting/eval_context.go b/pkg/services/alerting/eval_context.go
index 2b252da8c4b..e92edd2af12 100644
--- a/pkg/services/alerting/eval_context.go
+++ b/pkg/services/alerting/eval_context.go
@@ -113,7 +113,7 @@ func (c *EvalContext) GetRuleUrl() (string, error) {
if slug, err := c.GetDashboardSlug(); err != nil {
return "", err
} else {
- ruleUrl := fmt.Sprintf("%sdashboard/db/%s?fullscreen&edit&tab=alert&panelId=%d", setting.AppUrl, slug, c.Rule.PanelId)
+ ruleUrl := fmt.Sprintf("%sdashboard/db/%s?fullscreen&edit&tab=alert&panelId=%d&orgId=%d", setting.AppUrl, slug, c.Rule.PanelId, c.Rule.OrgId)
return ruleUrl, nil
}
}
diff --git a/pkg/services/alerting/interfaces.go b/pkg/services/alerting/interfaces.go
index 566fbdb2898..0955155575c 100644
--- a/pkg/services/alerting/interfaces.go
+++ b/pkg/services/alerting/interfaces.go
@@ -21,6 +21,18 @@ type Notifier interface {
GetIsDefault() bool
}
+type NotifierSlice []Notifier
+
+func (notifiers NotifierSlice) ShouldUploadImage() bool {
+ for _, notifier := range notifiers {
+ if notifier.NeedsImage() {
+ return true
+ }
+ }
+
+ return false
+}
+
type ConditionResult struct {
Firing bool
NoDataFound bool
diff --git a/pkg/services/alerting/notifier.go b/pkg/services/alerting/notifier.go
index 7e213058cd0..e831b566b22 100644
--- a/pkg/services/alerting/notifier.go
+++ b/pkg/services/alerting/notifier.go
@@ -21,37 +21,25 @@ type NotifierPlugin struct {
Factory NotifierFactory `json:"-"`
}
-type RootNotifier struct {
+type NotificationService interface {
+ Send(context *EvalContext) error
+}
+
+func NewNotificationService() NotificationService {
+ return newNotificationService()
+}
+
+type notificationService struct {
log log.Logger
}
-func NewRootNotifier() *RootNotifier {
- return &RootNotifier{
+func newNotificationService() *notificationService {
+ return ¬ificationService{
log: log.New("alerting.notifier"),
}
}
-func (n *RootNotifier) GetType() string {
- return "root"
-}
-
-func (n *RootNotifier) NeedsImage() bool {
- return false
-}
-
-func (n *RootNotifier) PassesFilter(rule *Rule) bool {
- return false
-}
-
-func (n *RootNotifier) GetNotifierId() int64 {
- return 0
-}
-
-func (n *RootNotifier) GetIsDefault() bool {
- return false
-}
-
-func (n *RootNotifier) Notify(context *EvalContext) error {
+func (n *notificationService) Send(context *EvalContext) error {
notifiers, err := n.getNotifiers(context.Rule.OrgId, context.Rule.Notifications, context)
if err != nil {
return err
@@ -63,14 +51,16 @@ func (n *RootNotifier) Notify(context *EvalContext) error {
return nil
}
- if err = n.uploadImage(context); err != nil {
- n.log.Error("Failed to upload alert panel image.", "error", err)
+ if notifiers.ShouldUploadImage() {
+ if err = n.uploadImage(context); err != nil {
+ n.log.Error("Failed to upload alert panel image.", "error", err)
+ }
}
return n.sendNotifications(context, notifiers)
}
-func (n *RootNotifier) sendNotifications(context *EvalContext, notifiers []Notifier) error {
+func (n *notificationService) sendNotifications(context *EvalContext, notifiers []Notifier) error {
g, _ := errgroup.WithContext(context.Ctx)
for _, notifier := range notifiers {
@@ -82,7 +72,7 @@ func (n *RootNotifier) sendNotifications(context *EvalContext, notifiers []Notif
return g.Wait()
}
-func (n *RootNotifier) uploadImage(context *EvalContext) (err error) {
+func (n *notificationService) uploadImage(context *EvalContext) (err error) {
uploader, err := imguploader.NewImageUploader()
if err != nil {
return err
@@ -116,7 +106,7 @@ func (n *RootNotifier) uploadImage(context *EvalContext) (err error) {
return nil
}
-func (n *RootNotifier) getNotifiers(orgId int64, notificationIds []int64, context *EvalContext) ([]Notifier, error) {
+func (n *notificationService) getNotifiers(orgId int64, notificationIds []int64, context *EvalContext) (NotifierSlice, error) {
query := &m.GetAlertNotificationsToSendQuery{OrgId: orgId, Ids: notificationIds}
if err := bus.Dispatch(query); err != nil {
@@ -137,7 +127,7 @@ func (n *RootNotifier) getNotifiers(orgId int64, notificationIds []int64, contex
return result, nil
}
-func (n *RootNotifier) createNotifierFor(model *m.AlertNotification) (Notifier, error) {
+func (n *notificationService) createNotifierFor(model *m.AlertNotification) (Notifier, error) {
notifierPlugin, found := notifierFactories[model.Type]
if !found {
return nil, errors.New("Unsupported notification type")
diff --git a/pkg/services/alerting/notifiers/base.go b/pkg/services/alerting/notifiers/base.go
index f1e748207d8..dc22e1acaa0 100644
--- a/pkg/services/alerting/notifiers/base.go
+++ b/pkg/services/alerting/notifiers/base.go
@@ -6,18 +6,22 @@ import (
)
type NotifierBase struct {
- Name string
- Type string
- Id int64
- IsDeault bool
+ Name string
+ Type string
+ Id int64
+ IsDeault bool
+ UploadImage bool
}
func NewNotifierBase(id int64, isDefault bool, name, notifierType string, model *simplejson.Json) NotifierBase {
+ uploadImage := model.Get("uploadImage").MustBool(true)
+
return NotifierBase{
- Id: id,
- Name: name,
- IsDeault: isDefault,
- Type: notifierType,
+ Id: id,
+ Name: name,
+ IsDeault: isDefault,
+ Type: notifierType,
+ UploadImage: uploadImage,
}
}
@@ -30,7 +34,7 @@ func (n *NotifierBase) GetType() string {
}
func (n *NotifierBase) NeedsImage() bool {
- return true
+ return n.UploadImage
}
func (n *NotifierBase) GetNotifierId() int64 {
diff --git a/pkg/services/alerting/notifiers/email.go b/pkg/services/alerting/notifiers/email.go
index 4058d3860b5..dcf71f0f99e 100644
--- a/pkg/services/alerting/notifiers/email.go
+++ b/pkg/services/alerting/notifiers/email.go
@@ -16,7 +16,7 @@ func init() {
alerting.RegisterNotifier(&alerting.NotifierPlugin{
Type: "email",
Name: "Email",
- Description: "Sends notifications using Grafana server configured STMP settings",
+ Description: "Sends notifications using Grafana server configured SMTP settings",
Factory: NewEmailNotifier,
OptionsTemplate: `
-
+
Email addresses
diff --git a/pkg/services/alerting/notifiers/hipchat.go b/pkg/services/alerting/notifiers/hipchat.go new file mode 100644 index 00000000000..ad649cb084d --- /dev/null +++ b/pkg/services/alerting/notifiers/hipchat.go @@ -0,0 +1,155 @@ +package notifiers + +import ( + "encoding/json" + "strconv" + "strings" + + "fmt" + + "github.com/grafana/grafana/pkg/bus" + "github.com/grafana/grafana/pkg/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: ` +HipChat settings
+
+ Hip Chat Url
+
+
+
+ API Key
+
+
+
+ Room ID
+
+
+
+ `,
+ })
+
+}
+
+const (
+ maxFieldCount int = 4
+)
+
+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.Id, model.IsDefault, model.Name, model.Type, model.Settings),
+ Url: url,
+ ApiKey: apikey,
+ RoomId: roomId,
+ log: log.New("alerting.notifier.hipchat"),
+ }, nil
+}
+
+type HipChatNotifier struct {
+ NotifierBase
+ Url string
+ ApiKey string
+ RoomId string
+ log log.Logger
+}
+
+func (this *HipChatNotifier) Notify(evalContext *alerting.EvalContext) error {
+ this.log.Info("Executing hipchat 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
+ }
+
+ message := evalContext.GetNotificationTitle() + " in state " + evalContext.GetStateModel().Text + "Check Dasboard" + fields := make([]map[string]interface{}, 0) + message += "
" + for index, evt := range evalContext.EvalMatches { + message += evt.Metric + " :: " + strconv.FormatFloat(evt.Value.Float64, 'f', -1, 64) + "
" + fields = append(fields, map[string]interface{}{ + "title": evt.Metric, + "value": evt.Value, + "short": true, + }) + if index > maxFieldCount { + break + } + } + + if evalContext.Error != nil { + fields = append(fields, map[string]interface{}{ + "title": "Error message", + "value": evalContext.Error.Error(), + "short": false, + }) + } + + if evalContext.Rule.State != models.AlertStateOK { //dont add message when going back to alert state ok. + message += " " + evalContext.Rule.Message + } + //HipChat has a set list of colors + var color string + switch evalContext.Rule.State { + case models.AlertStateOK: + color = "green" + case models.AlertStateNoData: + color = "grey" + case models.AlertStateAlerting: + color = "red" + } + + // Add a card with link to the dashboard + card := map[string]interface{}{ + "style": "link", + "url": ruleUrl, + "id": "1", + "title": evalContext.GetNotificationTitle(), + "description": evalContext.GetNotificationTitle() + " in state " + evalContext.GetStateModel().Text, + "icon": map[string]interface{}{ + "url": "http://grafana.org/assets/img/fav32.png", + }, + "date": evalContext.EndTime.Unix(), + } + + 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", this.Url, this.RoomId, this.ApiKey) + data, _ := json.Marshal(&body) + cmd := &models.SendWebhookSync{Url: hipUrl, Body: string(data)} + + if err := bus.DispatchCtx(evalContext.Ctx, cmd); err != nil { + this.log.Error("Failed to send hipchat notification", "error", err, "webhook", this.Name) + return err + } + + return nil +} diff --git a/pkg/services/alerting/notifiers/hipchat_test.go b/pkg/services/alerting/notifiers/hipchat_test.go new file mode 100644 index 00000000000..1597be12eb8 --- /dev/null +++ b/pkg/services/alerting/notifiers/hipchat_test.go @@ -0,0 +1,81 @@ +package notifiers + +import ( + "testing" + + "github.com/grafana/grafana/pkg/components/simplejson" + m "github.com/grafana/grafana/pkg/models" + . "github.com/smartystreets/goconvey/convey" +) + +func TestHipChatNotifier(t *testing.T) { + Convey("HipChat 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: "hipchat", + Settings: settingsJSON, + } + + _, err := NewHipChatNotifier(model) + So(err, ShouldNotBeNil) + }) + + Convey("from settings", func() { + json := ` + { + "url": "http://google.com" + }` + + settingsJSON, _ := simplejson.NewJson([]byte(json)) + model := &m.AlertNotification{ + Name: "ops", + Type: "hipchat", + Settings: settingsJSON, + } + + not, err := NewHipChatNotifier(model) + hipchatNotifier := not.(*HipChatNotifier) + + So(err, ShouldBeNil) + So(hipchatNotifier.Name, ShouldEqual, "ops") + So(hipchatNotifier.Type, ShouldEqual, "hipchat") + So(hipchatNotifier.Url, ShouldEqual, "http://google.com") + So(hipchatNotifier.ApiKey, ShouldEqual, "") + So(hipchatNotifier.RoomId, ShouldEqual, "") + }) + + Convey("from settings with Recipient and Mention", func() { + json := ` + { + "url": "http://www.hipchat.com", + "apikey": "1234", + "roomid": "1234" + }` + + settingsJSON, _ := simplejson.NewJson([]byte(json)) + model := &m.AlertNotification{ + Name: "ops", + Type: "hipchat", + Settings: settingsJSON, + } + + not, err := NewHipChatNotifier(model) + hipchatNotifier := not.(*HipChatNotifier) + + So(err, ShouldBeNil) + So(hipchatNotifier.Name, ShouldEqual, "ops") + So(hipchatNotifier.Type, ShouldEqual, "hipchat") + So(hipchatNotifier.Url, ShouldEqual, "http://www.hipchat.com") + So(hipchatNotifier.ApiKey, ShouldEqual, "1234") + So(hipchatNotifier.RoomId, ShouldEqual, "1234") + }) + + }) + }) +} diff --git a/pkg/services/alerting/notifiers/pushover.go b/pkg/services/alerting/notifiers/pushover.go new file mode 100644 index 00000000000..c68ad421c62 --- /dev/null +++ b/pkg/services/alerting/notifiers/pushover.go @@ -0,0 +1,177 @@ +package notifiers + +import ( + "fmt" + "net/url" + "strconv" + + "github.com/grafana/grafana/pkg/bus" + "github.com/grafana/grafana/pkg/log" + "github.com/grafana/grafana/pkg/metrics" + m "github.com/grafana/grafana/pkg/models" + "github.com/grafana/grafana/pkg/services/alerting" +) + +const PUSHOVER_ENDPOINT = "https://api.pushover.net/1/messages.json" + +func init() { + alerting.RegisterNotifier(&alerting.NotifierPlugin{ + Type: "pushover", + Name: "Pushover", + Description: "Sends HTTP POST request to the Pushover API", + Factory: NewPushoverNotifier, + OptionsTemplate: ` +
Pushover settings
+
+ API Token
+
+
+
+ User key(s)
+
+
+
+ Device(s) (optional)
+
+
+
+ Priority
+
+
+
+ Retry
+
+ Expire
+
+
+
+ Sound
+
+
+ `,
+ })
+}
+
+func NewPushoverNotifier(model *m.AlertNotification) (alerting.Notifier, error) {
+ userKey := model.Settings.Get("userKey").MustString()
+ apiToken := model.Settings.Get("apiToken").MustString()
+ device := model.Settings.Get("device").MustString()
+ priority, _ := strconv.Atoi(model.Settings.Get("priority").MustString())
+ retry, _ := strconv.Atoi(model.Settings.Get("retry").MustString())
+ expire, _ := strconv.Atoi(model.Settings.Get("expire").MustString())
+ sound := model.Settings.Get("sound").MustString()
+
+ if userKey == "" {
+ return nil, alerting.ValidationError{Reason: "User key not given"}
+ }
+ if apiToken == "" {
+ return nil, alerting.ValidationError{Reason: "API token not given"}
+ }
+ return &PushoverNotifier{
+ NotifierBase: NewNotifierBase(model.Id, model.IsDefault, model.Name, model.Type, model.Settings),
+ UserKey: userKey,
+ ApiToken: apiToken,
+ Priority: priority,
+ Retry: retry,
+ Expire: expire,
+ Device: device,
+ Sound: sound,
+ log: log.New("alerting.notifier.pushover"),
+ }, nil
+}
+
+type PushoverNotifier struct {
+ NotifierBase
+ UserKey string
+ ApiToken string
+ Priority int
+ Retry int
+ Expire int
+ Device string
+ Sound string
+ log log.Logger
+}
+
+func (this *PushoverNotifier) Notify(evalContext *alerting.EvalContext) error {
+ metrics.M_Alerting_Notification_Sent_Pushover.Inc(1)
+ ruleUrl, err := evalContext.GetRuleUrl()
+ if err != nil {
+ this.log.Error("Failed get rule link", "error", err)
+ return err
+ }
+ message := evalContext.Rule.Message
+ for idx, evt := range evalContext.EvalMatches {
+ message += fmt.Sprintf("\n%s: %v", evt.Metric, evt.Value)
+ if idx > 4 {
+ break
+ }
+ }
+ if evalContext.Error != nil {
+ message += fmt.Sprintf("\nError message %s", evalContext.Error.Error())
+ }
+ q := url.Values{}
+ q.Add("user", this.UserKey)
+ q.Add("token", this.ApiToken)
+ q.Add("priority", strconv.Itoa(this.Priority))
+ if this.Priority == 2 {
+ q.Add("retry", strconv.Itoa(this.Retry))
+ q.Add("expire", strconv.Itoa(this.Expire))
+ }
+ if this.Device != "" {
+ q.Add("device", this.Device)
+ }
+ if this.Sound != "default" {
+ q.Add("sound", this.Sound)
+ }
+ q.Add("title", evalContext.GetNotificationTitle())
+ q.Add("url", ruleUrl)
+ q.Add("url_title", "Show dashboard with alert")
+ q.Add("message", message)
+ q.Add("html", "1")
+
+ cmd := &m.SendWebhookSync{
+ Url: PUSHOVER_ENDPOINT,
+ HttpMethod: "POST",
+ HttpHeader: map[string]string{"Content-Type": "application/x-www-form-urlencoded"},
+ Body: q.Encode(),
+ }
+
+ if err := bus.DispatchCtx(evalContext.Ctx, cmd); err != nil {
+ this.log.Error("Failed to send pushover notification", "error", err, "webhook", this.Name)
+ return err
+ }
+
+ return nil
+}
diff --git a/pkg/services/alerting/notifiers/pushover_test.go b/pkg/services/alerting/notifiers/pushover_test.go
new file mode 100644
index 00000000000..a3bac73e065
--- /dev/null
+++ b/pkg/services/alerting/notifiers/pushover_test.go
@@ -0,0 +1,58 @@
+package notifiers
+
+import (
+ "testing"
+
+ "github.com/grafana/grafana/pkg/components/simplejson"
+ m "github.com/grafana/grafana/pkg/models"
+ . "github.com/smartystreets/goconvey/convey"
+)
+
+func TestPushoverNotifier(t *testing.T) {
+ Convey("Pushover 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: "Pushover",
+ Type: "pushover",
+ Settings: settingsJSON,
+ }
+
+ _, err := NewPushoverNotifier(model)
+ So(err, ShouldNotBeNil)
+ })
+
+ Convey("from settings", func() {
+ json := `
+ {
+ "apiToken": "4SrUFQL4A5V5TQ1z5Pg9nxHXPXSTve",
+ "userKey": "tzNZYf36y0ohWwXo4XoUrB61rz1A4o",
+ "priority": "1",
+ "sound": "pushover"
+ }`
+
+ settingsJSON, _ := simplejson.NewJson([]byte(json))
+ model := &m.AlertNotification{
+ Name: "Pushover",
+ Type: "pushover",
+ Settings: settingsJSON,
+ }
+
+ not, err := NewPushoverNotifier(model)
+ pushoverNotifier := not.(*PushoverNotifier)
+
+ So(err, ShouldBeNil)
+ So(pushoverNotifier.Name, ShouldEqual, "Pushover")
+ So(pushoverNotifier.Type, ShouldEqual, "pushover")
+ So(pushoverNotifier.ApiToken, ShouldEqual, "4SrUFQL4A5V5TQ1z5Pg9nxHXPXSTve")
+ So(pushoverNotifier.UserKey, ShouldEqual, "tzNZYf36y0ohWwXo4XoUrB61rz1A4o")
+ So(pushoverNotifier.Priority, ShouldEqual, 1)
+ So(pushoverNotifier.Sound, ShouldEqual, "pushover")
+ })
+ })
+ })
+}
diff --git a/pkg/services/alerting/notifiers/threema.go b/pkg/services/alerting/notifiers/threema.go
new file mode 100644
index 00000000000..80c84c26a24
--- /dev/null
+++ b/pkg/services/alerting/notifiers/threema.go
@@ -0,0 +1,171 @@
+package notifiers
+
+import (
+ "fmt"
+ "net/url"
+ "strings"
+
+ "github.com/grafana/grafana/pkg/bus"
+ "github.com/grafana/grafana/pkg/log"
+ "github.com/grafana/grafana/pkg/metrics"
+ m "github.com/grafana/grafana/pkg/models"
+ "github.com/grafana/grafana/pkg/services/alerting"
+)
+
+var (
+ threemaGwBaseURL = "https://msgapi.threema.ch/%s"
+)
+
+func init() {
+ alerting.RegisterNotifier(&alerting.NotifierPlugin{
+ Type: "threema",
+ Name: "Threema Gateway",
+ Description: "Sends notifications to Threema using the Threema Gateway",
+ Factory: NewThreemaNotifier,
+ OptionsTemplate: `
+ Threema Gateway settings
++ Notifications can be configured for any Threema Gateway ID of type + "Basic". End-to-End IDs are not currently supported. +
++ The Threema Gateway ID can be set up at + https://gateway.threema.ch/. +
+
+ Gateway ID
+
+
+
+ Your 8 character Threema Gateway ID (starting with a *)
+
+
+
+ Recipient ID
+
+
+
+ The 8 character Threema ID that should receive the alerts
+
+
+
+ API Secret
+
+
+
+ Your Threema Gateway API secret
+
+
+ `,
+ })
+
+}
+
+type ThreemaNotifier struct {
+ NotifierBase
+ GatewayID string
+ RecipientID string
+ APISecret string
+ log log.Logger
+}
+
+func NewThreemaNotifier(model *m.AlertNotification) (alerting.Notifier, error) {
+ if model.Settings == nil {
+ return nil, alerting.ValidationError{Reason: "No Settings Supplied"}
+ }
+
+ gatewayID := model.Settings.Get("gateway_id").MustString()
+ recipientID := model.Settings.Get("recipient_id").MustString()
+ apiSecret := model.Settings.Get("api_secret").MustString()
+
+ // Validation
+ if gatewayID == "" {
+ return nil, alerting.ValidationError{Reason: "Could not find Threema Gateway ID in settings"}
+ }
+ if !strings.HasPrefix(gatewayID, "*") {
+ return nil, alerting.ValidationError{Reason: "Invalid Threema Gateway ID: Must start with a *"}
+ }
+ if len(gatewayID) != 8 {
+ return nil, alerting.ValidationError{Reason: "Invalid Threema Gateway ID: Must be 8 characters long"}
+ }
+ if recipientID == "" {
+ return nil, alerting.ValidationError{Reason: "Could not find Threema Recipient ID in settings"}
+ }
+ if len(recipientID) != 8 {
+ return nil, alerting.ValidationError{Reason: "Invalid Threema Recipient ID: Must be 8 characters long"}
+ }
+ if apiSecret == "" {
+ return nil, alerting.ValidationError{Reason: "Could not find Threema API secret in settings"}
+ }
+
+ return &ThreemaNotifier{
+ NotifierBase: NewNotifierBase(model.Id, model.IsDefault, model.Name, model.Type, model.Settings),
+ GatewayID: gatewayID,
+ RecipientID: recipientID,
+ APISecret: apiSecret,
+ log: log.New("alerting.notifier.threema"),
+ }, nil
+}
+
+func (notifier *ThreemaNotifier) Notify(evalContext *alerting.EvalContext) error {
+ notifier.log.Info("Sending alert notification from", "threema_id", notifier.GatewayID)
+ notifier.log.Info("Sending alert notification to", "threema_id", notifier.RecipientID)
+ metrics.M_Alerting_Notification_Sent_Threema.Inc(1)
+
+ // Set up basic API request data
+ data := url.Values{}
+ data.Set("from", notifier.GatewayID)
+ data.Set("to", notifier.RecipientID)
+ data.Set("secret", notifier.APISecret)
+
+ // Determine emoji
+ stateEmoji := ""
+ switch evalContext.Rule.State {
+ case m.AlertStateOK:
+ stateEmoji = "\u2705 " // White Heavy Check Mark
+ case m.AlertStateNoData:
+ stateEmoji = "\u2753 " // Black Question Mark Ornament
+ case m.AlertStateAlerting:
+ stateEmoji = "\u26A0 " // Warning sign
+ }
+
+ // Build message
+ message := fmt.Sprintf("%s%s\n\n*State:* %s\n*Message:* %s\n",
+ stateEmoji, evalContext.GetNotificationTitle(),
+ evalContext.Rule.Name, evalContext.Rule.Message)
+ ruleURL, err := evalContext.GetRuleUrl()
+ if err == nil {
+ message = message + fmt.Sprintf("*URL:* %s\n", ruleURL)
+ }
+ if evalContext.ImagePublicUrl != "" {
+ message = message + fmt.Sprintf("*Image:* %s\n", evalContext.ImagePublicUrl)
+ }
+ data.Set("text", message)
+
+ // Prepare and send request
+ url := fmt.Sprintf(threemaGwBaseURL, "send_simple")
+ body := data.Encode()
+ headers := map[string]string{
+ "Content-Type": "application/x-www-form-urlencoded",
+ }
+ cmd := &m.SendWebhookSync{
+ Url: url,
+ Body: body,
+ HttpMethod: "POST",
+ HttpHeader: headers,
+ }
+ if err := bus.DispatchCtx(evalContext.Ctx, cmd); err != nil {
+ notifier.log.Error("Failed to send webhook", "error", err, "webhook", notifier.Name)
+ return err
+ }
+
+ return nil
+}
diff --git a/pkg/services/alerting/notifiers/threema_test.go b/pkg/services/alerting/notifiers/threema_test.go
new file mode 100644
index 00000000000..3f23730a249
--- /dev/null
+++ b/pkg/services/alerting/notifiers/threema_test.go
@@ -0,0 +1,119 @@
+package notifiers
+
+import (
+ "testing"
+
+ "github.com/grafana/grafana/pkg/components/simplejson"
+ m "github.com/grafana/grafana/pkg/models"
+ "github.com/grafana/grafana/pkg/services/alerting"
+ . "github.com/smartystreets/goconvey/convey"
+)
+
+func TestThreemaNotifier(t *testing.T) {
+ Convey("Threema 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: "threema_testing",
+ Type: "threema",
+ Settings: settingsJSON,
+ }
+
+ _, err := NewThreemaNotifier(model)
+ So(err, ShouldNotBeNil)
+ })
+
+ Convey("valid settings should be parsed successfully", func() {
+ json := `
+ {
+ "gateway_id": "*3MAGWID",
+ "recipient_id": "ECHOECHO",
+ "api_secret": "1234"
+ }`
+
+ settingsJSON, _ := simplejson.NewJson([]byte(json))
+ model := &m.AlertNotification{
+ Name: "threema_testing",
+ Type: "threema",
+ Settings: settingsJSON,
+ }
+
+ not, err := NewThreemaNotifier(model)
+ So(err, ShouldBeNil)
+ threemaNotifier := not.(*ThreemaNotifier)
+
+ So(err, ShouldBeNil)
+ So(threemaNotifier.Name, ShouldEqual, "threema_testing")
+ So(threemaNotifier.Type, ShouldEqual, "threema")
+ So(threemaNotifier.GatewayID, ShouldEqual, "*3MAGWID")
+ So(threemaNotifier.RecipientID, ShouldEqual, "ECHOECHO")
+ So(threemaNotifier.APISecret, ShouldEqual, "1234")
+ })
+
+ Convey("invalid Threema Gateway IDs should be rejected (prefix)", func() {
+ json := `
+ {
+ "gateway_id": "ECHOECHO",
+ "recipient_id": "ECHOECHO",
+ "api_secret": "1234"
+ }`
+
+ settingsJSON, _ := simplejson.NewJson([]byte(json))
+ model := &m.AlertNotification{
+ Name: "threema_testing",
+ Type: "threema",
+ Settings: settingsJSON,
+ }
+
+ not, err := NewThreemaNotifier(model)
+ So(not, ShouldBeNil)
+ So(err.(alerting.ValidationError).Reason, ShouldEqual, "Invalid Threema Gateway ID: Must start with a *")
+ })
+
+ Convey("invalid Threema Gateway IDs should be rejected (length)", func() {
+ json := `
+ {
+ "gateway_id": "*ECHOECHO",
+ "recipient_id": "ECHOECHO",
+ "api_secret": "1234"
+ }`
+
+ settingsJSON, _ := simplejson.NewJson([]byte(json))
+ model := &m.AlertNotification{
+ Name: "threema_testing",
+ Type: "threema",
+ Settings: settingsJSON,
+ }
+
+ not, err := NewThreemaNotifier(model)
+ So(not, ShouldBeNil)
+ So(err.(alerting.ValidationError).Reason, ShouldEqual, "Invalid Threema Gateway ID: Must be 8 characters long")
+ })
+
+ Convey("invalid Threema Recipient IDs should be rejected (length)", func() {
+ json := `
+ {
+ "gateway_id": "*3MAGWID",
+ "recipient_id": "ECHOECH",
+ "api_secret": "1234"
+ }`
+
+ settingsJSON, _ := simplejson.NewJson([]byte(json))
+ model := &m.AlertNotification{
+ Name: "threema_testing",
+ Type: "threema",
+ Settings: settingsJSON,
+ }
+
+ not, err := NewThreemaNotifier(model)
+ So(not, ShouldBeNil)
+ So(err.(alerting.ValidationError).Reason, ShouldEqual, "Invalid Threema Recipient ID: Must be 8 characters long")
+ })
+
+ })
+ })
+}
diff --git a/pkg/services/alerting/result_handler.go b/pkg/services/alerting/result_handler.go
index 6b31dd4f951..1298a5dda36 100644
--- a/pkg/services/alerting/result_handler.go
+++ b/pkg/services/alerting/result_handler.go
@@ -16,14 +16,14 @@ type ResultHandler interface {
}
type DefaultResultHandler struct {
- notifier Notifier
+ notifier NotificationService
log log.Logger
}
func NewResultHandler() *DefaultResultHandler {
return &DefaultResultHandler{
log: log.New("alerting.resultHandler"),
- notifier: NewRootNotifier(),
+ notifier: NewNotificationService(),
}
}
@@ -61,6 +61,12 @@ func (handler *DefaultResultHandler) Handle(evalContext *EvalContext) error {
handler.log.Error("Cannot change state on alert thats pause", "error", err)
return err
}
+
+ if err == m.ErrRequiresNewState {
+ handler.log.Info("Alert already updated")
+ return nil
+ }
+
handler.log.Error("Failed to save state", "error", err)
}
@@ -85,7 +91,7 @@ func (handler *DefaultResultHandler) Handle(evalContext *EvalContext) error {
}
if evalContext.ShouldSendNotification() {
- handler.notifier.Notify(evalContext)
+ handler.notifier.Send(evalContext)
}
}
diff --git a/pkg/services/alerting/test_notification.go b/pkg/services/alerting/test_notification.go
index a40d0ac3c5c..91b3814ac7b 100644
--- a/pkg/services/alerting/test_notification.go
+++ b/pkg/services/alerting/test_notification.go
@@ -23,7 +23,7 @@ func init() {
}
func handleNotificationTestCommand(cmd *NotificationTestCommand) error {
- notifier := NewRootNotifier()
+ notifier := newNotificationService()
model := &m.AlertNotification{
Name: cmd.Name,
@@ -38,10 +38,10 @@ func handleNotificationTestCommand(cmd *NotificationTestCommand) error {
return err
}
- return notifier.sendNotifications(createTestEvalContext(), []Notifier{notifiers})
+ return notifier.sendNotifications(createTestEvalContext(cmd), []Notifier{notifiers})
}
-func createTestEvalContext() *EvalContext {
+func createTestEvalContext(cmd *NotificationTestCommand) *EvalContext {
testRule := &Rule{
DashboardId: 1,
PanelId: 1,
@@ -50,8 +50,10 @@ func createTestEvalContext() *EvalContext {
State: m.AlertStateAlerting,
}
- ctx := NewEvalContext(context.TODO(), testRule)
- ctx.ImagePublicUrl = "http://grafana.org/assets/img/blog/mixed_styles.png"
+ ctx := NewEvalContext(context.Background(), testRule)
+ if cmd.Settings.Get("uploadImage").MustBool(true) {
+ ctx.ImagePublicUrl = "http://grafana.org/assets/img/blog/mixed_styles.png"
+ }
ctx.IsTestRun = true
ctx.Firing = true
ctx.Error = nil
diff --git a/pkg/services/alerting/test_rule.go b/pkg/services/alerting/test_rule.go
index 82b1a6276a1..e3aa95e0ede 100644
--- a/pkg/services/alerting/test_rule.go
+++ b/pkg/services/alerting/test_rule.go
@@ -49,7 +49,7 @@ func handleAlertTestCommand(cmd *AlertTestCommand) error {
func testAlertRule(rule *Rule) *EvalContext {
handler := NewEvalHandler()
- context := NewEvalContext(context.TODO(), rule)
+ context := NewEvalContext(context.Background(), rule)
context.IsTestRun = true
handler.Eval(context)
diff --git a/pkg/services/annotations/annotations.go b/pkg/services/annotations/annotations.go
index 3fc3bafe5c5..d9d15bca34b 100644
--- a/pkg/services/annotations/annotations.go
+++ b/pkg/services/annotations/annotations.go
@@ -11,14 +11,14 @@ type Repository interface {
type ItemQuery struct {
OrgId int64 `json:"orgId"`
From int64 `json:"from"`
- To int64 `json:"from"`
+ To int64 `json:"to"`
Type ItemType `json:"type"`
AlertId int64 `json:"alertId"`
DashboardId int64 `json:"dashboardId"`
PanelId int64 `json:"panelId"`
NewState []string `json:"newState"`
- Limit int64 `json:"alertId"`
+ Limit int64 `json:"limit"`
}
type DeleteParams struct {
@@ -48,7 +48,7 @@ type Item struct {
OrgId int64 `json:"orgId"`
DashboardId int64 `json:"dashboardId"`
PanelId int64 `json:"panelId"`
- CategoryId int64 `json:"panelId"`
+ CategoryId int64 `json:"categoryId"`
Type ItemType `json:"type"`
Title string `json:"title"`
Text string `json:"text"`
diff --git a/pkg/services/notifications/mailer.go b/pkg/services/notifications/mailer.go
index 1ca4df8877a..ae1348cbf99 100644
--- a/pkg/services/notifications/mailer.go
+++ b/pkg/services/notifications/mailer.go
@@ -150,7 +150,7 @@ func buildEmailMessage(cmd *m.SendEmailCommand) (*Message, error) {
return &Message{
To: cmd.To,
- From: setting.Smtp.FromAddress,
+ From: fmt.Sprintf("%s <%s>", setting.Smtp.FromName, setting.Smtp.FromAddress),
Subject: subject,
Body: buffer.String(),
EmbededFiles: cmd.EmbededFiles,
diff --git a/pkg/services/notifications/notifications.go b/pkg/services/notifications/notifications.go
index 095ce15ef32..c765774d062 100644
--- a/pkg/services/notifications/notifications.go
+++ b/pkg/services/notifications/notifications.go
@@ -48,7 +48,7 @@ func Init() error {
}
if !util.IsEmail(setting.Smtp.FromAddress) {
- return errors.New("Invalid email address for smpt from_adress config")
+ return errors.New("Invalid email address for SMTP from_address config")
}
if setting.EmailCodeValidMinutes == 0 {
diff --git a/pkg/services/notifications/notifications_test.go b/pkg/services/notifications/notifications_test.go
index 79db664e893..3a5ff5fedb7 100644
--- a/pkg/services/notifications/notifications_test.go
+++ b/pkg/services/notifications/notifications_test.go
@@ -23,6 +23,7 @@ func TestNotifications(t *testing.T) {
setting.Smtp.Enabled = true
setting.Smtp.TemplatesPattern = "emails/*.html"
setting.Smtp.FromAddress = "from@address.com"
+ setting.Smtp.FromName = "Grafana Admin"
err := Init()
So(err, ShouldBeNil)
diff --git a/pkg/services/notifications/send_email_integration_test.go b/pkg/services/notifications/send_email_integration_test.go
index 1a4406dc13a..a9a5215d3ca 100644
--- a/pkg/services/notifications/send_email_integration_test.go
+++ b/pkg/services/notifications/send_email_integration_test.go
@@ -18,12 +18,15 @@ func TestEmailIntegrationTest(t *testing.T) {
setting.Smtp.Enabled = true
setting.Smtp.TemplatesPattern = "emails/*.html"
setting.Smtp.FromAddress = "from@address.com"
+ setting.Smtp.FromName = "Grafana Admin"
setting.BuildVersion = "4.0.0"
err := Init()
So(err, ShouldBeNil)
addToMailQueue = func(msg *Message) {
+ So(msg.From, ShouldEqual, "Grafana Admin
-
+
diff --git a/public/app/features/alerting/alert_list_ctrl.ts b/public/app/features/alerting/alert_list_ctrl.ts
index 78713ee0c4c..c74f61c8a1c 100644
--- a/public/app/features/alerting/alert_list_ctrl.ts
+++ b/public/app/features/alerting/alert_list_ctrl.ts
@@ -15,6 +15,7 @@ export class AlertListCtrl {
{text: 'OK', value: 'ok'},
{text: 'Alerting', value: 'alerting'},
{text: 'No Data', value: 'no_data'},
+ {text: 'Paused', value: 'paused'},
];
filters = {
diff --git a/public/app/features/alerting/alert_tab_ctrl.ts b/public/app/features/alerting/alert_tab_ctrl.ts
index 89b1c63372f..b21e5363ad8 100644
--- a/public/app/features/alerting/alert_tab_ctrl.ts
+++ b/public/app/features/alerting/alert_tab_ctrl.ts
@@ -104,6 +104,8 @@ export class AlertTabCtrl {
case "webhook": return "fa fa-cubes";
case "pagerduty": return "fa fa-bullhorn";
case "opsgenie": return "fa fa-bell";
+ case "hipchat": return "fa fa-mail-forward";
+ case "pushover": return "fa fa-mobile";
}
}
diff --git a/public/app/features/alerting/notification_edit_ctrl.ts b/public/app/features/alerting/notification_edit_ctrl.ts
index 39c9d8ca468..6ad11cb9023 100644
--- a/public/app/features/alerting/notification_edit_ctrl.ts
+++ b/public/app/features/alerting/notification_edit_ctrl.ts
@@ -17,6 +17,7 @@ export class AlertNotificationEditCtrl {
settings: {
httpMethod: 'POST',
autoResolve: true,
+ uploadImage: true,
},
isDefault: false
};
@@ -32,7 +33,7 @@ export class AlertNotificationEditCtrl {
}
if (!this.$routeParams.id) {
- return this.model;
+ return _.defaults(this.model, this.defaults);
}
return this.backendSrv.get(`/api/alert-notifications/${this.$routeParams.id}`).then(result => {
diff --git a/public/app/features/alerting/partials/alert_tab.html b/public/app/features/alerting/partials/alert_tab.html
index 8b11ec4ebc1..76841db75ba 100644
--- a/public/app/features/alerting/partials/alert_tab.html
+++ b/public/app/features/alerting/partials/alert_tab.html
@@ -47,7 +47,7 @@
OF
+
+
+
+
+
+
+
+
-
-
+
+
+
+ | Id | +Name | +Login | +Grafana Admin | ++ | |
|---|---|---|---|---|---|
| {{user.id}} | +{{user.name}} | +{{user.login}} | +{{user.email}} | +{{user.isAdmin}} | ++ + + Edit + + + + + + | +
| Id | -Name | -Login | -Grafana Admin | -- | |
|---|---|---|---|---|---|
| {{user.id}} | -{{user.name}} | -{{user.login}} | -{{user.email}} | -{{user.isAdmin}} | -- - - Edit - - - - - - | -
+
-
+
- + + +