5f785f7782
This simply takes any json files present and loads them into Grafana directly. The idea is that you can edit the dashboards using the inbuilt editor, then copy the dashboard JSON and keep it externally version controlled. No parsing or validation is done on the JSON files; we are assuming they have not been hand-modified from what Grafana generates. Change-Id: I38695aed2404f8b7fc350d949b7a9212498c35cb
65 lines
1.9 KiB
ReStructuredText
65 lines
1.9 KiB
ReStructuredText
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 <https://grafana.com/>`__
|
|
dashboards in YAML format, and uses them to produce JSON formatted
|
|
output suitable for direct import into Grafana.
|
|
|
|
The tool uses the `Voluptuous
|
|
<https://github.com/alecthomas/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
|
|
|
|
.. code-block:: yaml
|
|
|
|
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
|
|
<https://git.openstack.org/cgit/openstack-infra/project-config/tree/grafana>`__
|
|
repository, which are used to create dashboards on
|
|
`<http://grafana.openstack.org>`__.
|