Skip to content

vikramjakhr/grafana-dashboard-exporter

Repository files navigation

GDE (Grafana Dashboard Exporter) CircleCI

GDE is an extremely powerful open source agent for backing up grafana dashboards. It's based on the influxdata telegraf theme.

Design goals are to have a minimal memory footprint with a plugin system so that developers in the community can easily add support for collecting metrics.

GDE is plugin-driven and has the concept of 2 distinct plugin types:

  1. Input Plugins collect grafana dashboards json from the grafana server
  2. Output Plugins write metrics to various destinations

New plugins are designed to be easy to contribute, we'll eagerly accept pull requests and will manage the set of plugins that GDE supports.

Contributing

There are many ways to contribute:

Installation:

You can download the binaries directly from the releases section.

Ansible Role:

Ansible role: In progress :)

From Source:

GDE requires golang version 1.9 or newer, the Makefile requires GNU make.

  1. Install Go >=1.9 (1.11 recommended)
  2. Install dep ==v0.5.0
  3. Download Telegraf source:
    go get -d github.com/vikramjakhr/grafana-dashboard-exporter
    
  4. Run make from the source directory
    cd "$HOME/go/src/github.com/vikramjakhr/grafana-dashboard-exporter"
    make
    

Changelog

View the changelog for the latest updates and changes by version.

How to use it:

See usage with:

gde --help

Generate a gde config file:

gde config > gde.conf

Generate config with only grafana input & S3 output plugins defined:

gde --input-filter grafana --output-filter s3 config

Run a single gde collection:

gde --config gde.conf --test

Run gde with all plugins defined in config file:

gde --config gde.conf

Input Plugins

Output Plugins