diff --git a/docs/sources/administration/cli.md b/docs/sources/administration/cli.md index 99446fb5f1b..ebe910503aa 100644 --- a/docs/sources/administration/cli.md +++ b/docs/sources/administration/cli.md @@ -10,11 +10,14 @@ weight = 8 # Grafana CLI -Grafana cli is a small executable that is bundled with grafana server and is suppose to be executed on the same machine as grafana runs. +Grafana cli is a small executable that is bundled with grafana server and is suppose to be +executed on the same machine as grafana runs. ## Plugins -The CLI helps you install, upgrade and manage your plugins on the same machine it CLI is running. You can find more information about how to install and manage your plugins at the [plugin page] ({{< relref "/installation.md" >}}) +The CLI helps you install, upgrade and manage your plugins on the same machine it CLI is running. +You can find more information about how to install and manage your plugins at the +[plugin page]({{< relref "plugins/installation.md" >}}). ## Admin diff --git a/docs/sources/alerting/rules.md b/docs/sources/alerting/rules.md index af3cfecfdb8..a2688de3100 100644 --- a/docs/sources/alerting/rules.md +++ b/docs/sources/alerting/rules.md @@ -33,7 +33,7 @@ of core Grafana. Only some data soures are supported right now. They include `Gr ### Clustering We have not implemented clustering yet. So if you run multiple instances of grafana-server -you have to make sure [execute_alerts]({{< relref "/installation/configuration.md#alerting" >}}) +you have to make sure [execute_alerts]({{< relref "installation/configuration.md#alerting" >}}) is true on only one instance or otherwise you will get duplicated notifications.
diff --git a/docs/sources/features/datasources/cloudwatch.md b/docs/sources/features/datasources/cloudwatch.md index b4ad0b3288e..c2896c5b172 100644 --- a/docs/sources/features/datasources/cloudwatch.md +++ b/docs/sources/features/datasources/cloudwatch.md @@ -3,6 +3,7 @@ title = "AWS CloudWatch" description = "Guide for using CloudWatch in Grafana" keywords = ["grafana", "cloudwatch", "guide"] type = "docs" +aliases = ["/datasources/cloudwatch"] [menu.docs] name = "AWS Cloudwatch" identifier = "cloudwatch" diff --git a/docs/sources/features/datasources/elasticsearch.md b/docs/sources/features/datasources/elasticsearch.md index 345f68a9220..4f8bfaf968c 100644 --- a/docs/sources/features/datasources/elasticsearch.md +++ b/docs/sources/features/datasources/elasticsearch.md @@ -3,6 +3,7 @@ title = "Using Elasticsearch in Grafana" description = "Guide for using Elasticsearch in Grafana" keywords = ["grafana", "elasticsearch", "guide"] type = "docs" +aliases = ["/datasources/elasticsearch"] [menu.docs] name = "Elasticsearch" parent = "datasources" diff --git a/docs/sources/features/datasources/graphite.md b/docs/sources/features/datasources/graphite.md index 44a4dff3761..11e15ab503e 100644 --- a/docs/sources/features/datasources/graphite.md +++ b/docs/sources/features/datasources/graphite.md @@ -3,6 +3,7 @@ title = "Using Graphite in Grafana" description = "Guide for using graphite in Grafana" keywords = ["grafana", "graphite", "guide"] type = "docs" +aliases = ["/datasources/graphite"] [menu.docs] name = "Graphite" identifier = "graphite" diff --git a/docs/sources/features/datasources/influxdb.md b/docs/sources/features/datasources/influxdb.md index c6afdfdc8d4..c271571aa31 100644 --- a/docs/sources/features/datasources/influxdb.md +++ b/docs/sources/features/datasources/influxdb.md @@ -3,6 +3,7 @@ title = "Using InfluxDB in Grafana" description = "Guide for using InfluxDB in Grafana" keywords = ["grafana", "influxdb", "guide"] type = "docs" +aliases = ["/datasources/influxdb"] [menu.docs] name = "InfluxDB" parent = "datasources" diff --git a/docs/sources/features/datasources/kairosdb.md b/docs/sources/features/datasources/kairosdb.md deleted file mode 100644 index d27105d0ee1..00000000000 --- a/docs/sources/features/datasources/kairosdb.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -page_title: KairosDB Guide -page_description: KairosDB guide for Grafana -page_keywords: grafana, kairosdb, documentation ---- - -# KairosDB Guide -Grafana v2.1 brings initial support for KairosDB Datasources. While the process of adding the datasource is similar to adding a Graphite or OpenTSDB datasource type, Kairos DB does have a few different options for building queries. - -## Adding the data source to Grafana -![](/img/v2/add_KairosDB.jpg) - -1. Open the side menu by clicking the the Grafana icon in the top header. -2. In the side menu under the `Dashboards` link you should find a link named `Data Sources`. - - > NOTE: If this link is missing in the side menu it means that your current user does not have the `Admin` role for the current organization. - -3. Click the `Add new` link in the top header. -4. Select `KairosDB` from the dropdown. - - - -Name | Description ------------- | ------------- -Name | The data source name, important that this is the same as in Grafana v1.x if you plan to import old dashboards. -Default | Default data source means that it will be pre-selected for new panels. -Url | The http protocol, ip and port of your kairosdb server (default port is usually 8080) -Access | Proxy = access via Grafana backend, Direct = access directly from browser. - -## Query editor -Open a graph in edit mode by click the title. - -![](/img/v2/kairos_query_editor.jpg) - -For details on KairosDB metric queries checkout the official. -- [Query Metrics - KairosDB 0.9.4 documentation](http://kairosdb.github.io/kairosdocs/restapi/QueryMetrics.html). - -## Templated queries -KairosDB Datasource Plugin provides following functions in `Variables values query` field in Templating Editor to query `metric names`, `tag names`, and `tag values` to kairosdb server. - -Name | Description -| ------- | --------| -`metrics(query)` | Returns a list of metric names matching `query`. If nothing is given, returns a list of all metric names. -`tag_names(query)` | Returns a list of tag names matching `query`. If nothing is given, returns a list of all tag names. -`tag_values(metric,tag)` | Returns a list of values for `tag` from the given `metric`. - -For details of `metric names`, `tag names`, and `tag values`, please refer to the KairosDB documentations. - -- [List Metric Names - KairosDB 0.9.4 documentation](http://kairosdb.github.io/kairosdocs/restapi/ListMetricNames.html) -- [List Tag Names - KairosDB 0.9.4 documentation](http://kairosdb.github.io/kairosdocs/restapi/ListTagNames.html) -- [List Tag Values - KairosDB 0.9.4 documentation](http://kairosdb.github.io/kairosdocs/restapi/ListTagValues.html) -- [Query Metrics - KairosDB 0.9.4 documentation](http://kairosdb.github.io/kairosdocs/restapi/QueryMetrics.html). diff --git a/docs/sources/features/datasources/opentsdb.md b/docs/sources/features/datasources/opentsdb.md index 7e81ebe1483..435852137a5 100644 --- a/docs/sources/features/datasources/opentsdb.md +++ b/docs/sources/features/datasources/opentsdb.md @@ -3,6 +3,7 @@ title = "Using OpenTSDB in Grafana" description = "Guide for using OpenTSDB in Grafana" keywords = ["grafana", "opentsdb", "guide"] type = "docs" +aliases = ["/datasources/opentsdb"] [menu.docs] name = "OpenTSDB" parent = "datasources" diff --git a/docs/sources/features/datasources/plugin_api.md b/docs/sources/features/datasources/plugin_api.md deleted file mode 100644 index 2e2121ed21a..00000000000 --- a/docs/sources/features/datasources/plugin_api.md +++ /dev/null @@ -1,34 +0,0 @@ ----- -page_title: Data source Plugin API -page_description: Data Source Plugin Description -page_keywords: grafana, data source, plugin, api, docs ---- - -# Data source plugin API - -All data sources in Grafana are implemented as plugins. - -## Breaking change in 2.2 - -In Grafana 2.2 a breaking change was introduced for how data source query editors -are structured, defined and loaded. This was in order to support mixing multiple data sources -in the same panel. - -In Grafana 2.2, the query editor is no longer defined using the partials section in -`plugin.json`, but defined via an angular directive named using convention naming -scheme like `metricQueryEditor`. For example - -Graphite defines a directive like this: - -```javascript -module.directive('metricQueryEditorGraphite', function() { - return {controller: 'GraphiteQueryCtrl', templateUrl: 'app/plugins/datasource/graphite/partials/query.editor.html'}; -}); -``` - -Even though the data source type name is with lowercase `g`, the directive uses capital `G` in `Graphite` because -that is how angular directives needs to be named in order to match an element with name ``. -You also specify the query controller here instead of in the query.editor.html partial like before. - - - diff --git a/docs/sources/features/datasources/prometheus.md b/docs/sources/features/datasources/prometheus.md index 2a35bb615cb..ee272f6b4c6 100644 --- a/docs/sources/features/datasources/prometheus.md +++ b/docs/sources/features/datasources/prometheus.md @@ -3,6 +3,7 @@ title = "Using Prometheus in Grafana" description = "Guide for using Prometheus in Grafana" keywords = ["grafana", "prometheus", "guide"] type = "docs" +aliases = ["/datasources/prometheus"] [menu.docs] name = "Prometheus" parent = "datasources" @@ -74,7 +75,7 @@ You can also use raw queries & regular expressions to extract anything you might ### Using templated variables in queries -When the `Include All` option or `Multi-Value` option is enabled, Grafana converts the labels from plain text to a regex compatible string. +When the `Include All` option or `Multi-Value` option is enabled, Grafana converts the labels from plain text to a regex compatible string. Which means you have to use `=~` instead of `=` in your Prometheus queries. For example `ALERTS{instance=~$instance}` instead of `ALERTS{instance=$instance}`. ![](/img/v2/prometheus_templating.png) diff --git a/docs/sources/features/datasources/testdata.md b/docs/sources/features/datasources/testdata.md index 02e99f7dd8a..3e3f0909700 100644 --- a/docs/sources/features/datasources/testdata.md +++ b/docs/sources/features/datasources/testdata.md @@ -1,23 +1,23 @@ +++ -title = "Grafana TestData" +title = "TestData" keywords = ["grafana", "dashboard", "documentation", "panels", "testdata"] type = "docs" [menu.docs] -name = "Grafana TestData" +name = "TestData" parent = "datasources" -weight = 2 +weight = 20 +++ -# Grafana TestData +# Grafana TestData - > NOTE: This plugin is disable by default. + > NOTE: This plugin is disable by default. -The purpose of this data sources is to make it easier to create fake data for any panel. -Using `Grafana TestData` you can build your own time series and have any panel render it. -This make is much easier to verify functionally since the data can be shared very +The purpose of this data sources is to make it easier to create fake data for any panel. +Using `Grafana TestData` you can build your own time series and have any panel render it. +This make is much easier to verify functionally since the data can be shared very -## Enable +## Enable `Grafana TestData` is not enabled by default. To enable it you have to go to `/plugins/testdata/edit` and click the enable button to enable it for each server. @@ -33,8 +33,8 @@ You can now choose different scenario that you want rendered in the drop down me ## CSV -The comma separated values scenario is the most powerful one since it lets you create any kind of graph you like. -Once you provided the numbers `Grafana TestData` will distribute them evenly based on the time range of your query. +The comma separated values scenario is the most powerful one since it lets you create any kind of graph you like. +Once you provided the numbers `Grafana TestData` will distribute them evenly based on the time range of your query. ![](/img/docs/v41/test_data_csv_example.png) @@ -45,10 +45,10 @@ Once you provided the numbers `Grafana TestData` will distribute them evenly bas ### Commit updates to the dashboards -If you want to submit a change to one of the current dashboards bundled with `Grafana TestData` you have to update the revision property. +If you want to submit a change to one of the current dashboards bundled with `Grafana TestData` you have to update the revision property. Otherwise the dashboard will not be updated automatically for other Grafana users. ## Using test data in issues -If you post an issue on github regarding time series data or rendering of time series data we strongly advice you to use this data source to replicate the data. -That makes it much easier for the developers to replicate and solve the issue you have. +If you post an issue on github regarding time series data or rendering of time series data we strongly advice you to use this data source to replicate the data. +That makes it much easier for the developers to replicate and solve the issue you have. diff --git a/docs/sources/guides/basic_concepts.md b/docs/sources/guides/basic_concepts.md index bbb1cb53728..112b004ec92 100644 --- a/docs/sources/guides/basic_concepts.md +++ b/docs/sources/guides/basic_concepts.md @@ -16,7 +16,7 @@ This document is a “bottom up” introduction to basic concepts in Grafana, an ### Data Source Grafana supports many different storage backends for your time series data (Data Source). Each Data Source has a specific Query Editor that is customized for the features and capabilities that the particular Data Source exposes. -The following datasources are officially supported: [Graphite](/datasources/graphite/), [InfluxDB](/datasources/influxdb/), [OpenTSDB](/datasources/opentsdb/), [Prometheus](/datasources/prometheus/), [Elasticsearch](/datasources/elasticsearch/), [CloudWatch](/datasources/cloudwatch/), and [KairosDB](/datasources/kairosdb) +The following datasources are officially supported: [Graphite]({{< relref "features/datasources/graphite.md" >}}), [InfluxDB]({{< relref "features/datasources/influxdb.md" >}}), [OpenTSDB]({{< relref "features/datasources/opentsdb.md" >}}), [Prometheus]({{< relref "features/datasources/prometheus.md" >}}), [Elasticsearch]({{< relref "features/datasources/elasticsearch.md" >}}), [CloudWatch]({{< relref "features/datasources/cloudwatch.md" >}}). The query language and capabilities of each Data Source are obviously very different. You can combine data from multiple Data Sources onto a single Dashboard, but each Panel is tied to a specific Data Source that belongs to a particular Organization. diff --git a/docs/sources/index.md b/docs/sources/index.md index 0324bf888ad..daf1bd34c36 100644 --- a/docs/sources/index.md +++ b/docs/sources/index.md @@ -42,9 +42,9 @@ those options. ## 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/debian.md b/docs/sources/installation/debian.md index 088f7d14461..9c6140c0c6d 100644 --- a/docs/sources/installation/debian.md +++ b/docs/sources/installation/debian.md @@ -114,10 +114,10 @@ those options. ### Adding data sources -- [Graphite]({{< relref "datasources/graphite.md" >}}) -- [InfluxDB]({{< relref "datasources/influxdb.md" >}}) -- [OpenTSDB]({{< relref "datasources/opentsdb.md" >}}) -- [Prometheus]({{< relref "datasources/prometheus.md" >}}) +- [Graphite]({{< relref "features/datasources/graphite.md" >}}) +- [InfluxDB]({{< relref "features/datasources/influxdb.md" >}}) +- [OpenTSDB]({{< relref "features/datasources/opentsdb.md" >}}) +- [Prometheus]({{< relref "features/datasources/prometheus.md" >}}) ## Installing from binary tar file diff --git a/docs/sources/installation/rpm.md b/docs/sources/installation/rpm.md index 8be68232011..63181fc535d 100644 --- a/docs/sources/installation/rpm.md +++ b/docs/sources/installation/rpm.md @@ -121,10 +121,10 @@ those options. ### Adding data sources -- [Graphite]({{< relref "datasources/graphite.md" >}}) -- [InfluxDB]({{< relref "datasources/influxdb.md" >}}) -- [OpenTSDB]({{< relref "datasources/opentsdb.md" >}}) -- [Prometheus]({{< relref "datasources/prometheus.md" >}}) +- [Graphite]({{< relref "features/datasources/graphite.md" >}}) +- [InfluxDB]({{< relref "features/datasources/influxdb.md" >}}) +- [OpenTSDB]({{< relref "features/datasources/opentsdb.md" >}}) +- [Prometheus]({{< relref "features/datasources/prometheus.md" >}}) ### Server side image rendering