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 ofGrafana dashboards in YAML format, anduses them to produce JSON formatted output suitable for direct importinto Grafana.

The tool uses theVoluptuous datavalidation library to ensure the input produces a valid dashboard. Alongwith validation, users receive the benefits of YAML markup such ascomments 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: hostnametype: querydatasource: graphitequery: node*refresh:truetitle: My great dashboardrows:-title: CPU Usageheight: 250pxpanels:-title: CPU Usage for $hostnametype: graphdatasource: graphitetargets:-target: $hostname.Cpu.cpu_prct_used

grafyaml can be very useful in continuous-integrationenvironments. Users can specify their dashboards via a normal reviewprocess and tests can validate their correctness.

The tool can also take JSON manually exported from the Grafanainterface and load it as a dashboard. This allows keeping dashboardsthat have been edited with the inbuilt editor externally versioncontrolled.

A large number of examples are available in the OpenStackproject-configrepository, which are used to create dashboards onhttp://grafana.openstack.org.