Merge remote-tracking branch 'grafana/master' into annotations-created

* grafana/master: (51 commits) Use curly brackets around hyperlink help text #11478 (#11479) migrated playlist-routes to ts migrated last all.js to ts Notes for closing #7119 changelog: adds note for #11128 variables: adds test for variable sorting Add case-insensitive sort for variables. graphite: fixes #11434 settings: fixes test changed from margin to padding changed variable for tabbed close btn hover, and changed text-strong variable for lighttheme, removed commented out variable mssql: typos in help sections Webpack Grafana plugin template project to links (#11457) rm panel.type constrain from threshold_mapper.ts (#11448) No need for node_modules/bin in npm run-script (#11449) changelog: adds note about closing #11555 add article fix some typos migrated graph_tooltip to ts started migration to ts ...
2018-04-05 09:48:00 +02:00
parent 71ef9b6db5 088720cf2b
commit 392c47f39b
84 changed files with 1597 additions and 761 deletions
@@ -41,6 +41,8 @@ Grafana ships with the following set of notification types:
 To enable email notifications you have to setup [SMTP settings](/installation/configuration/#smtp)
 in the Grafana config. Email notifications will upload an image of the alert graph to an
 external image destination if available or fallback to attaching the image to the email.
+Be aware that if you use the `local` image storage email servers and clients might not be
+able to access the image.

 ### Slack

@@ -75,7 +75,7 @@ You can reference queries by the row “letter” that they’re on (similar to
 ## Point consolidation

 All Graphite metrics are consolidated so that Graphite doesn't return more data points than there are pixels in the graph. By default,
-this consolidation is done using `avg` function. You can how Graphite consolidates metrics by adding the Graphite consolidateBy function.
+this consolidation is done using `avg` function. You can control how Graphite consolidates metrics by adding the Graphite consolidateBy function.

 > *Notice* This means that legend summary values (max, min, total) cannot be all correct at the same time. They are calculated
 > client side by Grafana. And depending on your consolidation function only one or two can be correct at the same time.
@@ -42,6 +42,7 @@ Hit `?` on your keyboard to open the shortcuts help modal.
 - `e`	Toggle panel edit view
 - `v`	Toggle panel fullscreen view
 - `p` `s` Open Panel Share Modal
+- `p` `d` Duplicate Panel
 - `p` `r` Remove Panel

 ### Time Range
@@ -15,7 +15,7 @@ weight = 1

 Description | Download
 ------------ | -------------
-Stable for Debian-based Linux | [grafana_5.0.3_amd64.deb](https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana_5.0.3_amd64.deb)
+Stable for Debian-based Linux | [grafana_5.0.4_amd64.deb](https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana_5.0.4_amd64.deb)

 Read [Upgrading Grafana]({{< relref "installation/upgrading.md" >}}) for tips and guidance on updating an existing
 installation.
@@ -24,9 +24,9 @@ installation.


 ```bash
-wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana_5.0.3_amd64.deb
+wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana_5.0.4_amd64.deb
 sudo apt-get install -y adduser libfontconfig
-sudo dpkg -i grafana_5.0.3_amd64.deb
+sudo dpkg -i grafana_5.0.4_amd64.deb
 ```

 ## APT Repository
@@ -15,7 +15,7 @@ weight = 2

 Description | Download
 ------------ | -------------
-Stable for CentOS / Fedora / OpenSuse / Redhat Linux | [5.0.3 (x86-64 rpm)](https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-5.0.3-1.x86_64.rpm)
+Stable for CentOS / Fedora / OpenSuse / Redhat Linux | [5.0.4 (x86-64 rpm)](https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-5.0.4-1.x86_64.rpm)


 Read [Upgrading Grafana]({{< relref "installation/upgrading.md" >}}) for tips and guidance on updating an existing
@@ -26,7 +26,7 @@ installation.
 You can install Grafana using Yum directly.

 ```bash
-$ sudo yum install https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-5.0.3-1.x86_64.rpm
+$ sudo yum install https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-5.0.4-1.x86_64.rpm
 ```

 Or install manually using `rpm`.
@@ -34,15 +34,15 @@ Or install manually using `rpm`.
 #### On CentOS / Fedora / Redhat:

 ```bash
-$ wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-5.0.3-1.x86_64.rpm
+$ wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-5.0.4-1.x86_64.rpm
 $ sudo yum install initscripts fontconfig
-$ sudo rpm -Uvh grafana-5.0.3-1.x86_64.rpm
+$ sudo rpm -Uvh grafana-5.0.4-1.x86_64.rpm
 ```

 #### On OpenSuse:

 ```bash
-$ sudo rpm -i --nodeps grafana-5.0.3-1.x86_64.rpm
+$ sudo rpm -i --nodeps grafana-5.0.4-1.x86_64.rpm
 ```

 ## Install via YUM Repository
@@ -52,7 +52,7 @@ Add the following to a new file at `/etc/yum.repos.d/grafana.repo`
 ```bash
 [grafana]
 name=grafana
-baseurl=https://packagecloud.io/grafana/stable/el/6/$basearch
+baseurl=https://packagecloud.io/grafana/stable/el/7/$basearch
 repo_gpgcheck=1
 enabled=1
 gpgcheck=1
@@ -64,7 +64,7 @@ sslcacert=/etc/pki/tls/certs/ca-bundle.crt
 There is also a testing repository if you want beta or release candidates.

 ```bash
-baseurl=https://packagecloud.io/grafana/testing/el/6/$basearch
+baseurl=https://packagecloud.io/grafana/testing/el/7/$basearch
 ```

 Then install Grafana via the `yum` command.
@@ -23,7 +23,7 @@ Before upgrading it can be a good idea to backup your Grafana database. This wil

 #### sqlite

-If you use sqlite you only need to make a backup of you `grafana.db` file. This is usually located at `/var/lib/grafana/grafana.db` on unix system.
+If you use sqlite you only need to make a backup of your `grafana.db` file. This is usually located at `/var/lib/grafana/grafana.db` on unix system.
 If you are unsure what database you use and where it is stored check you grafana configuration file. If you
 installed grafana to custom location using a binary tar/zip it is usally in `<grafana_install_dir>/data`.

@@ -8,12 +8,11 @@ parent = "installation"
 weight = 3
 +++

-
 # Installing on Windows

 Description | Download
 ------------ | -------------
-Latest stable package for Windows | [grafana-5.0.3.windows-x64.zip](https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-5.0.3.windows-x64.zip)
+Latest stable package for Windows | [grafana-5.0.4.windows-x64.zip](https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-5.0.4.windows-x64.zip)

 Read [Upgrading Grafana]({{< relref "installation/upgrading.md" >}}) for tips and guidance on updating an existing
 installation.
@@ -71,13 +71,13 @@ Each field in the dashboard JSON is explained below with its usage:
 | **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** | version of the JSON schema (integer), incremented each time a Grafana update brings changes to the said schema |
+| **schemaVersion** | version of the JSON schema (integer), incremented each time a Grafana update brings changes to said schema |
 | **version** | version of the dashboard (integer), incremented each time the dashboard is updated |
 | **panels** | panels array, see below for detail. |

 ## 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. Most of the fields are common for all panels but some fields depends on the panel type. Following is an example of panel JSON of a text panel.
+Panels are the building blocks of 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. Most of the fields are common for all panels but some fields depend on the panel type. Following is an example of panel JSON of a text panel.

 ```json
 "panels": [
@@ -105,7 +105,7 @@ The gridPos property describes the panel size and position in grid coordinates.
 - `x` The x position, in same unit as `w`.
 - `y` The y position, in same unit as `h`.

-The grid has a negative gravity that moves panels up if there i empty space above a panel.
+The grid has a negative gravity that moves panels up if there is empty space above a panel.

 ### timepicker

@@ -161,7 +161,7 @@ Usage of the fields is explained below:

 ### templating

-`templating` fields contains array of template variables with their saved values along with some other metadata, for example:
+The `templating` field contains an array of template variables with their saved values along with some other metadata, for example:

 ```json
 "templating": {
@@ -236,7 +236,7 @@ Usage of the above mentioned fields in the templating section is explained below
 | Name | Usage |
 | ---- | ----- |
 | **enable** | whether templating is enabled or not |
-| **list** | an array of objects representing, each representing one template variable |
+| **list** | an array of objects each representing one template variable |
 | **allFormat** | format to use while fetching all values from datasource, eg: `wildcard`, `glob`, `regex`, `pipe`, etc. |
 | **current** | shows current selected variable text/value on the dashboard |
 | **datasource** | shows datasource for the variables |
@@ -174,6 +174,8 @@ Interpolating a variable with multiple values selected is tricky as it is not st
 is valid in the given context where the variable is used. Grafana tries to solve this by allowing each data source plugin to
 inform the templating interpolation engine what format to use for multiple values.

+Note that the *Custom all value* option on the variable will have to be left blank for Grafana to format all values into a single string.
+
 **Graphite**, for example, uses glob expressions. A variable with multiple values would, in this case, be interpolated as `{host1,host2,host3}` if
 the current variable value was *host1*, *host2* and *host3*.