IRONdb Datasource

This is the plugin for IRONdb 0.17.1 and newer. It is evolving and we continue to track its API.

Installation

The default location for the plugins directory is /var/lib/grafana/plugins, though the location may be different in your installation, see http://docs.grafana.org/plugins/installation/ for more plugin information.

From Releases

Download the desired release version.
Unzip into plugins directory.
Restart Grafana.

From GitHub

git clone https://github.com/circonus-labs/circonus-irondb-datasource.git into plugins directory.
Restart Grafana.

Alerts & Plugin Signing

To use Grafana's alerting functionality, additional build & configuration steps are required. Read more here.

Configuration

Create a new datasource and select IRONdb from the Type drop down.
Change the IRONdb configuration options at the bottom of the datasource configuration page.

IRONdb Type

Standalone: An IRONdb cluster accessible directly, requires entry of Account ID.
Hosted: An IRONdb instance hosted by Circonus, requires entry of API token.

Account ID

The Account ID associated with the account to pull metrics from.

API Token

The API Token associated with the account to pull metrics from. This can be found on your API Tokens page after logging in at https://www.circonus.com/ in the "User Profile" section.

Usage

Create a new panel and set the datasource to name selected in the IRONdb datasource configuration.

Normal Queries

For normal queries, use the metric browser to navigate the metric hierarchy of your IRONdb instance or type queries manually using the Toggle Edit Mode menu item to the right.

CAQL Queries

CAQL queries must be entered manually by selecting the CAQL checkbox or switching manually to the editor mode.

Histograms

Histograms currently require a special checkbox to be selected in order for the returned data to be processed correctly. Once selected, histogram data processing will be utilized for any returned data related to the specific metric.

Heatmaps

Using the histogram checkbox to process returned data allows for histograms to be displayed on the heatmap panel type.

For this processed data to be displayed on the heatmap panel as the sample above, select Time Series Buckets as the Data Format to be used on the Heatmap panel.

Template Variables

How to configure a template variable for IRONdb

From a dashboard, click Settings in the top right.
On the left hand side, select the Variables section.
Click +New and choose a name for your new variable.
Select the proper data source: IRONdb.
Under Query, enter the metric you wish to use in this variable (without tags), or enter the fully formed tag query, ala: and(__name:foo,or(bar:baz,quux:*)). Note that this query can contain references to other variables (see example below)
If you enable Include All Option, enter * for the Custom all value.
Click Enabled under Value groups/tags to enable tags support.
Enter the tag category you wish to use in your variable under Tag values query. See example below.
If you successfully completed the prior steps, Preview of values should now auto-complete the tag values.
Finish setup by clicking Add and then Save.

Example:

In this example, we are creating a variable called namespace using the query and(__name:used,cluster:$cluster) which contains a reference to another variable (not pictured). We are then pulling the values out of a tag also called namespace (you can see the preview values).

In this way you can make dependent variables that change in a hierarchy based on prior chosen variables.

Your new template variable should now appear in the query builder!

Development

The build process requires node, npm, yarn, typescrypt, and tslint

On Cent7 setup:

# One time setup
sudo yum install node bzip2
sudo npm install -g typescript tslint
yarn

# Build
yarn build

# Test
yarn test

dnck / circonus-irondb-datasource