2015-03-10 02:55:42 -05:00
|
|
|
---
|
|
|
|
page_title: OpenTSDB Guide
|
|
|
|
page_description: OpenTSDB guide for Grafana
|
|
|
|
page_keywords: grafana, opentsdb, documentation
|
|
|
|
---
|
|
|
|
|
|
|
|
# OpenTSDB Guide
|
|
|
|
|
2015-04-13 04:49:12 -05:00
|
|
|
## 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.
|
2015-03-10 02:55:42 -05:00
|
|
|
|
2015-04-13 04:49:12 -05:00
|
|
|
![](/img/v2/add_datasource_opentsdb.png)
|
2015-03-10 02:55:42 -05:00
|
|
|
|
2015-04-13 04:49:12 -05:00
|
|
|
Now click the `Add new` link in the top header.
|
2015-03-10 02:55:42 -05:00
|
|
|
|
2015-04-13 04:49:12 -05:00
|
|
|
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 you opentsdb server (default port is usually 4242)
|
|
|
|
Access | Proxy = access via Grafana backend, Direct = access directory from browser.
|
2015-03-10 02:55:42 -05:00
|
|
|
|
2015-04-13 04:49:12 -05:00
|
|
|
## Query editor
|
2015-03-10 02:55:42 -05:00
|
|
|
Open a graph in edit mode by click the title.
|
|
|
|
|
2015-04-13 04:49:12 -05:00
|
|
|
![](/img/v2/opentsdb_query_editor.png)
|
2015-03-10 02:55:42 -05:00
|
|
|
|
2015-07-03 08:13:06 -05:00
|
|
|
### Auto complete suggestions
|
|
|
|
You should get auto complete suggestions for tags and tag values. If you do not you need to enable `tsd.core.meta.enable_realtime_ts` in
|
|
|
|
the OpentSDB server settings. This is required for the OpenTSDB `lookup` api to work.
|
|
|
|
|
2015-06-30 08:37:59 -05:00
|
|
|
## Templating queries
|
|
|
|
|
|
|
|
When using OpenTSDB with a template variable of `query` type you can use following syntax for lookup.
|
|
|
|
|
|
|
|
metrics() // returns metric names
|
|
|
|
tag_names(cpu) // return tag names (i.e. keys) for a specific cpu metric
|
|
|
|
tag_values(cpu, hostname) // return tag values for metric cpu and tag key hostname
|
|
|
|
|
2015-06-02 10:45:44 -05:00
|
|
|
For details on opentsdb metric queries checkout the official [OpenTSDB documentation](http://opentsdb.net/docs/build/html/index.html)
|
2015-03-10 02:55:42 -05:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|