---
title: "Consul data source plugin for Grafana"
description: "Consul datasource plugin to integrate Consul key value data with Grafana. Consul data source plugin for Grafana by sbueringer."
---

> This is the Markdown version of https://grafana.com/grafana/plugins/sbueringer-consul-datasource/

# Consul

- Developer: sbueringer
- Version: 0.2.1
- [Installation](https://grafana.com/grafana/plugins/sbueringer-consul-datasource/installation.md)

![Variables](https://grafana.com/api/plugins/sbueringer-consul-datasource/versions/0.2.1/images/images/keys.png)

![Overview](https://grafana.com/api/plugins/sbueringer-consul-datasource/versions/0.2.1/images/images/overview.png)

![Table](https://grafana.com/api/plugins/sbueringer-consul-datasource/versions/0.2.1/images/images/table.png)

![Tags](https://grafana.com/api/plugins/sbueringer-consul-datasource/versions/0.2.1/images/images/tags.png)

# Grafana datasource for Consul

[![Travis](https://img.shields.io/travis/sbueringer/grafana-consul-datasource.svg)](https://travis-ci.org/sbueringer/grafana-consul-datasource)[![Codecov](https://img.shields.io/codecov/c/github/sbueringer/grafana-consul-datasource.svg)](https://codecov.io/gh/sbueringer/grafana-consul-datasource)[![CodeFactor](https://www.codefactor.io/repository/github/sbueringer/grafana-consul-datasource/badge)](https://www.codefactor.io/repository/github/sbueringer/grafana-consul-datasource)[![GoReportCard](https://goreportcard.com/badge/github.com/sbueringer/grafana-consul-datasource?style=plastic)](https://goreportcard.com/report/github.com/sbueringer/grafana-consul-datasource)[![GitHub release](https://img.shields.io/github/release/sbueringer/grafana-consul-datasource.svg)](https://github.com/sbueringer/grafana-consul-datasource/releases)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/sbueringer/grafana-consul-datasource/issues)

This datasource lets you integrate key value data from Consul in Grafana dashboards.

![Overview](https://github.com/sbueringer/grafana-consul-datasource/raw/master/src/images/overview.png)

# Usage

The data can be used in **table** and **single-stat** panels. The following explanations are based on the example available in the [example folder](https://github.com/sbueringer/grafana-consul-datasource/tree/master/example).

## Adding the datasource

1. In the side menu in the `Configuration` section you should find a link named `Data Sources`.
2. Click the `Add data source` button in the top header.
3. Select `Consul`.
4. Fill in the datasource name, the Consul address and the Consul token (or leave it empty)
5. Click the `Save & Test` button

## Features

- Consul keys can be used as Dashboard variable values
- Numeric Consul keys can be retrieved directly and displayed in Singlestat panels
- Consul key/value pairs can be retrieved via Timeseries tags and displayed in Singlestat panels
- Consul key/value pairs can be displayed in Table panels.

## Examples

### Variables

![Variables](https://github.com/sbueringer/grafana-consul-datasource/raw/master/src/images/keys.png)

This example shows how keys can be queried to use them as variables. This query retrieves all direct subkeys of `registry/apiregistration.k8s.io/apiservices/`. The subkeys are then matched via the regex and can then be used as variable values.

### Singlestat Panel

![Tags](https://github.com/sbueringer/grafana-consul-datasource/raw/master/src/images/tags.png)

This example shows how subkeys can be retrieved as tags. These tags can then be displayed in the Single Stat panel by defining a legend format. _Note_: This only works if `Value / Stat` in the `Option` tab is set to `Name`.

### Table Panel

![Table](https://github.com/sbueringer/grafana-consul-datasource/raw/master/src/images/table.png)

The final examples shows how key/value pairs can be displayed in tables. Every matching key of the query results in one row. Columns can then be retrieved relative from this key.
