Using OpenTSDB in Grafana
Grafana ships with advanced support for OpenTSDB.
Adding the data source
- Open the side menu by clicking the Grafana icon in the top header.
- In the side menu under the
Dashboardslink you should find a link named
- Click the
+ Add data sourcebutton in the top header.
- Select OpenTSDB from the Type dropdown.
NOTE: If you’re not seeing the
Data Sourceslink in your side menu it means that your current user does not have the
Adminrole for the current organization.
|Name||The data source name. This is how you refer to the data source in panels and queries.|
|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||Server (default) = URL needs to be accessible from the Grafana backend/server, Browser = URL needs to be accessible from the browser.|
|Version||Version = opentsdb version, either <=2.1 or 2.2|
|Resolution||Metrics from opentsdb may have datapoints with either second or millisecond resolution.|
Open a graph in edit mode by click the title. Query editor will differ if the data source has version <=2.1 or = 2.2. In the former version, only tags can be used to query OpenTSDB. But in the latter version, filters as well as tags can be used to query opentsdb. Fill Policy is also introduced in OpenTSDB 2.2.
Note: While using OpenTSDB 2.2 data source, make sure you use either Filters or Tags as they are mutually exclusive. If used together, might give you weird results.
Auto complete suggestions
As soon as you start typing metric names, tag names and tag values , you should see highlighted auto complete suggestions for them. The autocomplete only works if the OpenTSDB suggest API is enabled.
Instead of hard-coding things like server, application and sensor name in your metric queries you can use variables in their place. Variables are shown as dropdown select boxes at the top of the dashboard. These dropdowns make it easy to change the data being displayed in your dashboard.
Check out the Templating documentation for an introduction to the templating feature and the different types of template variables.
Grafana’s OpenTSDB data source supports template variable queries. This means you can create template variables that fetch the values from OpenTSDB. For example, metric names, tag names, or tag values.
When using OpenTSDB with a template variable of
query type you can use following syntax for lookup.
|metrics(prefix)||Returns metric names with specific prefix (can be empty)|
|tag_names(cpu)||Returns tag names (i.e. keys) for a specific cpu metric|
|tag_values(cpu, hostname)||Returns tag values for metric cpu and tag key hostname|
|suggest_tagk(prefix)||Returns tag names (i.e. keys) for all metrics with specific prefix (can be empty)|
|suggest_tagv(prefix)||Returns tag values for all metrics with specific prefix (can be empty)|
If you do not see template variables being populated in
Preview of values section, you need to enable
tsd.core.meta.enable_realtime_ts in the OpenTSDB server settings. Also, to populate metadata of
the existing time series data in OpenTSDB, you need to run
tsdb uid metasync on the OpenTSDB server.
One template variable can be used to filter tag values for another template variable. First parameter is the metric name, second parameter is the tag key for which you need to find tag values, and after that all other dependent template variables. Some examples are mentioned below to make nested template queries work successfully.
|tag_values(cpu, hostname, env=$env)||Return tag values for cpu metric, selected env tag value and tag key hostname|
|tag_values(cpu, hostname, env=$env, region=$region)||Return tag values for cpu metric, selected env tag value, selected region tag value and tag key hostname|
For details on OpenTSDB metric queries, check out the official OpenTSDB documentation
Configure the data source with provisioning
It’s now possible to configure data sources using config files with Grafana’s provisioning system. You can read more about how it works and all the settings you can set for data sources on the provisioning docs page
Here are some provisioning examples for this data source.
apiVersion: 1 datasources: - name: OpenTsdb type: opentsdb access: proxy url: http://localhost:4242 jsonData: tsdbResolution: 1 tsdbVersion: 1
By default, at most 1000 records are looked up from OpenTSDB. You can change this by modifying the “Lookup Limit” in the OpenTSDB settings page.