Grafyaml takes simple descriptions of Grafana dashboards in YAML format, and uses them to configure grafana.
Project description
At a glance
Free software: Apache license
Documentation: http://docs.openstack.org/infra/grafyaml/
Source: http://git.openstack.org/cgit/openstack-infra/grafyaml
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for grafyaml-0.0.9-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c818ff62f065d2a8c4fdf72ffb487fa2dedfe82e762b0c1c2c8e85af31ae05a0 |
|
MD5 | e6435429e5133679683a9c57afaa1d5c |
|
BLAKE2b-256 | 35f847fb18aa2f02f25e6a9f7e13caa4fcf851a2e1c1e5ab8af0278fb2bf9e54 |