grafanimate 0.4.1

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.
  --dashboard-uid=<uid>         Grafana dashboard uid.

Optional:
  --panel-id=<id>               Render single panel only by navigating to "panelId=<id>&fullscreen".
  --dashboard-view=<mode>       Use Grafana's "d-solo" view for rendering single panels without header.

  --header-layout=<layout>      The header rendering subsystem offers different modes
                                for amending the vanilla Grafana user interface.
                                Multiple modes can be combined.
                                [default: large-font]

                                - no-chrome:            Set kiosk mode, remove sidemenu and more chrome
                                - large-font:           Use larger font sizes for title and datetime
                                - collapse-datetime:    Collapse datetime into title
                                - studio:               Apply studio modifications. This options aggregates
                                                        "no-chrome", "large-font" and "collapse-datetime".
                                - no-folder:            Don't include foldername in title

                                - no-title:             Turn off title widget
                                - no-datetime:          Turn off datetime widget

  --datetime-format=<format>    Datetime format to use with header layouts like "studio".
                                Examples: YYYY-MM-DD HH:mm:ss, YYYY, HH:mm.

                                There are also some format presets available here:
                                - human-date:           on 2018-08-14
                                - human-time:           at 03:16:05
                                - human-datetime:       on 2018-08-14 at 03:16:05

                                When left empty, the default is determined by the configured interval.

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


Examples for scenario mode. Script your animation in file "scenarios.py".

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

  # Use more parameters to control rendering process.
  grafanimate \
    --grafana-url=http://localhost:3000/ --scenario=ir_sensor_svg_pixmap --dashboard-uid=_TbvFUyik \
    --header-layout=studio --datetime-format=human-time --panel-id=6

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.