opendev
/
grafyaml
Code Issues Proposed changes
Tools to make Grafana dashboards from templates
151 Commits 1 Branch 9 Tags 1.3 MiB
Python 99%
Dockerfile 1%
Go to file
qingszhao 3e4f2e5ee3 fix tox python3 overrides 
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.

We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.

We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.

Change-Id: I0d7c93b0c7e48dd86f3e1591596ca6e10caff196
 		2018-06-12 00:41:17 +08:00
doc/source Update documentation 2018-06-04 20:42:30 +10:00
etc Replace oslo_config dependency with argparse 2015-10-09 10:12:57 -04:00
grafana_dashboards Add datasource to template schema. 2018-03-26 18:02:45 +03:00
tests Test case for multiple targets with hidden 2018-06-04 15:53:39 +10:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:23:17 +00:00
.gitignore Update .gitignore to vim temporary files 2015-10-20 21:59:05 -04:00
.gitreview Initial Cookiecutter Commit. 2015-05-04 13:14:07 -04:00
.mailmap Initial Cookiecutter Commit. 2015-05-04 13:14:07 -04:00
.testr.conf Initial Cookiecutter Commit. 2015-05-04 13:14:07 -04:00
CONTRIBUTING.rst Initial Cookiecutter Commit. 2015-05-04 13:14:07 -04:00
HACKING.rst Initial Cookiecutter Commit. 2015-05-04 13:14:07 -04:00
LICENSE Initial Cookiecutter Commit. 2015-05-04 13:14:07 -04:00
MANIFEST.in Initial Cookiecutter Commit. 2015-05-04 13:14:07 -04:00
README.rst Update documentation 2018-06-04 20:42:30 +10:00
openstack-common.conf Initial Cookiecutter Commit. 2015-05-04 13:14:07 -04:00
requirements.txt Update documentation 2018-06-04 20:42:30 +10:00
setup.cfg Enable wheel univeral support 2015-11-03 16:11:40 -05:00
setup.py Bump pbr requirement to >= 1.3 2015-09-21 13:38:59 +00:00
test-requirements.txt Update documentation 2018-06-04 20:42:30 +10:00
tox.ini fix tox python3 overrides 2018-06-12 00:41:17 +08:00

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

dashboard:
  time:
    from: "2018-02-07T08:42:27.000Z"
    to: "2018-02-07T13:48:32.000Z"
  templating:
    - name: hostname
      type: query
      datasource: graphite
      query: node*
      refresh: true
  title: My great dashboard
  rows:
    - title: CPU Usage
      height: 250px
      panels:
          - title: CPU Usage for $hostname
            type: graph
            datasource: graphite
            targets:
              - target: $hostname.Cpu.cpu_prct_used

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.

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