+ 
+
The image above shows you the top header for a Dashboard.
@@ -29,12 +34,12 @@ The image above shows you the top header for a Dashboard.
6. Settings: Manage Dashboard settings and features such as Templating and Annotations.
## Dashboards, Panels, Rows, the building blocks of Grafana...
-Dashboards are at the core of what Grafana is all about. Dashboards are composed of individual Panels arranged on a number of Rows. Grafana ships with a variety of Panels. Grafana makes it easy to construct the right queries, and customize the display properties so that you can create the perfect Dashboard for your need. Each Panel can interact with data from any configured Grafana Data Source (currently InfluxDB, Graphite, OpenTSDB, and KairosDB). The [Core Concepts](/guides/basic_concepts) guide explores these key ideas in detail.
+Dashboards are at the core of what Grafana is all about. Dashboards are composed of individual Panels arranged on a number of Rows. Grafana ships with a variety of Panels. Grafana makes it easy to construct the right queries, and customize the display properties so that you can create the perfect Dashboard for your need. Each Panel can interact with data from any configured Grafana Data Source (currently InfluxDB, Graphite, OpenTSDB, and KairosDB). The [Basic Concepts](/guides/basic_concepts) guide explores these key ideas in detail.
## Adding & Editing Graphs and Panels
-
+
1. You add panels via row menu. The row menu is the green icon to the left of each row.
2. To edit the graph you click on the graph title to open the panel menu, then `Edit`.
@@ -43,8 +48,7 @@ Dashboards are at the core of what Grafana is all about. Dashboards are composed
When you click the `Metrics` tab, you are presented with a Query Editor that is specific to the Panel Data Source. Use the Query Editor to build your queries and Grafana will visualize them in real time.
-
-
+
1. Zoom out time range
2. Time picker dropdown. Here you can access relative time range options, auto refresh options and set custom absolute time ranges.
@@ -57,7 +61,7 @@ When you click the `Metrics` tab, you are presented with a Query Editor that is
You can Drag-and-Drop Panels within and between Rows. Click and hold the Panel title, and drag it to its new location. You can also easily resize panels by clicking the (-) and (+) icons.
-
+
## Tips and shortcuts
diff --git a/docs/sources/guides/index.md b/docs/sources/guides/index.md
new file mode 100644
index 00000000000..c80dd624624
--- /dev/null
+++ b/docs/sources/guides/index.md
@@ -0,0 +1,9 @@
++++
+title = "Guides"
+type = "docs"
+[menu.docs]
+name = "Getting Started"
+identifier = "guides"
+weight = 2
++++
+
diff --git a/docs/sources/guides/screencasts.md b/docs/sources/guides/screencasts.md
deleted file mode 100644
index 500ca9f9b6a..00000000000
--- a/docs/sources/guides/screencasts.md
+++ /dev/null
@@ -1,69 +0,0 @@
-page_title: Screencasts
-page_description: Grafana screencasts
-page_keywords: grafana, screencasts, documentation, guides
-no_toc: true
-
-# Screencasts
-
-
+
A new timepicker with room for more quick ranges as well as new types of relative ranges, like `Today`,
`The day so far` and `This day last week`. Also an improved time & calendar picker that now works
@@ -20,7 +26,7 @@ correctly in UTC mode.
### Elasticsearch
-
+
+
Grafana 2.5 ships with a new CloudWatch datasource that will allow you to query and visualize CloudWatch
metrics directly from Grafana.
@@ -51,14 +57,14 @@ metrics directly from Grafana.
### Prometheus
-
+
Grafana 2.5 ships with a new Prometheus datasource that will allow you to query and visualize data
stored in Prometheus.
### Mix different data sources
-
+
In previous releases you have been able to mix different data sources on the same dashboard. In v2.5 you
will be able to mix then on the same graph! You can enable this by selecting the built in `-- Mixed --` data source.
@@ -67,12 +73,12 @@ to plot metrics from different Graphite servers on the same Graph or plot data f
data from Prometheus. Mixing different data sources on the same graph works for any data source, even custom ones.
### Panel Resize handles
-
+
This release adds resize handles to the the bottom right corners of panels making is easy to resize both width and height.
### User invites
-
+
This version also brings some new features for user management.
diff --git a/docs/sources/guides/whats-new-in-v2-6.md b/docs/sources/guides/whats-new-in-v2-6.md
index ac644ad44af..281c2b5e4be 100644
--- a/docs/sources/guides/whats-new-in-v2-6.md
+++ b/docs/sources/guides/whats-new-in-v2-6.md
@@ -1,8 +1,14 @@
----
-page_title: What's New in Grafana v2.6
-page_description: What's new in Grafana v2.6
-page_keywords: grafana, new, changes, features, documentation, table
----
++++
+title = "What's New in Grafana v2.6"
+description = "Feature & improvement highlights for Grafana v2.6"
+keywords = ["grafana", "new", "documentation", "2.6"]
+type = "docs"
+[menu.docs]
+name = "Version 2.6"
+identifier = "v2.6"
+parent = "whatsnew"
+weight = 7
++++
# What's new in Grafana v2.6
@@ -11,7 +17,7 @@ The release includes a new Table panel, a new InfluxDB query editor, support for
support for multiple Cloudwatch credentials.
## Table Panel
-
+
The new table panel is very flexible, supporting both multiple modes for time series as well as for
table, annotation and raw JSON data. It also provides date formating and value formating and coloring options.
@@ -21,7 +27,7 @@ table, annotation and raw JSON data. It also provides date formating and value f
In the most simple mode you can turn time series to rows. This means you get a `Time`, `Metric` and a `Value` column.
Where `Metric` is the name of the time series.
-
+
### Table Transform
Above you see the options tab for the **Table Panel**. The most important option is the `To Table Transform`.
@@ -34,7 +40,7 @@ The column styles allow you control how dates and numbers are formatted.
This transform allows you to take multiple time series and group them by time. Which will result in a `Time` column
and a column for each time series.
-
+
In the screenshot above you can see how the same time series query as in the previous example can be transformed into
a different table by changing the `To Table Transform` to `Time series to columns`.
@@ -43,7 +49,7 @@ a different table by changing the `To Table Transform` to `Time series to colum
This transform works very similar to the legend values in the Graph panel. Each series gets its own row. In the Options
tab you can select which aggregations you want using the plus button the Columns section.
-
+
You have to think about how accurate the aggregations will be. It depends on what aggregation is used in the time series query,
how many data points are fetched, etc. The time series aggregations are calculated by Grafana after aggregation is performed
@@ -53,38 +59,39 @@ by the time series database.
If you want to show documents from Elasticsearch pick `Raw Document` as the first metric.
-
+
This in combination with the `JSON Data` table transform will allow you to pick which fields in the document
you want to show in the table.
-
+
### Elasticsearch aggregations
You can also make Elasticsearch aggregation queries without a `Date Histogram`. This allows you to
use Elasticsearch metric aggregations to get accurate aggregations for the selected time range.
-
+
### Annotations
The table can also show any annotations you have enabled in the dashboard.
-
+
## The New InfluxDB Editor
The new InfluxDB editor is a lot more flexible and powerful. It supports nested functions, like `derivative`.
It also uses the same technique as the Graphite query editor in that it presents nested functions as chain of function
transformations. It tries to simplify and unify the complicated nature of InfluxDB's query language.
-
+
In the `SELECT` row you can specify what fields and functions you want to use. If you have a
group by time you need an aggregation function. Some functions like derivative require an aggregation function.
The editor tries simplify and unify this part of the query. For example:
-
+
+
The above will generate the following InfluxDB `SELECT` clause:
@@ -103,7 +110,7 @@ You can remove the group by by clicking on the `tag` and then click on the x ico
The new editor also allows you to remove group by time and select `raw` table data. Which is very useful
in combination with the new Table panel to show raw log data stored in InfluxDB.
-
+
## Pipeline metrics
@@ -111,7 +118,7 @@ If you have Elasticsearch 2.x and Grafana 2.6 or above then you can use pipeline
**Moving Average** and **Derivative**. Elasticsearch pipeline metrics require another metric to be based on. Use the eye icon next to the metric
to hide metrics from appearing in the graph.
-
+
## Changelog
For a detailed list and link to github issues for everything included in the 2.6 release please
diff --git a/docs/sources/guides/whats-new-in-v2.md b/docs/sources/guides/whats-new-in-v2.md
index 9e87ab55e6e..8ad24e70fd1 100644
--- a/docs/sources/guides/whats-new-in-v2.md
+++ b/docs/sources/guides/whats-new-in-v2.md
@@ -1,8 +1,14 @@
----
-page_title: What's New in Grafana v2.0
-page_description: What's new in Grafana v2.0
-page_keywords: grafana, new, changes, features, documentation
----
++++
+title = "What's New in Grafana v2.0"
+description = "Feature & improvement highlights for Grafana v2.0"
+keywords = ["grafana", "new", "documentation", "2.0"]
+type = "docs"
+[menu.docs]
+name = "Version 2.0"
+identifier = "v2.0"
+parent = "whatsnew"
+weight = 11
++++
# What's New in Grafana v2.0
@@ -49,7 +55,7 @@ even zoom in). Also they are fast to load as they aren't actually connected to a
They're a great way to communicate about a particular incident with specific people who aren't Users of your Grafana instance. You can also use them to show off your dashboards over the Internet.
-
+
### Publish snapshots
@@ -61,11 +67,11 @@ Either way, anyone with the link (and access to your Grafana instance for local
In Grafana v2.x you can now override the relative time range for individual panels, causing them to be different than what is selected in the Dashboard time picker in the upper right. You can also add a time shift to individual panels. This allows you to show metrics from different time periods or days at the same time.
-
+
You control these overrides in panel editor mode and the new tab `Time Range`.
-
+
When you zoom or change the Dashboard time to a custom absolute time range, all panel overrides will be disabled. The panel relative time override is only active when the dashboard time is also relative. The panel timeshift override however is always active, even when the dashboard time is absolute.
@@ -90,7 +96,7 @@ This feature makes it easy to include interactive visualizations from your Grafa
The top header has gotten a major streamlining in Grafana V2.0.
-
+
1. `Side menubar toggle` Toggle the side menubar on or off. This allows you to focus on the data presented on the Dashboard. The side menubar provides access to features unrelated to a Dashboard such as Users, Organizations, and Data Sources.
2. `Dashboard dropdown` The main dropdown shows you which Dashboard you are currently viewing, and allows you to easily switch to a new Dashboard. From here you can also create a new Dashboard, Import existing Dashboards, and manage the Playlist.
@@ -115,7 +121,7 @@ You can easily collapse or re-open the side menubar at any time by clicking the
## New search view & starring dashboards
-
+
The dashboard search view has gotten a big overhaul. You can now see and filter by which dashboard you have personally starred.
@@ -124,11 +130,11 @@ The dashboard search view has gotten a big overhaul. You can now see and filter
The Graph panel now supports 3 logarithmic scales, `log base 10`, `log base 32`, `log base 1024`. Logarithmic y-axis scales are very useful when rendering many series of different order of magnitude on the same scale (eg.
latency, network traffic, and storage)
-
+
## Dashlist panel
-
+
The dashlist is a new panel in Grafana v2.0. It allows you to show your personal starred dashboards, as well as do custom searches based on search strings or tags.
@@ -147,7 +153,7 @@ In addition, connections to Data Sources can be better controlled and secured, a
A commonly reported problem has been graphs dipping to zero at the the end, because metric data for the last interval has yet to be written to the Data Source. These graphs then "self correct" once the data comes in, but can look deceiving or alarming at times.
You can avoid this problem by adding a `now delay` in `Dashboard Settings` > `Time Picker` tab. This new feature will cause Grafana to ignore the most recent data up to the set delay.
-
+
The delay that may be necessary depends on how much latency you have in your collection pipeline.
@@ -155,7 +161,7 @@ The delay that may be necessary depends on how much latency you have in your col
Grafana v2.0 protects Users from accidentally overwriting each others Dashboard changes. Similar protections are in place if you try to create a new Dashboard with the same name as an existing one.
-
+
These protections are only the first step; we will be building out additional capabilities around dashboard versioning and management in future versions of Grafana.
@@ -171,6 +177,6 @@ Grafana now supports server-side PNG rendering. From the Panel share dialog you
> **Note** This requires that your Data Source is accessible from your Grafana instance.
-
+
diff --git a/docs/sources/guides/whats-new-in-v3-1.md b/docs/sources/guides/whats-new-in-v3-1.md
index 9613cc1682c..65b5f8e4882 100644
--- a/docs/sources/guides/whats-new-in-v3-1.md
+++ b/docs/sources/guides/whats-new-in-v3-1.md
@@ -1,8 +1,14 @@
----
-page_title: What's New in Grafana v3.1
-page_description: What's new in Grafana v3.1
-page_keywords: grafana, new, changes, features, documentation
----
++++
+title = "What's New in Grafana v3.1"
+description = "Feature & improvement highlights for Grafana v3.1"
+keywords = ["grafana", "new", "documentation", "3.1"]
+type = "docs"
+[menu.docs]
+name = "Version 3.1 (Latest)"
+identifier = "v3.1"
+parent = "whatsnew"
+weight = 1
++++
# What's New in Grafana v3.1
@@ -10,21 +16,21 @@ page_keywords: grafana, new, changes, features, documentation
The export feature is now accessed from the share menu.
-
+
Dashboards exported from Grafana 3.1 are now more portable and easier for others to import than before.
The export process extracts information data source types used by panels and adds these to a new `inputs`
section in the dashboard json. So when you or another person tries to import the dashboard they will be asked to
select data source and optional metrix prefix options.
-
+
The above screenshot shows the new import modal that gives you 3 options for how to import a dashboard.
One notable new addition here is the ability to import directly from Dashboards shared on [Grafana.net](https://grafana.net).
The next step in the import process:
-
+
Here you can change the name of the dashboard and also pick what data sources you want the dashboard to use. The above screenshot
shows a CollectD dashboard for Graphite that requires a metric prefix be specified.
@@ -35,7 +41,7 @@ On [Grafana.net](https://grafana.net) you can now browse & search for dashboards
more are being uploaded every day. To import a dashboard just copy the dashboard url and head back to Grafana,
then Dashboard Search -> Import -> Paste Grafana.net Dashboard URL.
-
+
## Constant template variables
@@ -63,6 +69,5 @@ Its now possible to configure different log levels for different modules.
## CHANGELOG
For a detailed list and link to github issues for everything included
-in the 3.1 release please view the
-[CHANGELOG.md](https://github.com/grafana/grafana/blob/master/CHANGELOG.md)
+in the 3.1 release please view the [CHANGELOG.md](https://github.com/grafana/grafana/blob/master/CHANGELOG.md)
file.
diff --git a/docs/sources/guides/whats-new-in-v3.md b/docs/sources/guides/whats-new-in-v3.md
index 051691e0384..f86c7133676 100644
--- a/docs/sources/guides/whats-new-in-v3.md
+++ b/docs/sources/guides/whats-new-in-v3.md
@@ -1,8 +1,14 @@
----
-page_title: What's New in Grafana v3.0
-page_description: What's new in Grafana v3.0
-page_keywords: grafana, new, changes, features, documentation
----
++++
+title = "What's New in Grafana v3.0"
+description = "Feature & improvement highlights for Grafana v3.0"
+keywords = ["grafana", "new", "documentation", "3.0"]
+type = "docs"
+[menu.docs]
+name = "Version 3.0"
+identifier = "v3.0"
+parent = "whatsnew"
+weight = 2
++++
# What's New in Grafana v3.0
@@ -37,7 +43,7 @@ entire experience right within Grafana.
## Grafana.net
-
+
[Grafana.net](https://grafana.net) offers a central repository where the community can come together to discover, create and
share plugins (data sources, panels, apps) and dashboards.
@@ -96,7 +102,7 @@ periodically and remotely.
You can also make Playlists dynamic by using Dashboard **tags** to
define the Playlist.
-
+
## Improved UI
@@ -116,11 +122,11 @@ are literally hundreds of UI improvements and refinements.
Here’s the new side menu in action:
-
+
And here's the new look for Dashboard settings:
-
+
Check out the Play
Site to get a feel for some of the UI changes.
@@ -132,7 +138,7 @@ over the link and click the annotation text. This feature is very
useful for linking to particular commits or tickets where more
detailed information can be presented to the user.
-
+
## Data source variables
@@ -140,11 +146,11 @@ This has been a top requested feature for very long we are exited to finally pro
this feature. You can now add a new `Data source` type variable. That will
automatically be filled with instance names of your data sources.
-
+
You can then use this variable as the panel data source:
-
+
This will allow you to quickly change data source server and reuse the
same dashboard for different instances of your metrics backend. For example
@@ -162,7 +168,7 @@ The Prometheus Data Source now supports annotations.
### InfluxDB
You can now select the InfluxDB policy from the query editor.
-
+
Grafana 3.0 also comes with support for InfluxDB 0.11 and InfluxDB 0.12.
@@ -195,23 +201,23 @@ are a couple that I incurage you try!
#### [Clock Panel](https://grafana.net/plugins/grafana-clock-panel)
Support's both current time and count down mode.
-
+
#### [Pie Chart Panel](https://grafana.net/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)
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)
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)
diff --git a/docs/sources/http_api/auth.md b/docs/sources/http_api/auth.md
index df874d1653e..503791b4879 100644
--- a/docs/sources/http_api/auth.md
+++ b/docs/sources/http_api/auth.md
@@ -25,7 +25,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/index.md b/docs/sources/http_api/index.md
new file mode 100644
index 00000000000..a083b150469
--- /dev/null
+++ b/docs/sources/http_api/index.md
@@ -0,0 +1,7 @@
++++
+title = "HTTP API"
+[menu.docs]
+name = "HTTP API"
+identifier = "http_api"
+weight = 9
++++
diff --git a/docs/sources/http_api/user.md b/docs/sources/http_api/user.md
index aa870031ca2..734fbb4f934 100644
--- a/docs/sources/http_api/user.md
+++ b/docs/sources/http_api/user.md
@@ -1,10 +1,15 @@
-----
-page_title: User API
-page_description: Grafana User API Reference
-page_keywords: grafana, admin, http, api, documentation, user
----
++++
+title = "User HTTP API "
+description = "Grafana User HTTP API"
+keywords = ["grafana", "http", "documentation", "api", "user"]
+aliases = ["/http_api/user/"]
+type = "docs"
+[menu.docs]
+name = "Users"
+parent = "http_api"
++++
-# User API
+# User HTTP resources / actions
## Search Users
diff --git a/docs/sources/index.md b/docs/sources/index.md
index 746f2942be7..a2b19fe75da 100644
--- a/docs/sources/index.md
+++ b/docs/sources/index.md
@@ -1,37 +1,50 @@
----
-page_title: Grafana Installation
-page_description: Install guide for Grafana
-page_keywords: grafana, installation, documentation
----
++++
+title = "Grafana Installation"
+description = "Install guide for Grafana"
+keywords = ["grafana", "installation", "documentation"]
+type = "docs_root"
+[menu.docs]
+name = "Welcome to the Docs"
+identifier = "root"
+weight = -1
++++
-# Installation
+# Welcome to the Grafana Documentation
-Grafana is easily installed via a Debian/Ubuntu package (.deb), via
-Redhat/Centos package (.rpm) or manually via a tarball that contains all
-required files and binaries. If you can't find a package or binary for
-your platform, you might be able to build one yourself. Read the [build
-from source](../project/building_from_source) instructions for more
-information.
+Grafana is an open source metric analytics & visualization suite. It is most commonly used for
+visualizing time series data for infrastructure and application analytics but many use it in
+other domains including industrial sensors, home automation, weather, and process control.
-## Platforms
-- [Installing on Debian / Ubuntu](installation/debian.md)
-- [Installing on RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)](installation/rpm.md)
-- [Installing on Mac OS X](installation/mac.md)
-- [Installing on Windows](installation/windows.md)
-- [Installing on Docker](installation/docker.md)
-- [Installing using Provisioning (Chef, Puppet, Salt, Ansible, etc)](installation/provisioning.md)
-- [Nightly Builds](http://grafana.org/download/builds.html)
+## Installing Grafana
+- [Installing on Debian / Ubuntu](installation/debian)
+- [Installing on RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)](installation/rpm)
+- [Installing on Mac OS X](installation/mac)
+- [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)
-## Configuration
+For other platforms Read the [build from source]({{< relref "project/building_from_source.md" >}})
+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
those options.
+
+## Getting started
+
+- [Getting Started](guides/getting_started)
+- [Basic Concepts](guides/basic_concepts)
+- [Screencasts](tutorials/screencasts)
+
## Data sources guides
-- [Graphite](datasources/graphite.md)
-- [Elasticsearch](datasources/elasticsearch.md)
-- [InfluxDB](datasources/influxdb.md)
-- [OpenTSDB](datasources/opentsdb.md)
+- [Graphite](datasources/graphite)
+- [Elasticsearch](datasources/elasticsearch)
+- [InfluxDB](datasources/influxdb)
+- [OpenTSDB](datasources/opentsdb)
+
diff --git a/docs/sources/installation/behind_proxy.md b/docs/sources/installation/behind_proxy.md
index 0cf2507b404..46b70b5dc85 100644
--- a/docs/sources/installation/behind_proxy.md
+++ b/docs/sources/installation/behind_proxy.md
@@ -1,21 +1,27 @@
----
-page_title: Running Grafana behind a reverse proxy
-page_description: Guide for running Grafana behind a reverse proxy
-page_keywords: Grafana, reverse proxy, nginx, haproxy
----
++++
+title = "Running Grafana behind a reverse proxy"
+description = "Guide for running Grafana behind a reverse proxy"
+keywords = ["grafana", "nginx", "documentation", "haproxy", "reverse"]
+type = "docs"
+[menu.docs]
+name = "Running Grafana behind a reverse proxy"
+parent = "tutorials"
+weight = 1
++++
+
# Running Grafana behind a reverse proxy
-It should be straight forward to get Grafana up and running behind a reverse proxy. But here are some things that you might run into.
+It should be straight forward to get Grafana up and running behind a reverse proxy. But here are some things that you might run into.
-Links and redirects will not be rendered correctly unless you set the server.domain setting.
+Links and redirects will not be rendered correctly unless you set the server.domain setting.
```
[server]
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.
+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
Here are some example configurations for running Grafana behind a reverse proxy.
@@ -26,7 +32,7 @@ Here are some example configurations for running Grafana behind a reverse proxy.
domain = foo.bar
```
-## Nginx configuration
+## Nginx configuration
```
server {
listen 80;
diff --git a/docs/sources/installation/configuration.md b/docs/sources/installation/configuration.md
index 9a7a480f482..8ae9d4cd18c 100644
--- a/docs/sources/installation/configuration.md
+++ b/docs/sources/installation/configuration.md
@@ -1,8 +1,14 @@
----
-page_title: Configuration
-page_description: Configuration guide for Grafana.
-page_keywords: grafana, configuration, documentation
----
++++
+title = "Configuration"
+description = "Configuration Docs"
+keywords = ["grafana", "configuration", "documentation"]
+type = "docs"
+[menu.docs]
+name = "Configuration"
+identifier = "config"
+parent = "admin"
+weight = 1
++++
# Configuration
@@ -30,6 +36,9 @@ using environment variables using the syntax:
Where the section name is the text within the brackets. Everything
should be upper case, `.` should be replaced by `_`. For example, given these configuration settings:
+ # default section
+ instance_name = ${HOSTNAME}
+
[security]
admin_user = admin
@@ -39,6 +48,7 @@ should be upper case, `.` should be replaced by `_`. For example, given these co
Then you can override them using:
+ export GF_DEFAULT_INSTANCE_NAME=my-instance
export GF_SECURITY_ADMIN_USER=true
export GF_AUTH_GOOGLE_CLIENT_SECRET=newS3cretKey
@@ -382,9 +392,12 @@ browser to access Grafana, but with the prefix path of `/login/generic_oauth`.
scopes =
auth_url =
token_url =
+ api_url =
allowed_domains = mycompany.com mycompany.org
allow_sign_up = false
+Set api_url to the resource that returns basic user info.
+
+
## 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.
diff --git a/docs/sources/plugins/datasources.md b/docs/sources/plugins/datasources.md
index 3732948d527..dbd0061cbdb 100644
--- a/docs/sources/plugins/datasources.md
+++ b/docs/sources/plugins/datasources.md
@@ -1,9 +1,3 @@
----
-page_title: Plugin datasources
-page_description: Datasource plugins for Grafana
-page_keywords: grafana, plugins, documentation
----
-
# Datasources
diff --git a/docs/sources/plugins/development.md b/docs/sources/plugins/development.md
index 6d2106fad01..9b2a3fb8668 100644
--- a/docs/sources/plugins/development.md
+++ b/docs/sources/plugins/development.md
@@ -1,10 +1,14 @@
----
-page_title: Plugin development guide
-page_description: Plugin development for Grafana
-page_keywords: grafana, plugins, documentation, development
----
++++
+title = "Developer Guide"
+type = "docs"
+aliases = ["/plugins/datasources/", "/plugins/apps/", "/plugins/panels/"]
+[menu.docs]
+name = "Developer Guide"
+parent = "plugins"
+weight = 5
++++
-# Plugin development
+# Developer Guide
From grafana 3.0 it's very easy to develop your own plugins and share them with other grafana users.
@@ -32,6 +36,7 @@ will be expected to export different things. You can find what's expected for [d
and [apps](./apps.md) plugins in the documentation.
## Start developing your plugin
+
There are three ways that you can start developing a Grafana plugin.
1. Setup a Grafana development environment. [(described here)](http://docs.grafana.org/project/building_from_source/) and place your plugin in the ```data/plugins``` folder.
@@ -45,8 +50,11 @@ the folder contains a subfolder named dist. In that case grafana will mount the
This makes it possible to have both built and src content in the same plugin git repo.
## Examples
+
We currently have three different examples that you can fork/download to get started developing your grafana plugin.
- [simple-json-datasource](https://github.com/grafana/simple-json-datasource) (small datasource plugin for querying json data from backends)
- - [piechart-panel](https://github.com/grafana/piechart-panel)
- [example-app](https://github.com/grafana/example-app)
+ - [clock-panel](https://github.com/grafana/clock-panel)
+ - [singlestat-panel](https://github.com/grafana/grafana/blob/master/public/app/plugins/panel/singlestat/module.ts)
+ - [piechart-panel](https://github.com/grafana/piechart-panel)
diff --git a/docs/sources/plugins/index.md b/docs/sources/plugins/index.md
index bb5c8062223..217a01f9160 100644
--- a/docs/sources/plugins/index.md
+++ b/docs/sources/plugins/index.md
@@ -1,8 +1,11 @@
----
-page_title: Plugin overview
-page_description: Plugins for Grafana
-page_keywords: grafana, plugins, documentation
----
++++
+title = "Plugins"
+[menu.docs]
+name = "Plugins"
+identifier = "plugins"
+weight = 8
++++
+
# Plugins
diff --git a/docs/sources/plugins/installation.md b/docs/sources/plugins/installation.md
index e8e69af6e00..ff4f51729af 100644
--- a/docs/sources/plugins/installation.md
+++ b/docs/sources/plugins/installation.md
@@ -1,14 +1,30 @@
----
-page_title: Plugin installation
-page_description: Plugin installation for Grafana
-page_keywords: grafana, plugins, documentation
----
++++
+title = "Installing Plugins"
+type = "docs"
+[menu.docs]
+parent = "plugins"
+weight = 1
++++
+
+# Grafana Plugins
+
+From Grafana 3.0+ not only are datasource plugins supported but also panel plugins and apps.
+Having panels as plugins make it easy to create and add any kind of panel, to show your data
+or improve your favorite dashboards. Apps is something new in Grafana that enables
+bundling of datasources, panels, dashboards and Grafana pages into a cohesive experience.
+
+Grafana already have a strong community of contributors and plugin developers.
+By making it easier to develop and install plugins we hope that the community
+can grow even stronger and develop new plugins that we would never think about.
+
+To discover plugins checkout the official [Plugin Repository](https://grafana.net/plugins).
# Installing plugins
The easiest way to install plugins is by using the CLI tool grafana-cli which is bundled with grafana. Before any modification take place after modifying plugins, grafana-server needs to be restarted.
### Grafana plugin directory
+
On Linux systems the grafana-cli will assume that the grafana plugin directory is `/var/lib/grafana/plugins`. It's possible to override the directory which grafana-cli will operate on by specifying the --pluginsDir flag. On Windows systems this parameter have to be specified for every call.
### Grafana-cli commands
diff --git a/docs/sources/plugins/panels.md b/docs/sources/plugins/panels.md
index 179af7451c5..168d1320ca5 100644
--- a/docs/sources/plugins/panels.md
+++ b/docs/sources/plugins/panels.md
@@ -5,6 +5,15 @@ page_keywords: grafana, plugins, documentation
---
++++
+title = "Installing Plugins"
+type = "docs"
+[menu.docs]
+parent = "plugins"
+weight = 1
++++
+
+
# Panels
Panels are the main building blocks of dashboards.
diff --git a/docs/sources/project/building_from_source.md b/docs/sources/project/building_from_source.md
index 40f963b237c..84a1fcbaa41 100644
--- a/docs/sources/project/building_from_source.md
+++ b/docs/sources/project/building_from_source.md
@@ -1,8 +1,10 @@
----
-page_title: Building from source
-page_description: Building from source Grafana.
-page_keywords: grafana, build, contribute, documentation
----
++++
+title = "Building from source"
+type = "docs"
+[menu.docs]
+parent = "installation"
+weight = 5
++++
# Building Grafana from source
@@ -24,7 +26,7 @@ go get github.com/grafana/grafana
## Building the backend
```
cd $GOPATH/src/github.com/grafana/grafana
-go run build.go setup
+go run build.go setup
go run build.go build # (or 'go build ./pkg/cmd/grafana-server')
```
diff --git a/docs/sources/reference/admin.md b/docs/sources/reference/admin.md
index 266fc998092..df396fed212 100644
--- a/docs/sources/reference/admin.md
+++ b/docs/sources/reference/admin.md
@@ -1,8 +1,13 @@
-----
-page_title: Administration
-page_description: Grafana Administration
-page_keywords: grafana, admin, administration, documentation
----
++++
+title = "Admin Roles"
+description = "Users & Organization permission and administration"
+keywords = ["grafana", "configuration", "documentation", "admin", "users", "permissions"]
+type = "docs"
+[menu.docs]
+name = "Admin Roles"
+parent = "admin"
+weight = 3
++++
# Administration
@@ -22,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.
@@ -32,6 +37,6 @@ From the Grafana Server Admin page, you can access the System Info page which su
Organizations in Grafana are best suited for a **multi-tenant deployment**. In a multi-tenant deployment,
Organizations can be used to provide a full Grafana experience to different sets of users from a single Grafana instance,
-at the convenience of the Grafana Administrator.
+at the convenience of the Grafana Administrator.
-In most cases, a Grafana installation will only have **one** Organization. Since dashboards, data sources and other configuration items are not shared between organizations, there's no need to create multiple Organizations if you want all your users to have access to the same set of dashboards and data.
+In most cases, a Grafana installation will only have **one** Organization. Since dashboards, data sources and other configuration items are not shared between organizations, there's no need to create multiple Organizations if you want all your users to have access to the same set of dashboards and data.
diff --git a/docs/sources/reference/annotations.md b/docs/sources/reference/annotations.md
index 668a163b672..26cb037fdfa 100644
--- a/docs/sources/reference/annotations.md
+++ b/docs/sources/reference/annotations.md
@@ -1,15 +1,19 @@
-----
-page_title: Annotations
-page_description: Annotations user guide
-page_keywords: grafana, annotations, guide, documentation
----
++++
+title = "Annotations"
+keywords = ["grafana", "annotations", "documentation", "guide"]
+type = "docs"
+[menu.docs]
+name = "Annotations"
+parent = "dashboard_features"
+weight = 2
++++
# Annotations
Annotations provide a way to mark points on the graph with rich events. When you hover over an annotation
you can get title, tags, and text information for the event.
-
+
To add an annotation query click dashboard settings icon in top menu and select `Annotations` from the
dropdown. This will open the `Annotations` edit view. Click the `Add` tab to add a new annotation query.
@@ -24,7 +28,7 @@ Graphite supports two ways to query annotations.
- Graphite events query, use the `Graphite event tags` text input, specify an tag or wildcard (leave empty should also work)
## Elasticsearch annotations
-
+
Grafana can query any Elasticsearch index for annotation events. The index name can be the name of an alias or an index wildcard pattern.
You can leave the search query blank or specify a lucene query.
@@ -35,13 +39,14 @@ as the name for the fields that should be used for the annotation title, tags an
> **Note** The annotation timestamp field in elasticsearch need to be in UTC format.
## InfluxDB Annotations
-
+
For InfluxDB you need to enter a query like in the above screenshot. You need to have the ```where $timeFilter``` part.
If you only select one column you will not need to enter anything in the column mapping fields.
## Prometheus Annotations
-
+
+
Prometheus supports two ways to query annotations.
diff --git a/docs/sources/reference/dashboard.md b/docs/sources/reference/dashboard.md
index 831dbe3abdc..0bb3fc9ed4f 100644
--- a/docs/sources/reference/dashboard.md
+++ b/docs/sources/reference/dashboard.md
@@ -1,13 +1,15 @@
-----
-page_title: Dashboard JSON
-page_description: Dashboard JSON Reference
-page_keywords: grafana, dashboard, json, documentation
----
++++
+title = "JSON Model"
+keywords = ["grafana", "dashboard", "documentation", "json", "model"]
+type = "docs"
+[menu.docs]
+name = "JSON Model"
+parent = "dashboard_features"
+weight = 100
++++
# Dashboard JSON
-## Overview
-
A dashboard in Grafana is represented by a JSON object, which stores metadata of its dashboard. Dashboard metadata includes dashboard properties, metadata from rows, panels, template variables, panel queries, etc.
To view the JSON of a dashboard, follow the steps mentioned below:
diff --git a/docs/sources/reference/dashlist.md b/docs/sources/reference/dashlist.md
index ea098541da2..9c5baa55b34 100644
--- a/docs/sources/reference/dashlist.md
+++ b/docs/sources/reference/dashlist.md
@@ -1,29 +1,32 @@
-----
-page_title: Dashlist Panel
-page_description: Dashlist Panel Reference
-page_keywords: grafana, dashlist, panel, documentation
----
++++
+title = "Dashboard List"
+keywords = ["grafana", "dashboard list", "documentation", "panel", "dashlist"]
+type = "docs"
+[menu.docs]
+name = "Dashboard list"
+parent = "panels"
+weight = 4
++++
-# Dashlist Panel
-## Overview
+# Dashboard List Panel
-The dashboard list panel allows you to display dynamic links to other dashboards. The list can be configured to use starred dashboards, a search query and/or dashboard tags.
+The dashboard list panel allows you to display dynamic links to other dashboards. The list can be configured to use starred dashboards, a search query and/or dashboard tags.
-
+
> On each dashboard load, the dashlist panel will re-query the dashboard list, always providing the most up to date results.
## Mode: Starred Dashboards
-The `starred` dashboard selection displays starred dashboards, up to the number specified in the `Limit Number to` field, in alphabetical order. On dashboard load, the dashlist panel will re-query the favorites to appear in dashboard list panel, always providing the most up to date results.
+The `starred` dashboard selection displays starred dashboards, up to the number specified in the `Limit Number to` field, in alphabetical order. On dashboard load, the dashlist panel will re-query the favorites to appear in dashboard list panel, always providing the most up to date results.
-
+
## Mode: Search Dashboards
-The panel may be configured to search by either string query or tag(s). On dashboard load, the dashlist panel will re-query the dashboard list, always providing the most up to date results.
+The panel may be configured to search by either string query or tag(s). On dashboard load, the dashlist panel will re-query the dashboard list, always providing the most up to date results.
To configure dashboard list in this manner, select `search` from the Mode select box. When selected, the Search Options section will appear.
@@ -38,14 +41,14 @@ Limit number to | Specify the maximum number of dashboards
### Search by string
-To search by a string, enter a search query in the `Search Options: Query` field. Queries are case-insensitive, and partial values are accepted.
-
+To search by a string, enter a search query in the `Search Options: Query` field. Queries are case-insensitive, and partial values are accepted.
+
### Search by tag
-To search by one or more tags, enter your selection in the `Search Options: Tags:` field. Note that existing tags will not appear as you type, and *are* case sensitive. To see a list of existing tags, you can always return to the dashboard, open the Dashboard Picker at the top and click `tags` link in the search bar.
-
+To search by one or more tags, enter your selection in the `Search Options: Tags:` field. Note that existing tags will not appear as you type, and *are* case sensitive. To see a list of existing tags, you can always return to the dashboard, open the Dashboard Picker at the top and click `tags` link in the search bar.
+
-> When multiple tags and strings appear, the dashboard list will display those matching ALL conditions.
+> When multiple tags and strings appear, the dashboard list will display those matching ALL conditions.
diff --git a/docs/sources/reference/export_import.md b/docs/sources/reference/export_import.md
index 0e830db959f..a05ce2f0c6b 100644
--- a/docs/sources/reference/export_import.md
+++ b/docs/sources/reference/export_import.md
@@ -1,18 +1,23 @@
----
-page_title: Export & Import Guide
-page_description: Export & Import Guide for Grafana
-page_keywords: grafana, export, import, documentation
----
++++
+title = "Export & Import"
+keywords = ["grafana", "dashboard", "documentation", "export", "import"]
+type = "docs"
+[menu.docs]
+parent = "dashboard_features"
+weight = 8
++++
# Export and Import
+Grafana Dashboads can easily be exported and imported, either from the UI or from the HTTP API.
+
## Exporting a dashboard
Dashboards are exported in Grafana JSON format, and contain everything you need (layout, variables, styles, data sources, queries, etc)to import the dashboard at a later time.
The export feature is accessed from the share menu.
-
+
### Making a dashboard portable
@@ -26,12 +31,12 @@ the dashboard, and will also be added as an required input when the dashboard is
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
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).
@@ -40,7 +45,7 @@ data source you want the dashboard to use and specify any metric prefixes (if th
Find dashboads for common server applications at [Grafana.net/dashboards](https://grafana.net/dashboards).
-
+
## Import & Sharing with Grafana 2.x or 3.0
diff --git a/docs/sources/reference/graph.md b/docs/sources/reference/graph.md
index 9c2ab63fbaa..62c42f78b92 100644
--- a/docs/sources/reference/graph.md
+++ b/docs/sources/reference/graph.md
@@ -1,20 +1,24 @@
-----
-page_title: Graph Panel
-page_description: Graph Panel Reference
-page_keywords: grafana, graph, panel, documentation
----
++++
+title = "Graph Panel"
+keywords = ["grafana", "graph panel", "documentation", "guide", "graph"]
+type = "docs"
+[menu.docs]
+name = "Graph"
+parent = "panels"
+weight = 1
++++
# Graph Panel
The main panel in Grafana is simply named Graph. It provides a very rich set of graphing options.
-
+
Clicking the title for a panel exposes a menu. The `edit` option opens additional configuration
options for the panel.
## General
-
+
The general tab allows customization of a panel's appearance and menu options.
@@ -52,7 +56,7 @@ options.
## Axes & Grid
-
+
The Axes & Grid tab controls the display of axes, grids and legend.
@@ -91,11 +95,11 @@ The legend values are calculated client side by Grafana and depend on what type
aggregation or point consolidation you metric query is using. All the above legend values cannot
be correct at the same time. For example if you plot a rate like requests/second, this is probably
using average as aggregator, then the Total in the legend will not represent the total number of requests.
-It is just the sum of all data data points received by Grafana.
+It is just the sum of all data points received by Grafana.
## Display styles
-
+
Display styles controls properties of the graph.
@@ -140,4 +144,4 @@ a thicker line width to make it standout.
## Time range
-
+
diff --git a/docs/sources/reference/keyboard_shortcuts.md b/docs/sources/reference/keyboard_shortcuts.md
index 9947418ae5a..96709dfb725 100644
--- a/docs/sources/reference/keyboard_shortcuts.md
+++ b/docs/sources/reference/keyboard_shortcuts.md
@@ -1,7 +1,11 @@
-page_title: Keyboard Shortcuts
-page_description: Keyboard Shortcuts for Grafana
-page_keywords: grafana, export, import, documentation
----
++++
+title = "Keyboard shortcuts"
+keywords = ["grafana", "dashboard", "documentation", "shortcuts"]
+type = "docs"
+[menu.docs]
+parent = "dashboard_features"
+weight = 8
++++
# Keyboard Shortcuts
@@ -11,7 +15,7 @@ No mouse? No problem. Grafana has extensive keyboard shortcuts to allow you to n
Press `Shift`+`?` to open the keyboard shortcut dialog from anywhere within the dashboard views.
-
+
|Shortcut|Action|
diff --git a/docs/sources/reference/playlist.md b/docs/sources/reference/playlist.md
index f35767625c5..359a5d8f3bd 100644
--- a/docs/sources/reference/playlist.md
+++ b/docs/sources/reference/playlist.md
@@ -1,8 +1,12 @@
----
-page_title: Playlist Guide
-page_description: Playlist guide for Grafana
-page_keywords: grafana, playlist, documentation
----
++++
+title = "Playlist"
+keywords = ["grafana", "dashboard", "documentation", "playlist"]
+type = "docs"
+[menu.docs]
+parent = "dashboard_features"
+weight = 4
++++
+
# Playlist
@@ -12,9 +16,9 @@ Since Grafana automatically scales Dashboards to any resolution they're perfect
## Creating a Playlist
-The Playlist feature can be accessed from Grafana's sidemenu. Click the 'Playlist' button from the sidemenu to access the Playlist functionality. When 'Playlist' button is clicked, playlist view will open up showing saved playlists and an option to create new playlists.
+{{< 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.
Click on "New Playlist" button to create a new playlist. Firstly, name your playlist and configure a time interval for Grafana to wait on a particular Dashboard before advancing to the next one on the Playlist.
diff --git a/docs/sources/reference/scripting.md b/docs/sources/reference/scripting.md
index d896a2c7650..551805b567a 100644
--- a/docs/sources/reference/scripting.md
+++ b/docs/sources/reference/scripting.md
@@ -1,8 +1,12 @@
-----
-page_title: Scripted dashboards
-page_description: Scripted dashboards
-page_keywords: grafana, scripted, guide, documentation
----
++++
+title = "Scripted Dashboards"
+keywords = ["grafana", "dashboard", "documentation", "scripted"]
+type = "docs"
+[menu.docs]
+parent = "dashboard_features"
+weight = 9
++++
+
# Scripted Dashboards
diff --git a/docs/sources/reference/search.md b/docs/sources/reference/search.md
index e2d6647229c..04d317d38e0 100644
--- a/docs/sources/reference/search.md
+++ b/docs/sources/reference/search.md
@@ -1,54 +1,58 @@
-----
-page_title: Dashboard Search
-page_description: Dashboard Search in Grafana
-page_keywords: grafana, search, guide, documentation
----
++++
+title = "Search"
+keywords = ["grafana", "dashboard", "documentation", "search"]
+type = "docs"
+[menu.docs]
+parent = "dashboard_features"
+weight = 5
++++
+
# Dashboard Search
Dashboards can be searched by the dashboard name, filtered by one (or many) tags or filtered by starred status. The dashboard search is accessed through the dashboard picker, available in the dashboard top nav area.
-
+
1. `Dashboard Picker`: The Dashboard Picker is your primary navigation tool to move between dashboards. It is present on all dashboards, and open the Dashboard Search. The dashboard picker also doubles as the title of the current dashboard.
2. `Search Bar`: The search bar allows you to enter any string and search both database and file based dashboards in real-time.
-3. `Starred`: The starred link allows you to filter the list to display only starred dashboards.
-4. `Tags`: The tags filter allows you to filter the list by dashboard tags.
+3. `Starred`: The starred link allows you to filter the list to display only starred dashboards.
+4. `Tags`: The tags filter allows you to filter the list by dashboard tags.
When using only a keyboard, you can use your keyboard arrow keys to navigate the results, hit enter to open the selected dashboard.
## Find by dashboard name
-
+
-To search and load dashboards click the open folder icon in the header or use the shortcut `CTRL`+`F`. Begin typing any part of the desired dashboard names. Search will return results for for any partial string match in real-time, as you type.
+To search and load dashboards click the open folder icon in the header or use the shortcut `CTRL`+`F`. Begin typing any part of the desired dashboard names. Search will return results for for any partial string match in real-time, as you type.
Dashboard search is:
- Real-time
- *Not* case sensitive
-- Functional across stored *and* file based dashboards.
+- Functional across stored *and* file based dashboards.
## Filter by Tag(s)
Tags are a great way to organize your dashboards, especially as the number of dashboards grow. Tags can be added and managed in the dashboard `Settings`.
-To filter the dashboard list by tag, click on any tag appearing in the right column. The list may be further filtered by clicking on additional tags:
+To filter the dashboard list by tag, click on any tag appearing in the right column. The list may be further filtered by clicking on additional tags:
-
+
Alternately, to see a list of all available tags, click the tags link in the search bar. All tags will be shown, and when a tag is selected, the dashboard search will be instantly filtered:
-
+
When using only a keyboard: `tab` to focus on the *tags* link, `▼` down arrow key to find a tag and select with the `Enter` key.
-**Note**: When multiple tags are selected, Grafana will show dashboards that include **all**.
+**Note**: When multiple tags are selected, Grafana will show dashboards that include **all**.
## Filter by Starred
Starring is a great way to organize and find commonly used dashboards. To show only starred dashboards in the list, click the *starred* link in the search bar:
-
+
-When using only a keyboard: `tab` to focus on the *stars* link, `▼` down arrow key to find a tag and select with the `Enter` key.
\ No newline at end of file
+When using only a keyboard: `tab` to focus on the *stars* link, `▼` down arrow key to find a tag and select with the `Enter` key.
diff --git a/docs/sources/reference/sharing.md b/docs/sources/reference/sharing.md
index c20f4e5f67c..08bfcf4c9d1 100644
--- a/docs/sources/reference/sharing.md
+++ b/docs/sources/reference/sharing.md
@@ -1,8 +1,11 @@
-----
-page_title: Sharing
-page_description: Sharing
-page_keywords: grafana, sharing, guide, documentation
----
++++
+title = "Sharing"
+keywords = ["grafana", "dashboard", "documentation", "sharing"]
+type = "docs"
+[menu.docs]
+parent = "dashboard_features"
+weight = 6
++++
# Sharing features
Grafana provides a number of ways to share a dashboard or a specific panel to other users within your
@@ -19,7 +22,7 @@ A dashboard snapshot is an instant way to share an interactive dashboard publicl
(metric, template and annotation) and panel links, leaving only the visible metric data and series names embedded into your dashboard. Dashboard
snapshots can be accessed by anyone who has the link and can reach the URL.
-
+
### Publish snapshots
You can publish snapshots to you local instance or to [snapshot.raintank.io](http://snapshot.raintank.io). The later is a free service
diff --git a/docs/sources/reference/singlestat.md b/docs/sources/reference/singlestat.md
index 954bfeed8b7..8c6cdc6c727 100644
--- a/docs/sources/reference/singlestat.md
+++ b/docs/sources/reference/singlestat.md
@@ -1,12 +1,17 @@
-----
-page_title: Singlestat Panel
-page_description: Singlestat Panel Reference
-page_keywords: grafana, singlestat, panel, documentation
----
++++
+title = "Singletat Panel"
+keywords = ["grafana", "dashboard", "documentation", "panels", "singlestat"]
+type = "docs"
+[menu.docs]
+name = "Singlestat"
+parent = "panels"
+weight = 2
++++
+
# Singlestat Panel
-
+
The Singlestat Panel allows you to show the one main summary stat of a SINGLE series. It reduces the series into a single number (by looking at the max, min, average, or sum of values in the series). Singlestat also provides thresholds to color the stat or the Panel background. It can also translate the single number into a text value, and show a sparkline summary of the series.
@@ -14,7 +19,7 @@ The Singlestat Panel allows you to show the one main summary stat of a SINGLE se
The singlestat panel has a normal query editor to allow you define your exact metric queries like many other Panels. Through the Options tab, you can access the Singlestat-specific functionality.
-
+
1. `Big Value`: Big Value refers to how we display the main stat for the Singlestat Panel. This is always a single value that is displayed in the Panel in between two strings, `Prefix` and `Suffix`. The single number is calculated by choosing a function (min,max,average,current,total) of your metric query. This functions reduces your query into a single numeric value.
2. `Font Size`: You can use this section to select the font size of the different texts in the Singlestat Panel, i.e. prefix, value and postfix.
@@ -27,19 +32,19 @@ The singlestat panel has a normal query editor to allow you define your exact me
The coloring options of the Singlestat Panel config allow you to dynamically change the colors based on the Singlestat value.
-
+
1. `Background`: This checkbox applies the configured thresholds and colors to the entirety of the Singlestat Panel background.
2. `Value`: This checkbox applies the configured thresholds and colors to the summary stat.
3. `Thresholds`: Change the background and value colors dynamically within the panel, depending on the Singlestat value. The threshold field accepts **2 comma-separated** values which represent 3 ranges that correspond to the three colors directly to the right. For example: if the thresholds are 70, 90 then the first color represents < 70, the second color represents between 70 and 90 and the third color represents > 90.
4. `Colors`: Select a color and opacity
-5. `Invert order`: This link toggles the threshold color order.For example: Green, Orange, Red (
) will become Red, Orange, Green (
).
+5. `Invert order`: This link toggles the threshold color order.For example: Green, Orange, Red (
) will become Red, Orange, Green (
).
### Spark Lines
Sparklines are a great way of seeing the historical data related to the summary stat, providing valuable context at a glance. Sparklines act differently than traditional Graph Panels and do not include x or y axis, coordinates, a legend, or ability to interact with the graph.
-
+
1. `Show`: The show checkbox will toggle whether the spark line is shown in the Panel. When unselected, only the Singlestat value will appear.
2. `Background`: Check if you want the sparklines to take up the full panel width, or uncheck if they should be below the main Singlestat value.
@@ -52,13 +57,13 @@ Sparklines are a great way of seeing the historical data related to the summary
Value to text mapping allows you to translate the value of the summary stat into explicit text. The text will respect all styling, thresholds and customization defined for the value. This can be useful to translate the number of the main Singlestat value into a context-specific human-readable word or message.
-
+
## Troubleshooting
### Multiple Series Error
-
+
Grafana 2.5 introduced stricter checking for multiple-series on singlestat panels. In previous versions, the panel logic did not verify that only a single series was used, and instead, displayed the first series encountered. Depending on your data source, this could have lead to inconsistent data being shown and/or a general confusion about which metric was being displayed.
diff --git a/docs/sources/reference/table_panel.md b/docs/sources/reference/table_panel.md
index a857be38357..616909c86e2 100644
--- a/docs/sources/reference/table_panel.md
+++ b/docs/sources/reference/table_panel.md
@@ -1,12 +1,17 @@
-----
-page_title: Table Panel
-page_description: Table Panel Reference
-page_keywords: grafana, table, panel, documentation
----
++++
+title = "Table Panel"
+keywords = ["grafana", "dashboard", "documentation", "panels", "table panel"]
+type = "docs"
+[menu.docs]
+name = "Table"
+parent = "panels"
+weight = 2
++++
+
# Table Panel
-
+
The new table panel is very flexible, supporting both multiple modes for time series as well as for
table, annotation and raw JSON data. It also provides date formatting and value formatting and coloring options.
@@ -17,7 +22,7 @@ To view table panels in action and test different configurations with sample dat
The table panel has many ways to manipulate your data for optimal presentation.
-
+
1. `Data`: Control how your query is transformed into a table.
2. `Table Display`: Table display options.
@@ -25,7 +30,7 @@ The table panel has many ways to manipulate your data for optimal presentation.
## Data to Table
-
+
The data section contains the **To Table Transform (1)**. This is the primary option for how your data/metric
query should be transformed into a table format. The **Columns (2)** option allows you to select what columns
@@ -33,38 +38,38 @@ you want in the table. Only applicable for some transforms.
### Time series to rows
-
+
In the most simple mode you can turn time series to rows. This means you get a `Time`, `Metric` and a `Value` column. Where `Metric` is the name of the time series.
### Time series to columns
-
+
This transform allows you to take multiple time series and group them by time. Which will result in the primary column being `Time` and a column for each time series.
### Time series aggregations
-
+
This table transformation will lay out your table into rows by metric, allowing columns of `Avg`, `Min`, `Max`, `Total`, `Current` and `Count`. More than one column can be added.
### Annotations
-
+
If you have annotations enabled in the dashboard you can have the table show them. If you configure this
mode then any queries you have in the metrics tab will be ignored.
### JSON Data
-
+
If you have an Elasticsearch **Raw Document** query or an Elasticsearch query without a `date histogram` use this
transform mode and pick the columns using the **Columns** section.
-
+
## Table Display
-
+
1. `Pagination (Page Size)`: The table display fields allow you to control The `Pagination` (page size) is the threshold at which the table rows will be broken into pages. For example, if your table had 95 records with a pagination value of 10, your table would be split across 9 pages.
2. `Scroll`: The `scroll bar` checkbox toggles the ability to scroll within the panel, when unchecked, the panel height will grow to display all rows.
@@ -75,7 +80,7 @@ transform mode and pick the columns using the **Columns** section.
The column styles allow you control how dates and numbers are formatted.
-
+
1. `Name or regex`: The Name or Regex field controls what columns the rule should be applied to. The regex or name filter will be matched against the column name not against column values.
2. `Type`: The three supported types of types are `Number`, `String` and `Date`.
diff --git a/docs/sources/reference/templating.md b/docs/sources/reference/templating.md
index e605af845ea..2ca8b47b9f9 100644
--- a/docs/sources/reference/templating.md
+++ b/docs/sources/reference/templating.md
@@ -1,15 +1,18 @@
-----
-page_title: Dashboard Templating
-page_description: Dashboard Templating
-page_keywords: grafana, templating, variables, guide, documentation
----
++++
+title = "Templating"
+keywords = ["grafana", "templating", "documentation", "guide"]
+type = "docs"
+[menu.docs]
+name = "Templating"
+parent = "dashboard_features"
+weight = 1
++++
-# Dashboard Templating
-
+# Templating
-## Overview
+
-Dashboard Templating allows you to make your Dashboards more interactive and dynamic.
+Dashboard Templating allows you to make your Dashboards more interactive and dynamic.
They’re one of the most powerful and most used features of Grafana, and they’ve recently gotten even more attention in Grafana 2.0 and Grafana 2.1.
@@ -40,13 +43,13 @@ You can utilize the special ** All ** value to allow the Dashboard user to query
#### Multi-select
As of Grafana 2.1, it is now possible to select a subset of Query Template variables (previously it was possible to select an individual value or 'All', not multiple values that were less than All). This is accomplished via the Multi-Select option. If enabled, the Dashboard user will be able to enable and disable individual variables.
-The Multi-Select functionality is taken a step further with the introduction of Multi-Select Tagging. This functionality allows you to group individual Template variables together under a Tag or Group name.
+The Multi-Select functionality is taken a step further with the introduction of Multi-Select Tagging. This functionality allows you to group individual Template variables together under a Tag or Group name.
-For example, if you were using Templating to list all 20 of your applications, you could use Multi-Select Tagging to group your applications by function or region or criticality, etc.
+For example, if you were using Templating to list all 20 of your applications, you could use Multi-Select Tagging to group your applications by function or region or criticality, etc.
> Note: Multi-Select Tagging functionality is currently experimental but is part of Grafana 2.1. To enable this feature click the enable icon when editing Template options for a particular variable.
-
+
Grafana gets the list of tags and the list of values in each tag by performing two queries on your metric namespace.
@@ -58,20 +61,19 @@ Note: a proof of concept shim that translates the metric query into a SQL call i
Once configured, Multi-Select Tagging provides a convenient way to group and your template variables, and slice your data in the exact way you want. The Tags can be seen on the right side of the template pull-down.
-
-
+
### Interval
Use the `Interval` type to create Template variables around time ranges (eg. `1m`,`1h`, `1d`). There is also a special `auto` option that will change depending on the current time range, you can specify how many times the current time range should be divided to calculate the current `auto` range.
-
+
### Custom
-Use the `Custom` type to manually create Template variables around explicit values that are hard-coded into the Dashboard, and not dependent on any Data Source. You can specify multiple Custom Template values by separating them with a comma.
+Use the `Custom` type to manually create Template variables around explicit values that are hard-coded into the Dashboard, and not dependent on any Data Source. You can specify multiple Custom Template values by separating them with a comma.
-## Utilizing Template Variables with Repeating Panels and Repeating Rows
+## Repeating Panels and Repeating Rows
Template Variables can be very useful to dynamically change what you're visualizing on a given panel. Sometimes, you might want to create entire new Panels (or Rows) based on what Template Variables have been selected. This is now possible in Grafana 2.1.
diff --git a/docs/sources/reference/timerange.md b/docs/sources/reference/timerange.md
index 2ab428622bc..0063a0ee361 100644
--- a/docs/sources/reference/timerange.md
+++ b/docs/sources/reference/timerange.md
@@ -1,32 +1,37 @@
-----
-page_title: Time Range options
-page_description: Time range user guide
-page_keywords: grafana, time range, guide, documentation
----
++++
+title = "Time Range"
+keywords = ["grafana", "dashboard", "documentation", "time range"]
+type = "docs"
+[menu.docs]
+name = "Time Range"
+parent = "dashboard_features"
+weight = 7
++++
+
# Time Range Controls
Grafana provides numerous ways to manage the time ranges of the data being visualized, both at the Dashboard-level and the Panel-level.
-
+
In the top right, you have the master Dashboard time picker (it's in between the 'Zoom out' and the 'Refresh' links).
-1. `Current time range & refresh interval`: This shows the current dashboard time and refresh interval. It also acts as the menu button to toggle the time range controls.
-2. `Quick ranges`: Quick ranges are preset values to choose a relative time. At this time, quick ranges are not configurable, and will appear on every dashboard.
+1. `Current time range & refresh interval`: This shows the current dashboard time and refresh interval. It also acts as the menu button to toggle the time range controls.
+2. `Quick ranges`: Quick ranges are preset values to choose a relative time. At this time, quick ranges are not configurable, and will appear on every dashboard.
3. `Time range`: The time range section allows you to mix both explicit and relative ranges. The explicit time range format is `YYYY-MM-DD HH:MM:SS`
-4. `Refreshing every:` When enabled, auto-refresh will reload the dashboard at the specified time range. Auto-refresh is most commonly used with relative time ranges ending in `now`, so new data will appear when the dashboard refreshes.
+4. `Refreshing every:` When enabled, auto-refresh will reload the dashboard at the specified time range. Auto-refresh is most commonly used with relative time ranges ending in `now`, so new data will appear when the dashboard refreshes.
These settings apply to all Panels in the Dashboard (except those with Panel Time Overrides enabled)
## Time Units
-The following time units are supported: `s (seconds)`, `m (minutes)`, `h (hours)`, `d (days)`, `w (weeks)`, `M (months)`, `y (years)`. The minus operator allows you to step back in time, relative to now. If you wish to display the full period of the unit (day, week, month, etc...), append `/$unit` to the end.
+The following time units are supported: `s (seconds)`, `m (minutes)`, `h (hours)`, `d (days)`, `w (weeks)`, `M (months)`, `y (years)`. The minus operator allows you to step back in time, relative to now. If you wish to display the full period of the unit (day, week, month, etc...), append `/$unit` to the end.
Take a look at some examples to seen these concepts in practice:
-Example Relative Range | From: | To:
--------------- | ----- | ---
+Example Relative Range | From: | To:
+-------------- | ----- | ---
Last 5 minutes | `now-5m` | `now`
The day so far | `now/d` | `now`
This week | `now/w` | `now/w`
@@ -38,7 +43,7 @@ Previous Month | `now-1M/M` | `now-1M/M`
There are two settings available from the Dashboard Settings area, allowing customization of the auto-refresh intervals and the definition of `now`.
-
+
### Auto-Refresh Options
@@ -54,15 +59,15 @@ Users often ask, [when will then be now](https://www.youtube.com/watch?v=VeZ9HhH
You can override the relative time range for individual panels, causing them to be different than what is selected in the Dashboard time picker in the upper right. This allows you to show metrics from different time periods or days at the same time.
-
+
You control these overrides in panel editor mode and the tab `Time Range`.
-
+
When you zoom or change the Dashboard time to a custom absolute time range, all panel overrides will be disabled. The panel relative time override is only active when the dashboard time is also relative. The panel timeshift override is always active, even when the dashboard time is absolute.
The `Hide time override info` option allows you to hide the override info text that is by default shown in the
upper right of a panel when overridden time range options.
-Note: You can only override the dashboard time with relative time ranges. Absolute time ranges are not available.
+Note: You can only override the dashboard time with relative time ranges. Absolute time ranges are not available.
diff --git a/docs/sources/tutorials/hubot_howto.md b/docs/sources/tutorials/hubot_howto.md
index 85ebb3e7c85..2478e0569f0 100644
--- a/docs/sources/tutorials/hubot_howto.md
+++ b/docs/sources/tutorials/hubot_howto.md
@@ -1,9 +1,11 @@
----
-page_title: How To integrate Hubot and Grafana
-page_description: Hubot Grafana install guide
-page_keywords: grafana, tutorials, hubot, slack, hipchat, setup, install, config
-author: Torkel Ödegaard
----
++++
+title = "How To integrate Hubot and Grafana"
+type = "docs"
+keywords = ["grafana", "tutorials", "hubot", "slack", "hipchat", "setup", "install", "config"]
+[menu.docs]
+parent = "tutorials"
+weight = 10
++++
# How to integrate Hubot with Grafana
@@ -20,7 +22,7 @@ take you to the graph.
> is so Hipchat and Slack can show them reliably (they require the image to be publicly available).
+
+
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.
@@ -113,7 +115,7 @@ Now you can add an alias like this:
+ 
|
- |