Skip to main content

Grafyaml takes simple descriptions of Grafana dashboards in YAML format, and uses them to configure grafana.

Project description


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

    from: "2018-02-07T08:42:27.000Z"
    to: "2018-02-07T13:48:32.000Z"
    - name: hostname
      type: query
      datasource: graphite
      query: node*
      refresh: true
  title: My great dashboard
    - title: CPU Usage
      height: 250px
          - title: CPU Usage for $hostname
            type: graph
            datasource: graphite
              - 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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

grafyaml-0.0.8.tar.gz (37.9 kB view hashes)

Uploaded source

Built Distribution

grafyaml-0.0.8-py2.py3-none-any.whl (35.0 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page