Tools to make Grafana dashboards from templates
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Zuul 39d8bd1d84 Merge "Add import of json files" 12 hours ago
doc/source Add import of json files 11 months ago
etc Replace oslo_config dependency with argparse 6 years ago
grafana_dashboards Merge "Add import of json files" 12 hours ago
tests Add import of json files 11 months ago
.coveragerc Change ignore-errors to ignore_errors 6 years ago
.gitignore Update .gitignore to vim temporary files 6 years ago
.gitreview OpenDev Migration Patch 2 years ago
.mailmap Initial Cookiecutter Commit. 6 years ago
.testr.conf Initial Cookiecutter Commit. 6 years ago
.zuul.yaml Build docker images 2 months ago
CONTRIBUTING.rst Initial Cookiecutter Commit. 6 years ago
Dockerfile Build docker images 2 months ago
HACKING.rst Initial Cookiecutter Commit. 6 years ago
LICENSE Initial Cookiecutter Commit. 6 years ago
MANIFEST.in Initial Cookiecutter Commit. 6 years ago
README.rst Add import of json files 11 months ago
openstack-common.conf Initial Cookiecutter Commit. 6 years ago
requirements.txt Update documentation 3 years ago
setup.cfg Drop Python 2 support 11 months ago
setup.py Drop Python 2 support 11 months ago
test-requirements.txt Drop Python 2 support 11 months ago
tox.ini Drop Python 2 support 11 months ago

README.rst

grafyaml

At a glance

Overview

grafyaml takes descriptions of Grafana dashboards in YAML format, and uses them to produce JSON formatted output suitable for direct import into Grafana.

The tool uses the Voluptuous data validation library to ensure the input produces a valid dashboard. Along with validation, users receive the benefits of YAML markup such as comments and clearer type support.

For example, here is a minimal dashboard specification

grafyaml can be very useful in continuous-integration environments. Users can specify their dashboards via a normal review process and tests can validate their correctness.

The tool can also take JSON manually exported from the Grafana interface and load it as a dashboard. This allows keeping dashboards that have been edited with the inbuilt editor externally version controlled.

A large number of examples are available in the OpenStack project-config repository, which are used to create dashboards on http://grafana.openstack.org.