From 74b8e8244a37a4eecdec865b3d45c88d9ed631ef Mon Sep 17 00:00:00 2001 From: Masaori Koshiba Date: Wed, 24 Jun 2015 06:54:36 +0900 Subject: [PATCH] Add docs of KairosDB Datasource Plugin --- docs/mkdocs.yml | 1 + docs/sources/datasources/kairosdb.md | 47 ++++++++++++++++++++++++++++ docs/sources/index.md | 2 +- 3 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 docs/sources/datasources/kairosdb.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 2ff90577f07..082fb22d5ba 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -60,6 +60,7 @@ pages: - ['datasources/graphite.md', 'Data Sources', 'Graphite'] - ['datasources/influxdb.md', 'Data Sources', 'InfluxDB'] - ['datasources/opentsdb.md', 'Data Sources', 'OpenTSDB'] +- ['datasources/kairosdb.md', 'Data Sources', 'KairosDB'] - ['project/building_from_source.md', 'Project', 'Building from souce'] - ['project/cla.md', 'Project', 'Contributor License Agreement'] diff --git a/docs/sources/datasources/kairosdb.md b/docs/sources/datasources/kairosdb.md new file mode 100644 index 00000000000..f0d52b91548 --- /dev/null +++ b/docs/sources/datasources/kairosdb.md @@ -0,0 +1,47 @@ +--- +page_title: KairosDB Guide +page_description: KairosDB guide for Grafana +page_keywords: grafana, kairosdb, documentation +--- + +# KairosDB Guide + +## Adding the data source to Grafana +Open the side menu by clicking the the Grafana icon in the top header. In the side menu under the `Dashboards` link you +should find a link named `Data Sources`. 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. + + + +Now click the `Add new` link in the top header. + +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 directory from browser. + +## Query editor +Open a graph in edit mode by click the title. + + + +For details on KairosDB metric queries checkout the offical. + +- [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. If nothing is given, returns a list of all metric names. +`tag_names(query)` | Returns a list of tag names. If nothing is given, returns a list of all tag names. +`tag_values(query)` | Returns a list of tag values. If nothing is given, returns a list of all tag values. + +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) diff --git a/docs/sources/index.md b/docs/sources/index.md index 24ba087575e..5acd3815c1c 100644 --- a/docs/sources/index.md +++ b/docs/sources/index.md @@ -10,7 +10,7 @@ It provides a powerful and elegant way to create, share, and explore data and da Grafana is most commonly used for Internet infrastructure and application analytics, but many use it in other domains including industrial sensors, home automation, weather, and process control. -Grafana features pluggable panels and data sources allowing easy extensibility. There is currently rich support for [Graphite](http://graphite.readthedocs.org/en/latest/), [InfluxDB](http://influxdb.org) and [OpenTSDB](http://opentsdb.net). There is also experimental support for KairosDB, and SQL is on the roadmap. Grafana has a variety of panels, including a fully featured graph panel with rich visualization options. +Grafana features pluggable panels and data sources allowing easy extensibility. There is currently rich support for [Graphite](http://graphite.readthedocs.org/en/latest/), [InfluxDB](http://influxdb.org) and [OpenTSDB](http://opentsdb.net). There is also experimental support for [KairosDB](https://github.com/kairosdb/kairosdb), and SQL is on the roadmap. Grafana has a variety of panels, including a fully featured graph panel with rich visualization options. Version 2.0 was released in April 2015: Grafana now ships with its own backend server that brings [many changes and features](../guides/whats-new-in-v2/).