grafanimate 0.3.0

About

grafanimate captures screenshots while animating a Grafana dashboard by manipulating its time range control, i.e. navigating through time.

The result can be saved as a sequence of images, an animated gif file or as a video file.

Demo

Screenshot

Coverage of luftdaten.info sensors starting October 2015.

Usage

$ grafanimate --help

Usage:
  grafanimate [options] [--target=<target>]...
  grafanimate --version
  grafanimate (-h | --help)

Options:
  --grafana-url=<url>           Base URL to Grafana, [default: http://localhost:3000].
  --scenario=<scenario>         Which scenario to run. Scenarios are defined as methods in file "scenarios.py".
  --dashboard-uid=<uid>         Grafana dashboard uid

  --debug                       Enable debug logging
  -h --help                     Show this screen

  --target=<target>             Data output target (not available yet)

Examples:

  # Generate sequence of .png files in ./var/spool/ldi_all/1aOmc1sik
  grafanimate --grafana-url=http://localhost:3000/ --scenario=ldi_all --dashboard-uid=1aOmc1sik


Todo: Implement ad-hoc mode.
Until then, please use scenario mode.
Don't be afraid, it's just some copy/pasting in the scenarios.py file, go ahead.

  --start=<start>               Start time
  --end=<end>                   End time
  --interval=<end>              Interval time

Setup

brew upgrade ffmpeg --with-freetype

virtualenv --python=python2 .venv2
source .venv2/bin/activate
pip install grafanimate

Thoughts

Animating things in Grafana across the time-axis in the spirit of the GeoLoop Panel Plugin but in a more general way has not been unlocked for Grafana yet.

At this programs’ core is the code to set time range in Grafana:

timeSrv = angular.element('grafana-app').injector().get('timeSrv');
timeSrv.setTime({from: "2015-10-01", to: "2018-12-31"});

Turtles all the way up, the main rendering work horse is a Firefox Browser automated through Marionette Python Client fame:

The Marionette Python client library allows you to remotely control a Gecko-based browser or device which is running a Marionette server.

Project information

grafanimate is released under the GNU AGPL v3 license.

The code lives on GitHub and the Python package is published to PyPI.

The software has been tested on Python 2.7.