Skip to main content

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

Project description

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.

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.

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.9.tar.gz (45.0 kB view details)

Uploaded Source

Built Distribution

grafyaml-0.0.9-py2.py3-none-any.whl (38.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file grafyaml-0.0.9.tar.gz.

File metadata

  • Download URL: grafyaml-0.0.9.tar.gz
  • Upload date:
  • Size: 45.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.8

File hashes

Hashes for grafyaml-0.0.9.tar.gz
Algorithm Hash digest
SHA256 f3498196a351929e663fb5b9dba3b9bab721ff0445d0b1ac882c175b790359df
MD5 faa31df124fe7617335d601154184b69
BLAKE2b-256 bcef2561221c7431ede9d69e72a603607ed6aa804961c1d0661cfb7b7e0eb8bd

See more details on using hashes here.

File details

Details for the file grafyaml-0.0.9-py2.py3-none-any.whl.

File metadata

  • Download URL: grafyaml-0.0.9-py2.py3-none-any.whl
  • Upload date:
  • Size: 38.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.8

File hashes

Hashes for grafyaml-0.0.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c818ff62f065d2a8c4fdf72ffb487fa2dedfe82e762b0c1c2c8e85af31ae05a0
MD5 e6435429e5133679683a9c57afaa1d5c
BLAKE2b-256 35f847fb18aa2f02f25e6a9f7e13caa4fcf851a2e1c1e5ab8af0278fb2bf9e54

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page