Tools to make Grafana dashboards from templates

Go to file

OpenDev Sysadmins ad1e1e3537 OpenDev Migration Patch This commit was bulk generated and pushed by the OpenDev sysadmins as a part of the Git hosting and code review systems migration detailed in these mailing list posts: http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html Attempts have been made to correct repository namespaces and hostnames based on simple pattern matching, but it's possible some were updated incorrectly or missed entirely. Please reach out to us via the contact information listed at https://opendev.org/ with any questions you may have.		2019-04-19 19:26:03 +00: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 capability to use grafana folderid parameter	2019-02-26 21:25:37 +00:00
tests	Add capability to use grafana folderid parameter	2019-02-26 21:25:37 +00: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	OpenDev Migration Patch	2019-04-19 19:26:03 +00: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	Removed older version of python3.4	2019-01-06 14:35:50 +08: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	change default python 3 env in tox to 3.5	2018-06-15 08:33:19 +08:00

README.rst

grafyaml

At a glance

Free software: Apache license
Documentation: http://docs.openstack.org/infra/grafyaml/
Source: http://git.openstack.org/cgit/openstack-infra/grafyaml
Bugs: https://storyboard.openstack.org/#!/project/818

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.