-[Grafana.net](https://grafana.net) offers a central repository where the community can come together to discover, create and
+[Grafana.com](https://grafana.com) offers a central repository where the community can come together to discover, create and
share plugins (data sources, panels, apps) and dashboards.
We are also working on a hosted Graphite-compatible data source that will be optimized for use with Grafana.
-It’ll be easy to combine your existing data source(s) with this OpenSaaS option. Finally, Grafana.net can
+It’ll be easy to combine your existing data source(s) with this OpenSaaS option. Finally, Grafana.com can
also be a hub to manage all your Grafana instances. You’ll be able to monitor their health and availability,
perform dashboard backups, and more.
@@ -57,12 +57,12 @@ We are also working on a hosted Graphite-compatible Data Source that
will be optimized for use with Grafana. It’ll be easy to combine your
existing Data Source(s) with this OpenSaaS option.
-Finally, Grafana.net will also be a hub to manage all your Grafana
+Finally, Grafana.com will also be a hub to manage all your Grafana
instances. You’ll be able to monitor their health and availability,
perform Dashboard backups, and more.
Grafana.net will officially launch along with the stable version of
-Grafana 3.0, but 
-#### [Pie Chart Panel](https://grafana.net/plugins/grafana-piechart-panel)
+#### [Pie Chart Panel](https://grafana.com/plugins/grafana-piechart-panel)
A simple pie chart panel is now available as an external plugin.
-#### [WorldPing App](https://grafana.net/plugins/raintank-worldping-app)
+#### [WorldPing App](https://grafana.com/plugins/raintank-worldping-app)
This is full blown Grafana App that adds new panels, data sources and pages to give
feature rich global performance monitoring directly from your on-prem Grafana.
-#### [Zabbix App](https://grafana.net/plugins/alexanderzobnin-zabbix-app)
+#### [Zabbix App](https://grafana.com/plugins/alexanderzobnin-zabbix-app)
This app contains the already very pouplar Zabbix data source plugin, 2 dashboards and a triggers panel. It is
created and maintained by [Alexander Zobnin](https://github.com/alexanderzobnin/grafana-zabbix).
-Checkout the full list of plugins on [Grafana.net](https://grafana.net/plugins)
+Checkout the full list of plugins on [Grafana.com](https://grafana.com/plugins)
## CHANGELOG
diff --git a/docs/sources/guides/whats-new-in-v4-1.md b/docs/sources/guides/whats-new-in-v4-1.md
index 59e6236af40..bd2b0f1b75f 100644
--- a/docs/sources/guides/whats-new-in-v4-1.md
+++ b/docs/sources/guides/whats-new-in-v4-1.md
@@ -7,7 +7,7 @@ type = "docs"
name = "Version 4.1"
identifier = "v4.1"
parent = "whatsnew"
-weight = -1
+weight = 3
+++
diff --git a/docs/sources/guides/whats-new-in-v4-2.md b/docs/sources/guides/whats-new-in-v4-2.md
new file mode 100644
index 00000000000..44aa3a45dc0
--- /dev/null
+++ b/docs/sources/guides/whats-new-in-v4-2.md
@@ -0,0 +1,88 @@
++++
+title = "What's New in Grafana v4.2"
+description = "Feature & improvement highlights for Grafana v4.2"
+keywords = ["grafana", "new", "documentation", "4.2.0"]
+type = "docs"
+[menu.docs]
+name = "Version 4.2"
+identifier = "v4.2"
+parent = "whatsnew"
+weight = -1
++++
+
+## Whats new in Grafana v4.2
+
+Grafana v4.2 Beta is now [available for download](/download/4_2_0/).
+Just like the last release this one contains lots bug fixes and minor improvements.
+We are very happy to say that 27 of 40 issues was closed by pull requests from the community.
+Big thumbs up!
+
+## Release Highlights
+
+- **Hipchat**: Adds support for sending alert notifications to hipchat [#6451](https://github.com/grafana/grafana/issues/6451), thx [@jregovic](https://github.com/jregovic)
+- **Telegram**: Added Telegram alert notifier [#7098](https://github.com/grafana/grafana/pull/7098), thx [@leonoff](https://github.com/leonoff)
+- **LINE**: Add LINE as alerting notification channel [#7301](https://github.com/grafana/grafana/pull/7301), thx [@huydx](https://github.com/huydx)
+- **Templating**: Make $__interval and $__interval_ms global built in variables that can be used in by any datasource (in panel queries), closes [#7190](https://github.com/grafana/grafana/issues/7190), closes [#6582](https://github.com/grafana/grafana/issues/6582)
+- **Alerting**: Adds deduping of alert notifications [#7632](https://github.com/grafana/grafana/pull/7632)
+- **Alerting**: Better information about why an alert triggered [#7035](https://github.com/grafana/grafana/issues/7035)
+- **Orgs**: Sharing dashboards using Grafana share feature will now redirect to correct org. [#6948](https://github.com/grafana/grafana/issues/6948)
+- [Full changelog](https://github.com/grafana/grafana/blob/master/CHANGELOG.md)
+
+### New alert notification channels
+
+This release adds **five** new alert notifications channels, all of them contributed by the community.
+
+* Hipchat
+* Telegram
+* LINE
+* Pushover
+* Threema
+
+### Templating
+
+We added two new global built in variables in grafana. `$__interval` and `$__interval_ms` are now reserved template names in grafana and can be used by any datasource.
+We might add more global built in variables in the future and if we do we will prefix them with `$__`. So please avoid using that in your template variables.
+
+### Dedupe alert notifications when running multiple servers
+
+In this release we will dedupe alert notificiations when you are running multiple servers.
+This makes it possible to run alerting on multiple servers and only get one notification.
+
+We currently solve this with sql transactions which puts some limitations for how many servers you can use to execute the same rules.
+3-5 servers should not be a problem but as always, it depends on how many alerts you have and how frequently they execute.
+
+Next up for a better HA situation is to add support for workload balancing between Grafana servers.
+
+### Alerting more info
+
+You can now see the reason why an alert triggered in the alert history. Its also easier to detect when an alert is set to `alerting` due to the `no_data` option.
+
+### Improved support for multi-org setup
+
+When loading dashboards we now set an query parameter called orgId. So we can detect from which org an user shared a dashboard.
+This makes it possible for users to share dashboards between orgs without changing org first.
+
+We aim to introduce [dashboard groups](https://github.com/grafana/grafana/issues/1611) sometime in the future which will introduce access control and user groups within one org.
+Making it possible to have users in multiple groups and have detailed access control.
+
+## Upgrade & Breaking changes
+
+If your using https in grafana we now force you to use tls 1.2 and the most secure ciphers.
+We think its better to be secure by default rather then making it configurable.
+If you want to run https with lower versions of tls we suggest you put a reserve proxy in front of grafana.
+
+If you have template variables name `$__interval` or `$__interval_ms` they will no longer work since these keywords
+are reserved as global built in variables. We might add more global built in variables in the future and if we do, we will prefix them with `$__`. So please avoid using that in your template variables.
+
+## Changelog
+
+Checkout the [CHANGELOG.md](https://github.com/grafana/grafana/blob/master/CHANGELOG.md) file for a complete list
+of new features, changes, and bug fixes.
+
+## Download
+
+Head to [v4.2-beta download page](/download/4_2_0/) for download links & instructions.
+
+## Thanks
+
+A big thanks to all the Grafana users who contribute by submitting PRs, bug reports & feedback!
diff --git a/docs/sources/guides/whats-new-in-v4.md b/docs/sources/guides/whats-new-in-v4.md
index cfd454cdc23..68a40ed7a1e 100644
--- a/docs/sources/guides/whats-new-in-v4.md
+++ b/docs/sources/guides/whats-new-in-v4.md
@@ -27,7 +27,7 @@ notifications will be sent out when the rule conditions are met.
This feature has been worked on for over a year with many iterations and rewrites
just to make sure the foundations are really solid. We are really proud to finally release it!
-Since the alerting execution is processed in the backend all data source plugins are not supported.
+Since the alerting execution is processed in the backend not all data source plugins are supported.
Right now Graphite, Prometheus, InfluxDB and OpenTSDB are supported. Elasticsearch is being worked
on but will be not ready for v4 release.
@@ -70,8 +70,8 @@ to add graph comments in the form of annotations directly from within Grafana in
{{< imgbox max-width="30%" img="/img/docs/v4/alert_list_panel.png" caption="Alert List Panel" >}}
-This new panel allows you to show alert rules or a history of alert rule state changes. You can filter based on states your
-interested in. Very useful panel for overview style dashboards.
+This new panel allows you to show alert rules or a history of alert rule state changes. You can filter based on states you are
+interested in. This panel is very useful for overview style dashboards.
@@ -79,8 +79,8 @@ interested in. Very useful panel for overview style dashboards.
{{< imgbox max-width="30%" img="/img/docs/v4/adhoc_filters.gif" caption="Ad-hoc filters variable" >}}
-This is a new and very different type of template variable. It will allow you to create new key/value filters on the fly.
-With autocomplete for both key and values. The filter condition will be automatically applied to all
+This is a new and very different type of template variable. It will allow you to create new key/value filters on the fly
+with autocomplete for both key and values. The filter condition will be automatically applied to all
queries that use that data source. This feature opens up more exploratory dashboards. In the gif animation to the right
you have a dashboard for Elasticsearch log data. It uses one query variable that allow you to quickly change how the data
is grouped, and an interval variable for controlling the granularity of the time buckets. What was missing
@@ -126,15 +126,15 @@ We always try to bring some UX/UI refinements & polish in every release.
{{< imgbox max-width="50%" img="/img/docs/v4/add_panel.gif" caption="Add Panel flow" >}}
-We spent a lot of time improving the dashboard building experience. Trying to make it both
+We spent a lot of time improving the dashboard building experience to make it both
more efficient and easier for beginners. After many good but not great experiments
with a `build mode` we eventually decided to just improve the green row menu and
continue work on a `build mode` for a future release.
The new row menu automatically slides out when you mouse over the edge of the row. You no longer need
-to hover over the small green icon and the click it to expand the row menu.
+to hover over the small green icon and then click it to expand the row menu.
-There is some minor improvements to drag and drop behaviour. Now when dragging a panel from one row
+There are some minor improvements to drag and drop behaviour. Now when dragging a panel from one row
to another you will insert the panel and Grafana will automatically make room for it.
When you drag a panel within a row you will simply reorder the panels.
@@ -150,7 +150,7 @@ We plan to further improve dashboard building in the future with a more rich gri
{{< imgbox max-width="40%" img="/img/docs/v4/shortcuts.png" caption="Shortcuts" >}}
Grafana v4 introduces a number of really powerful keyboard shortcuts. You can now focus a panel
-by hovering over it with your mouse. With a panel focused you can simple hit `e` to toggle panel
+by hovering over it with your mouse. With a panel focused you can simply hit `e` to toggle panel
edit mode, or `v` to toggle fullscreen mode. `p r` removes the panel. `p s` opens share
modal.
@@ -164,10 +164,10 @@ Some nice navigation shortcuts are:
## Upgrade & Breaking changes
-There are no breaking changes. Old dashboards and features should work the same. Grafana-server will automatically upgrade it's db
+There are no breaking changes. Old dashboards and features should work the same. Grafana-server will automatically upgrade its db
schema on restart. It's advisable to do a backup of Grafana's database before updating.
-If your are using plugins make sure to update your plugins as some might not work perfectly v4.
+If you are using plugins make sure to update your plugins as some might not work perfectly v4.
You can update plugins using grafana-cli
diff --git a/docs/sources/http_api/admin.md b/docs/sources/http_api/admin.md
index 8aa00d08618..950ea4c8202 100644
--- a/docs/sources/http_api/admin.md
+++ b/docs/sources/http_api/admin.md
@@ -158,6 +158,7 @@ with Grafana admin permission.
"cert_file":"",
"enabled":"false",
"from_address":"admin@grafana.localhost",
+ "from_name":"Grafana",
"host":"localhost:25",
"key_file":"",
"password":"************",
@@ -292,4 +293,4 @@ Change password for specific user
HTTP/1.1 200
Content-Type: application/json
- {state: "new state", message: "alerts pause/un paused", "alertsAffected": 100}
+ {state: "new state", message: "alerts pause/un paused", "alertsAffected": 100}
diff --git a/docs/sources/http_api/alerting.md b/docs/sources/http_api/alerting.md
index b58a177fecd..cc7ce4c2650 100644
--- a/docs/sources/http_api/alerting.md
+++ b/docs/sources/http_api/alerting.md
@@ -87,7 +87,7 @@ This API can also be used to create, update and delete alert notifications.
{
"alertId": 1,
- "paused: true
+ "paused": true
}
**Example Response**:
diff --git a/docs/sources/http_api/auth.md b/docs/sources/http_api/auth.md
index aaeda1105b1..ef62f271715 100644
--- a/docs/sources/http_api/auth.md
+++ b/docs/sources/http_api/auth.md
@@ -30,7 +30,7 @@ curl example:
Open the sidemenu and click the organization dropdown and select the `API Keys` option.
-
+
You use the token in all requests in the `Authorization` header, like this:
diff --git a/docs/sources/http_api/data_source.md b/docs/sources/http_api/data_source.md
index dd8cbc9aa74..f15411e5eff 100644
--- a/docs/sources/http_api/data_source.md
+++ b/docs/sources/http_api/data_source.md
@@ -195,7 +195,7 @@ parent = "http_api"
{"message":"Datasource updated", "id": 1, "name": "test_datasource"}
-## Delete an existing data source
+## Delete an existing data source by id
`DELETE /api/datasources/:datasourceId`
@@ -213,6 +213,24 @@ parent = "http_api"
{"message":"Data source deleted"}
+## Delete an existing data source by name
+
+`DELETE /api/datasources/name/:datasourceName`
+
+**Example Request**:
+
+ DELETE /api/datasources/name/test_datasource HTTP/1.1
+ Accept: application/json
+ Content-Type: application/json
+ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+
+**Example Response**:
+
+ HTTP/1.1 200
+ Content-Type: application/json
+
+ {"message":"Data source deleted"}
+
## Data source proxy calls
`GET /api/datasources/proxy/:datasourceId/*`
diff --git a/docs/sources/http_api/user.md b/docs/sources/http_api/user.md
index 2309b56fa2a..fa20fd3e9b3 100644
--- a/docs/sources/http_api/user.md
+++ b/docs/sources/http_api/user.md
@@ -13,7 +13,7 @@ parent = "http_api"
## Search Users
-`GET /api/users`
+`GET /api/users?perpage=10&page=1`
**Example Request**:
@@ -22,6 +22,8 @@ parent = "http_api"
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+Default value for the `perpage` parameter is `1000` and for the `page` parameter is `1`.
+
**Example Response**:
HTTP/1.1 200
@@ -44,6 +46,45 @@ parent = "http_api"
}
]
+## Search Users with Paging
+
+`GET /api/users/search?perpage=10&page=1&query=mygraf`
+
+**Example Request**:
+
+ GET /api/users/search?perpage=10&page=1&query=mygraf HTTP/1.1
+ Accept: application/json
+ Content-Type: application/json
+ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+
+Default value for the `perpage` parameter is `1000` and for the `page` parameter is `1`. The `totalCount` field in the response can be used for pagination of the user list E.g. if `totalCount` is equal to 100 users and the `perpage` parameter is set to 10 then there are 10 pages of users. The `query` parameter is optional and it will return results where the query value is contained in one of the `name`, `login` or `email` fields. Query values with spaces need to be url encoded e.g. `query=Jane%20Doe`.
+
+**Example Response**:
+
+ HTTP/1.1 200
+ Content-Type: application/json
+ {
+ "totalCount": 2,
+ "users": [
+ {
+ "id": 1,
+ "name": "Admin",
+ "login": "admin",
+ "email": "admin@mygraf.com",
+ "isAdmin": true
+ },
+ {
+ "id": 2,
+ "name": "User",
+ "login": "user",
+ "email": "user@mygraf.com",
+ "isAdmin": false
+ }
+ ],
+ "page": 1,
+ "perPage": 10
+ }
+
## Get single user by Id
`GET /api/users/:id`
@@ -71,36 +112,35 @@ parent = "http_api"
## Get single user by Username(login) or Email
- `GET /api/users/lookup`
+`GET /api/users/lookup?loginOrEmail=user@mygraf.com`
- **Parameter:** `loginOrEmail`
+**Example Request using the email as option**:
- **Example Request using the email as option**:
+ GET /api/users/lookup?loginOrEmail=user@mygraf.com HTTP/1.1
+ Accept: application/json
+ Content-Type: application/json
+ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
- GET /api/users/lookup?loginOrEmail=user@mygraf.com HTTP/1.1
- Accept: application/json
- Content-Type: application/json
- Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+**Example Request using the username as option**:
+
+ GET /api/users/lookup?loginOrEmail=admin HTTP/1.1
+ Accept: application/json
+ Content-Type: application/json
+ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
- **Example Request using the username as option**:
- GET /api/users/lookup?loginOrEmail=admin HTTP/1.1
- Accept: application/json
- Content-Type: application/json
- Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+**Example Response**:
- **Example Response**:
+ HTTP/1.1 200
+ Content-Type: application/json
- HTTP/1.1 200
- Content-Type: application/json
-
- {
- "email": "user@mygraf.com"
- "name": "admin",
- "login": "admin",
- "theme": "light",
- "orgId": 1,
- "isGrafanaAdmin": true
- }
+ {
+ "email": "user@mygraf.com"
+ "name": "admin",
+ "login": "admin",
+ "theme": "light",
+ "orgId": 1,
+ "isGrafanaAdmin": true
+ }
## User Update
diff --git a/docs/sources/index.md b/docs/sources/index.md
index 0324bf888ad..f22ee82cc5c 100644
--- a/docs/sources/index.md
+++ b/docs/sources/index.md
@@ -1,8 +1,9 @@
+++
-title = "Grafana Documentation Site"
+title = "Docs Home"
description = "Install guide for Grafana"
keywords = ["grafana", "installation", "documentation"]
type = "docs"
+aliases = ["v1.1", "guides/reference/admin"]
[menu.docs]
name = "Welcome to the Docs"
identifier = "root"
@@ -22,7 +23,7 @@ other domains including industrial sensors, home automation, weather, and proces
- [Installing on Windows](installation/windows)
- [Installing on Docker](installation/docker)
- [Installing using Provisioning (Chef, Puppet, Salt, Ansible, etc)](installation/provisioning)
-- [Nightly Builds](http://grafana.org/builds)
+- [Nightly Builds](https://grafana.com/grafana/download)
For other platforms Read the [build from source]({{< relref "project/building_from_source.md" >}})
instructions for more information.
@@ -30,21 +31,21 @@ instructions for more information.
## Configuring Grafana
The back-end web server has a number of configuration options. Go the
-[Configuration](/installation/configuration) page for details on all
+[Configuration]({{< relref "installation/configuration.md" >}}) page for details on all
those options.
## Getting started
-- [Getting Started](guides/getting_started)
-- [Basic Concepts](guides/basic_concepts)
-- [Screencasts](tutorials/screencasts)
+- [Getting Started]({{< relref "guides/getting_started.md" >}})
+- [Basic Concepts]({{< relref "guides/basic_concepts.md" >}})
+- [Screencasts]({{< relref "tutorials/screencasts.md" >}})
## Data sources guides
-- [Graphite](datasources/graphite)
-- [Elasticsearch](datasources/elasticsearch)
-- [InfluxDB](datasources/influxdb)
-- [OpenTSDB](datasources/opentsdb)
+- [Graphite]({{< relref "features/datasources/graphite.md" >}})
+- [Elasticsearch]({{< relref "features/datasources/elasticsearch.md" >}})
+- [InfluxDB]({{< relref "features/datasources/influxdb.md" >}})
+- [OpenTSDB]({{< relref "features/datasources/opentsdb.md" >}})
diff --git a/docs/sources/installation/behind_proxy.md b/docs/sources/installation/behind_proxy.md
index 46b70b5dc85..0caa31bbfb5 100644
--- a/docs/sources/installation/behind_proxy.md
+++ b/docs/sources/installation/behind_proxy.md
@@ -23,16 +23,18 @@ domain = foo.bar
To use sub *path* ex `http://foo.bar/grafana` make sure to include `/grafana` in the end of root_url.
Otherwise Grafana will not behave correctly. See example below.
-# Examples
+## Examples
Here are some example configurations for running Grafana behind a reverse proxy.
-## Grafana configuration (ex http://foo.bar.com)
+### Grafana configuration (ex http://foo.bar.com)
+
```
[server]
domain = foo.bar
```
-## Nginx configuration
+### Nginx configuration
+
```
server {
listen 80;
@@ -45,16 +47,16 @@ server {
}
```
-# Examples with **sub path** (ex http://foo.bar.com/grafana)
+### Examples with **sub path** (ex http://foo.bar.com/grafana)
-## Grafana configuration with sub path
+#### Grafana configuration with sub path
```
[server]
domain = foo.bar
root_url = %(protocol)s://%(domain)s:/grafana
```
-## Nginx configuration with sub path
+#### Nginx configuration with sub path
```
server {
listen 80;
diff --git a/docs/sources/installation/configuration.md b/docs/sources/installation/configuration.md
index e222f8b5f4f..176f843e86b 100644
--- a/docs/sources/installation/configuration.md
+++ b/docs/sources/installation/configuration.md
@@ -55,6 +55,7 @@ Then you can override them using:
-
-## 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..44379c4d4e5
--- /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.com.
+
+### 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
+
+
+
+- -This Contributor License Agreement (“Agreement”) is entered into between Coding Instinct AB, -a Swedish corporation (“Grafana,” “we” or “us” etc.) and you (as defined and further identified below). -Accordingly, you hereby agree to the following terms for your past, present and future contributions -submitted to Grafana: - - -**1. Definitions:** -(a) "You" (or "your") shall mean the contribution copyright owner (whether an individual or organization) or legal entity authorized by the copyright owner that is making this Agreement with Grafana. - - -(b) "Contribution(s)" shall mean the code, documentation or other original works of authorship, including any modifications or additions to an existing work, submitted by you to Grafana for inclusion in, or documentation of, any of the products or projects owned or managed by Grafana (the "work(s)"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Grafana or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Grafana for the purpose of discussing and/or improving the work, but excluding communication that is conspicuously marked or otherwise designated in writing by you as "Not a Contribution." - -**2. Grant of Copyright License.** -You hereby grant to Grafana and to recipients of software distributed by Grafana a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute your contributions and such derivative works. - - -**3. Grant of Patent License.** -With respect to any patents you own, or that you can license without payment to any third party, you hereby grant Grafana a perpetual, irrevocable, non-exclusive, worldwide, no-charge, royalty-free license to: (i) make, have made, use, sell, offer to sell, import, and otherwise distribute and exploit your contributions in whole or in part, alone or in combination with or included in any product, work or materials arising out of or relating to the Works to which your contributions were submitted; and (ii) sublicense these same rights to third parties through multiple levels of sublicensees or other licensing arrangements. - - -**4. Rights.** -Except as set out above, you keep all right, title, and interest in your contribution. The rights that you grant to us under this agreement are effective on the date you first submitted a contribution to us, even if your submission took place before the date you entered this agreement. - - -**5. You represent and warrant that:** -(i) the contributions are an original work and that you can legally grant the rights set out in this agreement; - - -(ii) the contributions and Grafana’s exercise of any license rights granted hereunder, does not and will not, infringe the rights of any third party; - - -(iii) you are not aware of any pending or threatened claims, suits, actions, or charges pertaining to the contributions, including without limitation any claims or allegations that any or all of the contributions infringes, violates, or misappropriate the intellectual property rights of any third party (you further agree that you will notify Grafana immediately if you become aware of any such actual or potential claims, suits, actions, allegations or charges). - - -**6. Employer Rights.** -If your employer(s) has rights to intellectual property that you create that includes your contributions, you represent and warrant that your employer has waived such rights for your contributions to Grafana, or that you have received permission to make contributions on behalf of that employer and that you are authorized to execute this agreement on behalf of your employer. - - -**7. Support.** -You are not expected to provide support for your contributions, except to the extent you desire to provide support. You may provide support for free, for a fee, or not at all. Except as set forth herein, and unless required by applicable law or agreed to in writing, you provide your contributions on an "as is" basis, without warranties or conditions of any kind. - - -**8. Enforcement.** -The failure of either party to enforce its rights under this agreement for any period shall not be construed as a waiver of such rights. No changes or modifications or waivers to this Agreement will be effective unless in writing and signed by both parties. In the event that any provision of this agreement shall be determined to be illegal or unenforceable, that provision will be limited or eliminated to the minimum extent necessary so that this agreement shall otherwise remain in full force and effect and enforceable. This agreement shall be governed by and construed in accordance with the laws of the State of California in the United States without regard to the conflicts of laws provisions thereof. In any action or proceeding to enforce rights under this agreement, the prevailing party will be entitled to recover costs and attorneys’ fees. - - - \ No newline at end of file diff --git a/docs/sources/project/index.md b/docs/sources/project/index.md new file mode 100644 index 00000000000..f64918b2f02 --- /dev/null +++ b/docs/sources/project/index.md @@ -0,0 +1,8 @@ +++ +title = "Project" +type = "docs" +identifier = "project" +weight = 6 ++++ + +# Welcome to the grafana project diff --git a/docs/sources/reference/admin.md b/docs/sources/reference/admin.md index df396fed212..a6863b4ea71 100644 --- a/docs/sources/reference/admin.md +++ b/docs/sources/reference/admin.md @@ -27,7 +27,7 @@ modify Organization details and options. ## Grafana Administrators -
+
As a Grafana Administrator, you have complete access to any Organization or User in that instance of Grafana.
When performing actions as a Grafana admin, the sidebar will change it's appearance as below to indicate you are performing global server administration.
diff --git a/docs/sources/reference/dashboard.md b/docs/sources/reference/dashboard.md
index c1c574ce917..595a10e5081 100644
--- a/docs/sources/reference/dashboard.md
+++ b/docs/sources/reference/dashboard.md
@@ -66,11 +66,11 @@ Each field in the dashboard JSON is explained below with its usage:
| **editable** | whether a dashboard is editable or not |
| **hideControls** | whether row controls on the left in green are hidden or not |
| **graphTooltip** | TODO |
-| **rows** | row metadata, see [rows section](/docs/sources/reference/dashboard.md/#rows) for details |
+| **rows** | row metadata, see [rows section](#rows) for details |
| **time** | time range for dashboard, i.e. last 6 hours, last 7 days, etc |
-| **timepicker** | timepicker metadata, see [timepicker section](/docs/sources/reference/dashboard.md/#timepicker) for details |
-| **templating** | templating metadata, see [templating section](/docs/sources/reference/dashboard.md/#templating) for details |
-| **annotations** | annotations metadata, see [annotations section](/docs/sources/reference/dashboard.md/#annotations) for details |
+| **timepicker** | timepicker metadata, see [timepicker section](#timepicker) for details |
+| **templating** | templating metadata, see [templating section](#templating) for details |
+| **annotations** | annotations metadata, see [annotations section](#annotations) for details |
| **schemaVersion** | TODO |
| **version** | TODO |
| **links** | TODO |
@@ -79,7 +79,7 @@ Each field in the dashboard JSON is explained below with its usage:
`rows` field consists of an array of JSON object representing each row in a dashboard, such as shown below:
-```
+```json
"rows": [
{
"collapse": false,
@@ -105,14 +105,14 @@ Usage of the fields is explained below:
| **collapse** | whether row is collapsed or not |
| **editable** | whether a row is editable or not |
| **height** | height of the row in pixels |
-| **panels** | panels metadata, see [panels section](/docs/sources/reference/dashboard.md/#panels) for details |
+| **panels** | panels metadata, see [panels section](#panels) for details |
| **title** | title of row |
#### panels
Panels are the building blocks a dashboard. It consists of datasource queries, type of graphs, aliases, etc. Panel JSON consists of an array of JSON objects, each representing a different panel in a row. Most of the fields are common for all panels but some fields depends on the panel type. Following is an example of panel JSON representing a `graph` panel type:
-```
+```json
"panels": [
{
"aliasColors": {},
@@ -276,7 +276,7 @@ Usage of each field is explained below:
Description: TODO
-```
+```json
"timepicker": {
"collapse": false,
"enable": true,
@@ -330,7 +330,7 @@ Usage of the fields is explained below:
`templating` fields contains array of template variables with their saved values along with some other metadata, for example:
-```
+```json
"templating": {
"enable": true,
"list": [
diff --git a/docs/sources/reference/export_import.md b/docs/sources/reference/export_import.md
index bc05795c030..4c2d5faa3d3 100644
--- a/docs/sources/reference/export_import.md
+++ b/docs/sources/reference/export_import.md
@@ -33,7 +33,7 @@ To import a dashboard open dashboard search and then hit the import button.
-From here you can upload a dashboard json file, paste a [Grafana.net](https://grafana.net) dashboard
+From here you can upload a dashboard json file, paste a [Grafana.com](https://grafana.com) dashboard
url or paste dashboard json text directly into the text area.
@@ -41,15 +41,15 @@ url or paste dashboard json text directly into the text area.
In step 2 of the import process Grafana will let you change the name of the dashboard, pick what
data source you want the dashboard to use and specify any metric prefixes (if the dashboard use any).
-## Discover dashboards on Grafana.net
+## Discover dashboards on Grafana.com
-Find dashboards for common server applications at [Grafana.net/dashboards](https://grafana.net/dashboards).
+Find dashboards for common server applications at [Grafana.com/dashboards](https://grafana.com/dashboards).
## Import & Sharing with Grafana 2.x or 3.0
-Dashboards on Grafana.net use a new feature in Grafana 3.1 that allows the import process
+Dashboards on Grafana.com use a new feature in Grafana 3.1 that allows the import process
to update each panel so that they are using a data source of your choosing. If you are running a
Grafana version older than 3.1 then you might need to do some manual steps either
before or after import in order for the dashboard to work properly.
@@ -99,10 +99,10 @@ These are then referenced in the dashboard panels like this:
```
These inputs and their usage in data source properties are automatically added during export in Grafana 3.1.
-If you run an older version of Grafana and want to share a dashboard on Grafana.net you need to manually
+If you run an older version of Grafana and want to share a dashboard on Grafana.com you need to manually
add the inputs and templatize the datasource properties like above.
-If you want to import a dashboard from Grafana.net into an older version of Grafana then you can either import
+If you want to import a dashboard from Grafana.com into an older version of Grafana then you can either import
it as usual and then update the data source option in the metrics tab so that the panel is using the correct
data source. Another alternative is to open the json file in a a text editor and update the data source properties
to value that matches a name of your data source.
diff --git a/docs/sources/reference/index.md b/docs/sources/reference/index.md
new file mode 100644
index 00000000000..aaaabe89b4b
--- /dev/null
+++ b/docs/sources/reference/index.md
@@ -0,0 +1,7 @@
+---
+title: Reference Index
+description: Grafana docs reference
+type: docs
+---
+
+# Documentation
diff --git a/docs/sources/reference/playlist.md b/docs/sources/reference/playlist.md
index 359a5d8f3bd..e2d59bc322d 100644
--- a/docs/sources/reference/playlist.md
+++ b/docs/sources/reference/playlist.md
@@ -16,7 +16,7 @@ Since Grafana automatically scales Dashboards to any resolution they're perfect
## Creating a Playlist
-{{< docs-imagebox img="img/docs/v3/playlist.png" max-width="25rem" >}}
+{{< docs-imagebox img="/img/docs/v3/playlist.png" max-width="25rem" >}}
The Playlist feature can be accessed from Grafana's sidemenu, in the Dashboard submenu.
diff --git a/docs/sources/tutorials/ha_setup.md b/docs/sources/tutorials/ha_setup.md
new file mode 100644
index 00000000000..998b382a43f
--- /dev/null
+++ b/docs/sources/tutorials/ha_setup.md
@@ -0,0 +1,40 @@
++++
+title = "Setup Grafana for High availability"
+type = "docs"
+keywords = ["grafana", "tutorials", "HA", "high availability"]
+[menu.docs]
+parent = "tutorials"
+weight = 10
++++
+
+# How to setup Grafana for high availability
+
+> Alerting does not support high availability yet.
+
+Setting up Grafana for high availability is fairly simple. It comes down to two things:
+
+ * Use a shared database for multiple grafana instances.
+ * Consider how user sessions are stored.
+
+## Configure multiple servers to use the same database
+
+First you need to do is to setup mysql or postgres on another server and configure Grafana to use that database.
+You can find the configuration for doing that in the [[database]]({{< relref "configuration.md" >}}#database) section in the grafana config.
+Grafana will now persist all long term data in the database.
+It also worth considering how to setup the database for high availability but thats outside the scope of this guide.
+
+## User sessions
+
+The second thing to consider is how to deal with user sessions and how to balance the load between servers.
+By default Grafana stores user sessions on disk which works fine if you use `sticky sessions` in your load balancer.
+Grafana also supports storing the session data in the database, redis or memcache which makes it possible to use round robin in your load balancer.
+If you use mysql/postgres for session storage you first need a table to store the session data in. More details about that in [[sessions]]({{< relref "configuration.md" >}}#session)
+
+For Grafana itself it doesn't really matter if you store your sessions on disk or database/redis/memcache.
+But we suggest that you store the session in redis/memcache since it makes it easier to add/remote instances from the group.
+
+## Alerting
+
+Currently alerting does not support high availability. But this is something that we will be working on in the future.
+
+
diff --git a/docs/sources/tutorials/hubot_howto.md b/docs/sources/tutorials/hubot_howto.md
index 17658fbaecd..2c886b94f29 100644
--- a/docs/sources/tutorials/hubot_howto.md
+++ b/docs/sources/tutorials/hubot_howto.md
@@ -22,15 +22,17 @@ take you to the graph.
> is so Hipchat and Slack can show them reliably (they require the image to be publicly available).
- 
+ 
## 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/deb/systemd/grafana-server.service b/packaging/deb/systemd/grafana-server.service
index ea7193c55a6..a2eb6f1880a 100644
--- a/packaging/deb/systemd/grafana-server.service
+++ b/packaging/deb/systemd/grafana-server.service
@@ -3,6 +3,7 @@ Description=Grafana instance
Documentation=http://docs.grafana.org
Wants=network-online.target
After=network-online.target
+After=postgresql.service mariadb.service mysql.service
[Service]
EnvironmentFile=/etc/default/grafana-server
diff --git a/packaging/publish/publish_both.sh b/packaging/publish/publish_both.sh
index 2f24ff6b3ea..5edf679b481 100755
--- a/packaging/publish/publish_both.sh
+++ b/packaging/publish/publish_both.sh
@@ -1,19 +1,18 @@
#! /usr/bin/env bash
-deb_ver=4.1.0-1484127817
-rpm_ver=4.1.0-1484127817
+version=4.2.0
-wget https://grafanarel.s3.amazonaws.com/builds/grafana_${deb_ver}_amd64.deb
+wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana_${version}_amd64.deb
-package_cloud push grafana/stable/debian/jessie grafana_${deb_ver}_amd64.deb
-package_cloud push grafana/stable/debian/wheezy grafana_${deb_ver}_amd64.deb
+package_cloud push grafana/stable/debian/jessie grafana_${version}_amd64.deb
+package_cloud push grafana/stable/debian/wheezy grafana_${version}_amd64.deb
-package_cloud push grafana/testing/debian/jessie grafana_${deb_ver}_amd64.deb
-package_cloud push grafana/testing/debian/wheezy grafana_${deb_ver}_amd64.deb
+package_cloud push grafana/testing/debian/jessie grafana_${version}_amd64.deb
+package_cloud push grafana/testing/debian/wheezy grafana_${version}_amd64.deb
-wget https://grafanarel.s3.amazonaws.com/builds/grafana-${rpm_ver}.x86_64.rpm
+wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-${version}-1.x86_64.rpm
-package_cloud push grafana/testing/el/6 grafana-${rpm_ver}.x86_64.rpm
-package_cloud push grafana/testing/el/7 grafana-${rpm_ver}.x86_64.rpm
+package_cloud push grafana/testing/el/6 grafana-${version}-1.x86_64.rpm
+package_cloud push grafana/testing/el/7 grafana-${version}-1.x86_64.rpm
-package_cloud push grafana/stable/el/7 grafana-${rpm_ver}.x86_64.rpm
-package_cloud push grafana/stable/el/6 grafana-${rpm_ver}.x86_64.rpm
+package_cloud push grafana/stable/el/7 grafana-${version}-1.x86_64.rpm
+package_cloud push grafana/stable/el/6 grafana-${version}-1.x86_64.rpm
diff --git a/packaging/publish/publish_testing.sh b/packaging/publish/publish_testing.sh
index 1e39d65b7e5..76419eb7a7e 100755
--- a/packaging/publish/publish_testing.sh
+++ b/packaging/publish/publish_testing.sh
@@ -1,13 +1,13 @@
#! /usr/bin/env bash
-deb_ver=4.1.0-1482230757beta1
-rpm_ver=4.1.0-1482230757beta1
+deb_ver=4.2.0-beta1
+rpm_ver=4.2.0-beta1
-wget https://grafanarel.s3.amazonaws.com/builds/grafana_${deb_ver}_amd64.deb
+wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana_${deb_ver}_amd64.deb
package_cloud push grafana/testing/debian/jessie grafana_${deb_ver}_amd64.deb
package_cloud push grafana/testing/debian/wheezy grafana_${deb_ver}_amd64.deb
-wget https://grafanarel.s3.amazonaws.com/builds/grafana-${rpm_ver}.x86_64.rpm
+wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-${rpm_ver}.x86_64.rpm
package_cloud push grafana/testing/el/6 grafana-${rpm_ver}.x86_64.rpm
package_cloud push grafana/testing/el/7 grafana-${rpm_ver}.x86_64.rpm
diff --git a/packaging/rpm/control/postinst b/packaging/rpm/control/postinst
old mode 100644
new mode 100755
index be3d7692a5f..cf31112679d
--- a/packaging/rpm/control/postinst
+++ b/packaging/rpm/control/postinst
@@ -68,13 +68,6 @@ if [ $1 -eq 1 ] ; then
echo " sudo service grafana-server start"
fi
elif [ $1 -ge 2 ] ; then
- if [ -x /opt/grafana/ ]; then
- echo "### Upgrading Notice ### "
- echo "-- New grafana install home is /usr/share/grafana"
- echo "-- Please move sqlite3 database to /var/lib/grafana/"
- echo "-- Notice: service name && binary changed to grafana-server"
- fi
-
if [ "$RESTART_ON_UPGRADE" == "true" ]; then
stopGrafana
startGrafana
diff --git a/packaging/rpm/control/posttrans b/packaging/rpm/control/posttrans
new file mode 100755
index 00000000000..0afe4561a93
--- /dev/null
+++ b/packaging/rpm/control/posttrans
@@ -0,0 +1,32 @@
+#!/bin/sh
+
+set -e
+
+echo "POSTTRANS: Running script"
+
+[ -f /etc/sysconfig/grafana-server ] && . /etc/sysconfig/grafana-server
+
+# copy config files if missing
+if [ ! -f /etc/grafana/grafana.ini ]; then
+ echo "POSTTRANS: Config file not found"
+
+ if [ -f /etc/grafana/grafana.ini.rpmsave ]; then
+ echo "POSTTRANS: /etc/grafana/grafana.ini.rpmsave config file found."
+ mv /etc/grafana/grafana.ini.rpmsave /etc/grafana/grafana.ini
+ echo "POSTTRANS: /etc/grafana/grafana.ini restored"
+
+ if [ -f /etc/grafana/ldap.toml.rpmsave ]; then
+ echo "POSTTRANS: /etc/grafana/ldap.toml.rpmsave found"
+ mv /etc/grafana/ldap.toml.rpmsave /etc/grafana/ldap.toml
+ echo "POSTTRANS: /etc/grafana/ldap.toml restored"
+ fi
+
+ echo "POSTTRANS: Restoring config file permissions"
+ chown -Rh root:$GRAFANA_GROUP /etc/grafana/*
+ chmod 755 /etc/grafana
+ find /etc/grafana -type f -exec chmod 640 {} ';'
+ find /etc/grafana -type d -exec chmod 755 {} ';'
+ fi
+fi
+
+
diff --git a/packaging/rpm/systemd/grafana-server.service b/packaging/rpm/systemd/grafana-server.service
index ec0ef7e804e..a6e02073d46 100644
--- a/packaging/rpm/systemd/grafana-server.service
+++ b/packaging/rpm/systemd/grafana-server.service
@@ -3,6 +3,7 @@ Description=Grafana instance
Documentation=http://docs.grafana.org
Wants=network-online.target
After=network-online.target
+After=postgresql.service mariadb.service mysql.service
[Service]
EnvironmentFile=/etc/sysconfig/grafana-server
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..9f7bf01a884 100644
--- a/pkg/api/cloudwatch/cloudwatch.go
+++ b/pkg/api/cloudwatch/cloudwatch.go
@@ -3,7 +3,9 @@ package cloudwatch
import (
"encoding/json"
"errors"
+ "fmt"
"io/ioutil"
+ "os"
"strings"
"sync"
"time"
@@ -12,6 +14,7 @@ import (
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/credentials"
"github.com/aws/aws-sdk-go/aws/credentials/ec2rolecreds"
+ "github.com/aws/aws-sdk-go/aws/credentials/endpointcreds"
"github.com/aws/aws-sdk-go/aws/ec2metadata"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/cloudwatch"
@@ -114,19 +117,26 @@ 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{},
&credentials.SharedCredentialsProvider{Filename: "", Profile: dsInfo.Profile},
- &ec2rolecreds.EC2RoleProvider{Client: ec2metadata.New(stsSess), ExpiryWindow: 5 * time.Minute},
+ remoteCredProvider(stsSess),
})
stsConfig := &aws.Config{
Region: aws.String(dsInfo.Region),
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 +149,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{
@@ -166,6 +179,30 @@ func getCredentials(dsInfo *datasourceInfo) (*credentials.Credentials, error) {
return creds, nil
}
+func remoteCredProvider(sess *session.Session) credentials.Provider {
+ ecsCredURI := os.Getenv("AWS_CONTAINER_CREDENTIALS_RELATIVE_URI")
+
+ if len(ecsCredURI) > 0 {
+ return ecsCredProvider(sess, ecsCredURI)
+ }
+ return ec2RoleProvider(sess)
+}
+
+func ecsCredProvider(sess *session.Session, uri string) credentials.Provider {
+ const host = `169.254.170.2`
+
+ c := ec2metadata.New(sess)
+ return endpointcreds.NewProviderClient(
+ c.Client.Config,
+ c.Client.Handlers,
+ fmt.Sprintf("http://%s%s", host, uri),
+ func(p *endpointcreds.Provider) { p.ExpiryWindow = 5 * time.Minute })
+}
+
+func ec2RoleProvider(sess *session.Session) credentials.Provider {
+ return &ec2rolecreds.EC2RoleProvider{Client: ec2metadata.New(sess), ExpiryWindow: 5 * time.Minute}
+}
+
func getAwsConfig(req *cwRequest) (*aws.Config, error) {
creds, err := getCredentials(req.GetDatasourceInfo())
if err != nil {
@@ -185,7 +222,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 +274,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 +320,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 +368,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 +417,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 +458,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/cloudwatch_test.go b/pkg/api/cloudwatch/cloudwatch_test.go
new file mode 100644
index 00000000000..41050c102ff
--- /dev/null
+++ b/pkg/api/cloudwatch/cloudwatch_test.go
@@ -0,0 +1,41 @@
+package cloudwatch
+
+import (
+ "fmt"
+ "os"
+ "testing"
+
+ "github.com/aws/aws-sdk-go/aws/credentials/ec2rolecreds"
+ "github.com/aws/aws-sdk-go/aws/credentials/endpointcreds"
+ "github.com/aws/aws-sdk-go/aws/session"
+ . "github.com/smartystreets/goconvey/convey"
+)
+
+func TestECSCredProvider(t *testing.T) {
+ Convey("Running in an ECS container task", t, func() {
+ defer os.Clearenv()
+ os.Setenv("AWS_CONTAINER_CREDENTIALS_RELATIVE_URI", "/abc/123")
+
+ provider := remoteCredProvider(&session.Session{})
+
+ So(provider, ShouldNotBeNil)
+
+ ecsProvider, ok := provider.(*endpointcreds.Provider)
+ So(ecsProvider, ShouldNotBeNil)
+ So(ok, ShouldBeTrue)
+
+ So(ecsProvider.Client.Endpoint, ShouldEqual, fmt.Sprintf("http://169.254.170.2/abc/123"))
+ })
+}
+
+func TestDefaultEC2RoleProvider(t *testing.T) {
+ Convey("Running outside an ECS container task", t, func() {
+ provider := remoteCredProvider(&session.Session{})
+
+ So(provider, ShouldNotBeNil)
+
+ ec2Provider, ok := provider.(*ec2rolecreds.EC2RoleProvider)
+ So(ec2Provider, ShouldNotBeNil)
+ So(ok, ShouldBeTrue)
+ })
+}
diff --git a/pkg/api/cloudwatch/metrics.go b/pkg/api/cloudwatch/metrics.go
index 0df8eaa089c..67f35a60aa7 100644
--- a/pkg/api/cloudwatch/metrics.go
+++ b/pkg/api/cloudwatch/metrics.go
@@ -81,7 +81,8 @@ func init() {
"AWS/Redshift": {"CPUUtilization", "DatabaseConnections", "HealthStatus", "MaintenanceMode", "NetworkReceiveThroughput", "NetworkTransmitThroughput", "PercentageDiskSpaceUsed", "ReadIOPS", "ReadLatency", "ReadThroughput", "WriteIOPS", "WriteLatency", "WriteThroughput"},
"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/S3": {"BucketSizeBytes", "NumberOfObjects", "AllRequests", "GetRequests", "PutRequests", "DeleteRequests", "HeadRequests", "PostRequests", "ListRequests", "BytesDownloaded", "BytesUploaded", "4xxErrors", "5xxErrors", "FirstByteLatency", "TotalRequestLatency"},
+ "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",
@@ -122,7 +123,8 @@ func init() {
"AWS/Redshift": {"NodeID", "ClusterIdentifier"},
"AWS/RDS": {"DBInstanceIdentifier", "DBClusterIdentifier", "DatabaseClass", "EngineName"},
"AWS/Route53": {"HealthCheckId"},
- "AWS/S3": {"BucketName", "StorageType"},
+ "AWS/S3": {"BucketName", "StorageType", "FilterId"},
+ "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 26a1e05e813..17730b42a76 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"
@@ -115,6 +116,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..11e70dccc0d 100644
--- a/pkg/api/frontendsettings.go
+++ b/pkg/api/frontendsettings.go
@@ -133,14 +133,17 @@ func getFrontendSettingsMap(c *middleware.Context) (map[string]interface{}, erro
}
jsonObj := map[string]interface{}{
- "defaultDatasource": defaultDatasource,
- "datasources": datasources,
- "panels": panels,
- "appSubUrl": setting.AppSubUrl,
- "allowOrgCreate": (setting.AllowUserOrgCreate && c.IsSignedIn) || c.IsGrafanaAdmin,
- "authProxyEnabled": setting.AuthProxyEnabled,
- "ldapEnabled": setting.LdapEnabled,
- "alertingEnabled": setting.AlertingEnabled,
+ "defaultDatasource": defaultDatasource,
+ "datasources": datasources,
+ "panels": panels,
+ "appSubUrl": setting.AppSubUrl,
+ "allowOrgCreate": (setting.AllowUserOrgCreate && c.IsSignedIn) || c.IsGrafanaAdmin,
+ "authProxyEnabled": setting.AuthProxyEnabled,
+ "ldapEnabled": setting.LdapEnabled,
+ "alertingEnabled": setting.AlertingEnabled,
+ "googleAnalyticsId": setting.GoogleAnalyticsId,
+ "disableLoginForm": setting.DisableLoginForm,
+ "disableSignoutMenu": setting.DisableSignoutMenu,
"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.go b/pkg/api/login.go
index 8fbe414c08c..d2bbf4e81b9 100644
--- a/pkg/api/login.go
+++ b/pkg/api/login.go
@@ -35,6 +35,11 @@ func LoginView(c *middleware.Context) {
viewData.Settings["loginHint"] = setting.LoginHint
viewData.Settings["disableLoginForm"] = setting.DisableLoginForm
+ if loginError, ok := c.Session.Get("loginError").(string); ok {
+ c.Session.Delete("loginError")
+ viewData.Settings["loginError"] = loginError
+ }
+
if !tryLoginUsingRememberCookie(c) {
c.HTML(200, VIEW_INDEX, viewData)
return
@@ -94,6 +99,10 @@ func LoginApiPing(c *middleware.Context) {
}
func LoginPost(c *middleware.Context, cmd dtos.LoginCommand) Response {
+ if setting.DisableLoginForm {
+ return ApiError(401, "Login is disabled", nil)
+ }
+
authQuery := login.LoginUserQuery{
Username: cmd.User,
Password: cmd.Password,
diff --git a/pkg/api/login_oauth.go b/pkg/api/login_oauth.go
index 574d08af09f..5fbd9fea709 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"
@@ -22,6 +23,13 @@ import (
"github.com/grafana/grafana/pkg/social"
)
+var (
+ ErrProviderDeniedRequest = errors.New("Login provider denied login request")
+ ErrEmailNotAllowed = errors.New("Required email domain not fulfilled")
+ ErrSignUpNotAllowed = errors.New("Signup is not allowed for this adapter")
+ ErrUsersQuotaReached = errors.New("Users quota reached")
+)
+
func GenStateString() string {
rnd := make([]byte, 32)
rand.Read(rnd)
@@ -44,8 +52,7 @@ func OAuthLogin(ctx *middleware.Context) {
error := ctx.Query("error")
if error != "" {
errorDesc := ctx.Query("error_description")
- ctx.Logger.Info("OAuthLogin Failed", "error", error, "errorDesc", errorDesc)
- ctx.Redirect(setting.AppSubUrl + "/login?failCode=1003")
+ redirectWithError(ctx, ErrProviderDeniedRequest, "error", error, "errorDesc", errorDesc)
return
}
@@ -117,10 +124,8 @@ func OAuthLogin(ctx *middleware.Context) {
// get user info
userInfo, err := connect.UserInfo(client)
if err != nil {
- if err == social.ErrMissingTeamMembership {
- ctx.Redirect(setting.AppSubUrl + "/login?failCode=1000")
- } else if err == social.ErrMissingOrganizationMembership {
- ctx.Redirect(setting.AppSubUrl + "/login?failCode=1001")
+ if sErr, ok := err.(*social.Error); ok {
+ redirectWithError(ctx, sErr)
} else {
ctx.Handle(500, fmt.Sprintf("login.OAuthLogin(get info from %s)", name), err)
}
@@ -131,8 +136,7 @@ func OAuthLogin(ctx *middleware.Context) {
// validate that the email is allowed to login to grafana
if !connect.IsEmailAllowed(userInfo.Email) {
- ctx.Logger.Info("OAuth login attempt with unallowed email", "email", userInfo.Email)
- ctx.Redirect(setting.AppSubUrl + "/login?failCode=1002")
+ redirectWithError(ctx, ErrEmailNotAllowed)
return
}
@@ -142,7 +146,7 @@ func OAuthLogin(ctx *middleware.Context) {
// create account if missing
if err == m.ErrUserNotFound {
if !connect.IsSignupAllowed() {
- ctx.Redirect(setting.AppSubUrl + "/login")
+ redirectWithError(ctx, ErrSignUpNotAllowed)
return
}
limitReached, err := middleware.QuotaReached(ctx, "user")
@@ -151,7 +155,7 @@ func OAuthLogin(ctx *middleware.Context) {
return
}
if limitReached {
- ctx.Redirect(setting.AppSubUrl + "/login")
+ redirectWithError(ctx, ErrUsersQuotaReached)
return
}
cmd := m.CreateUserCommand{
@@ -177,5 +181,18 @@ 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 + "/")
}
+
+func redirectWithError(ctx *middleware.Context, err error, v ...interface{}) {
+ ctx.Logger.Info(err.Error(), v...)
+ // TODO: we can use the flash storage here once it's implemented
+ ctx.Session.Set("loginError", err.Error())
+ ctx.Redirect(setting.AppSubUrl + "/login")
+}
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/org_invite.go b/pkg/api/org_invite.go
index 8d916677ed2..9e85808950f 100644
--- a/pkg/api/org_invite.go
+++ b/pkg/api/org_invite.go
@@ -38,6 +38,10 @@ func AddOrgInvite(c *middleware.Context, inviteDto dtos.AddInviteForm) Response
if err != m.ErrUserNotFound {
return ApiError(500, "Failed to query db for existing user check", err)
}
+
+ if setting.DisableLoginForm {
+ return ApiError(401, "User could not be found", nil)
+ }
} else {
return inviteExistingUserToOrg(c, userQuery.Result, &inviteDto)
}
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-cli/main.go b/pkg/cmd/grafana-cli/main.go
index 658edd0f895..e586e606fb5 100644
--- a/pkg/cmd/grafana-cli/main.go
+++ b/pkg/cmd/grafana-cli/main.go
@@ -35,7 +35,7 @@ func main() {
cli.StringFlag{
Name: "repo",
Usage: "url to the plugin repository",
- Value: "https://grafana.net/api/plugins",
+ Value: "https://grafana.com/api/plugins",
EnvVar: "GF_PLUGIN_REPO",
},
cli.BoolFlag{
diff --git a/pkg/cmd/grafana-cli/utils/grafana_path.go b/pkg/cmd/grafana-cli/utils/grafana_path.go
index fa6dc46d783..afb622bbb93 100644
--- a/pkg/cmd/grafana-cli/utils/grafana_path.go
+++ b/pkg/cmd/grafana-cli/utils/grafana_path.go
@@ -40,6 +40,8 @@ func returnOsDefault(currentOs string) string {
return "../data/plugins"
case "darwin":
return "/usr/local/var/lib/grafana/plugins"
+ case "freebsd":
+ return "/var/db/grafana/plugins"
default: //"linux"
return "/var/lib/grafana/plugins"
}
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/imguploader.go b/pkg/components/imguploader/imguploader.go
index 94cde098297..ae5c89a0049 100644
--- a/pkg/components/imguploader/imguploader.go
+++ b/pkg/components/imguploader/imguploader.go
@@ -27,25 +27,15 @@ func NewImageUploader() (ImageUploader, error) {
return nil, err
}
- bucket := s3sec.Key("bucket_url").MustString("")
+ bucketUrl := s3sec.Key("bucket_url").MustString("")
accessKey := s3sec.Key("access_key").MustString("")
secretKey := s3sec.Key("secret_key").MustString("")
-
- region := ""
- rBucket := regexp.MustCompile(`https?:\/\/(.*)\.s3(-([^.]+))?\.amazonaws\.com\/?`)
- matches := rBucket.FindStringSubmatch(bucket)
- if len(matches) == 0 {
- return nil, fmt.Errorf("Could not find bucket setting for image.uploader.s3")
- } else {
- bucket = matches[1]
- if matches[3] != "" {
- region = matches[3]
- } else {
- region = "us-east-1"
- }
+ info, err := getRegionAndBucketFromUrl(bucketUrl)
+ if err != nil {
+ return nil, err
}
- return NewS3Uploader(region, bucket, "public-read", accessKey, secretKey), nil
+ return NewS3Uploader(info.region, info.bucket, "public-read", accessKey, secretKey), nil
case "webdav":
webdavSec, err := setting.Cfg.GetSection("external_image_storage.webdav")
if err != nil {
@@ -65,3 +55,37 @@ func NewImageUploader() (ImageUploader, error) {
return NopImageUploader{}, nil
}
+
+type s3Info struct {
+ region string
+ bucket string
+}
+
+func getRegionAndBucketFromUrl(url string) (*s3Info, error) {
+ info := &s3Info{}
+ urlRegex := regexp.MustCompile(`https?:\/\/(.*)\.s3(-([^.]+))?\.amazonaws\.com\/?`)
+ matches := urlRegex.FindStringSubmatch(url)
+ if len(matches) > 0 {
+ info.bucket = matches[1]
+ if matches[3] != "" {
+ info.region = matches[3]
+ } else {
+ info.region = "us-east-1"
+ }
+ return info, nil
+ }
+
+ urlRegex2 := regexp.MustCompile(`https?:\/\/s3(-([^.]+))?\.amazonaws\.com\/(.*)?`)
+ matches2 := urlRegex2.FindStringSubmatch(url)
+ if len(matches2) > 0 {
+ info.bucket = matches2[3]
+ if matches2[2] != "" {
+ info.region = matches2[2]
+ } else {
+ info.region = "us-east-1"
+ }
+ return info, nil
+ }
+
+ return nil, fmt.Errorf("Could not find bucket setting for image.uploader.s3")
+}
diff --git a/pkg/components/imguploader/imguploader_test.go b/pkg/components/imguploader/imguploader_test.go
index b871aa55a64..4faaa6415f0 100644
--- a/pkg/components/imguploader/imguploader_test.go
+++ b/pkg/components/imguploader/imguploader_test.go
@@ -10,29 +10,66 @@ import (
func TestImageUploaderFactory(t *testing.T) {
Convey("Can create image uploader for ", t, func() {
- Convey("S3ImageUploader", func() {
- var err error
+ Convey("S3ImageUploader config", func() {
setting.NewConfigContext(&setting.CommandLineArgs{
HomePath: "../../../",
})
setting.ImageUploadProvider = "s3"
- s3sec, err := setting.Cfg.GetSection("external_image_storage.s3")
- s3sec.NewKey("bucket_url", "https://foo.bar.baz.s3-us-east-2.amazonaws.com")
- s3sec.NewKey("access_key", "access_key")
- s3sec.NewKey("secret_key", "secret_key")
+ Convey("with bucket url https://foo.bar.baz.s3-us-east-2.amazonaws.com", func() {
+ s3sec, err := setting.Cfg.GetSection("external_image_storage.s3")
+ s3sec.NewKey("bucket_url", "https://foo.bar.baz.s3-us-east-2.amazonaws.com")
+ s3sec.NewKey("access_key", "access_key")
+ s3sec.NewKey("secret_key", "secret_key")
- uploader, err := NewImageUploader()
+ uploader, err := NewImageUploader()
- So(err, ShouldBeNil)
- original, ok := uploader.(*S3Uploader)
+ So(err, ShouldBeNil)
+ original, ok := uploader.(*S3Uploader)
- So(ok, ShouldBeTrue)
- So(original.region, ShouldEqual, "us-east-2")
- So(original.bucket, ShouldEqual, "foo.bar.baz")
- So(original.accessKey, ShouldEqual, "access_key")
- So(original.secretKey, ShouldEqual, "secret_key")
+ So(ok, ShouldBeTrue)
+ So(original.region, ShouldEqual, "us-east-2")
+ So(original.bucket, ShouldEqual, "foo.bar.baz")
+ So(original.accessKey, ShouldEqual, "access_key")
+ So(original.secretKey, ShouldEqual, "secret_key")
+ })
+
+ Convey("with bucket url https://s3.amazonaws.com/mybucket", func() {
+ s3sec, err := setting.Cfg.GetSection("external_image_storage.s3")
+ s3sec.NewKey("bucket_url", "https://s3.amazonaws.com/my.bucket.com")
+ s3sec.NewKey("access_key", "access_key")
+ s3sec.NewKey("secret_key", "secret_key")
+
+ uploader, err := NewImageUploader()
+
+ So(err, ShouldBeNil)
+ original, ok := uploader.(*S3Uploader)
+
+ So(ok, ShouldBeTrue)
+ So(original.region, ShouldEqual, "us-east-1")
+ So(original.bucket, ShouldEqual, "my.bucket.com")
+ So(original.accessKey, ShouldEqual, "access_key")
+ So(original.secretKey, ShouldEqual, "secret_key")
+ })
+
+ Convey("with bucket url https://s3-us-west-2.amazonaws.com/mybucket", func() {
+ s3sec, err := setting.Cfg.GetSection("external_image_storage.s3")
+ s3sec.NewKey("bucket_url", "https://s3-us-west-2.amazonaws.com/my.bucket.com")
+ s3sec.NewKey("access_key", "access_key")
+ s3sec.NewKey("secret_key", "secret_key")
+
+ uploader, err := NewImageUploader()
+
+ So(err, ShouldBeNil)
+ original, ok := uploader.(*S3Uploader)
+
+ So(ok, ShouldBeTrue)
+ So(original.region, ShouldEqual, "us-west-2")
+ So(original.bucket, ShouldEqual, "my.bucket.com")
+ So(original.accessKey, ShouldEqual, "access_key")
+ So(original.secretKey, ShouldEqual, "secret_key")
+ })
})
Convey("Webdav uploader", func() {
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/auth_proxy_test.go b/pkg/middleware/auth_proxy_test.go
index cc9253b6a77..bd587bc0c7f 100644
--- a/pkg/middleware/auth_proxy_test.go
+++ b/pkg/middleware/auth_proxy_test.go
@@ -90,6 +90,10 @@ func (s *mockSession) Get(k interface{}) interface{} {
return s.value
}
+func (s *mockSession) Delete(k interface{}) interface{} {
+ return nil
+}
+
func (s *mockSession) ID() string {
return ""
}
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..a6af63d18de 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()
@@ -87,6 +93,8 @@ type SessionStore interface {
Set(interface{}, interface{}) error
// Get gets value by given key in session.
Get(interface{}) interface{}
+ // Delete deletes a key from session.
+ Delete(interface{}) interface{}
// ID returns current session ID.
ID() string
// Release releases session resource and save data to provider.
@@ -122,6 +130,13 @@ func (s *SessionWrapper) Get(k interface{}) interface{} {
return nil
}
+func (s *SessionWrapper) Delete(k interface{}) interface{} {
+ if s.session != nil {
+ return s.session.Delete(k)
+ }
+ return nil
+}
+
func (s *SessionWrapper) ID() string {
if s.session != nil {
return s.session.ID()
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 58bf8b4ca18..169189670d6 100644
--- a/pkg/models/datasource.go
+++ b/pkg/models/datasource.go
@@ -122,11 +122,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/plugins/update_checker.go b/pkg/plugins/update_checker.go
index 76c566803ac..a2594ad915a 100644
--- a/pkg/plugins/update_checker.go
+++ b/pkg/plugins/update_checker.go
@@ -60,7 +60,7 @@ func checkForUpdates() {
log.Trace("Checking for updates")
pluginSlugs := getAllExternalPluginSlugs()
- resp, err := httpClient.Get("https://grafana.net/api/plugins/versioncheck?slugIn=" + pluginSlugs + "&grafanaVersion=" + setting.BuildVersion)
+ resp, err := httpClient.Get("https://grafana.com/api/plugins/versioncheck?slugIn=" + pluginSlugs + "&grafanaVersion=" + setting.BuildVersion)
if err != nil {
log.Trace("Failed to get plugins repo from grafana.net, %v", err.Error())
@@ -71,14 +71,14 @@ func checkForUpdates() {
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
- log.Trace("Update check failed, reading response from grafana.net, %v", err.Error())
+ log.Trace("Update check failed, reading response from grafana.com, %v", err.Error())
return
}
gNetPlugins := []GrafanaNetPlugin{}
err = json.Unmarshal(body, &gNetPlugins)
if err != nil {
- log.Trace("Failed to unmarshal plugin repo, reading response from grafana.net, %v", err.Error())
+ log.Trace("Failed to unmarshal plugin repo, reading response from grafana.com, %v", err.Error())
return
}
diff --git a/pkg/services/alerting/conditions/query.go b/pkg/services/alerting/conditions/query.go
index eafb233a60b..e0a6035355d 100644
--- a/pkg/services/alerting/conditions/query.go
+++ b/pkg/services/alerting/conditions/query.go
@@ -67,6 +67,7 @@ func (c *QueryCondition) Eval(context *alerting.EvalContext) (*alerting.Conditio
matches = append(matches, &alerting.EvalMatch{
Metric: series.Name,
Value: reducedValue,
+ Tags: series.Tags,
})
}
}
@@ -78,7 +79,7 @@ func (c *QueryCondition) Eval(context *alerting.EvalContext) (*alerting.Conditio
if context.IsTestRun {
context.Logs = append(context.Logs, &alerting.ResultLogEntry{
- Message: fmt.Sprintf("Condition[%d]: Eval: %v, Query Returned No Series (reduced to null/no value)", evalMatch),
+ Message: fmt.Sprintf("Condition: Eval: %v, Query Returned No Series (reduced to null/no value)", evalMatch),
})
}
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..0eb21865b9f --- /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": "https://grafana.com/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/opsgenie.go b/pkg/services/alerting/notifiers/opsgenie.go index 742aeb922b6..6792702b539 100644 --- a/pkg/services/alerting/notifiers/opsgenie.go +++ b/pkg/services/alerting/notifiers/opsgenie.go @@ -30,7 +30,7 @@ func init() { 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."> + tooltip="Automatically close alerts in OpsGenie once the alert goes back to ok.">
dashboards on Grafana.com