grafana-dashboard-reporter-app

module
v1.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 31, 2024 License: Apache-2.0

README

Grafana Dashboard Reporter App

CI/CD ci
Docs docs
Package Release
Meta GitHub License Go Report Card code style

This Grafana plugin app can create PDF reports of a given dashboard using headless chromium and grafana-image-renderer.

Sample report

This plugin is based on the original work grafana-reporter. The core of the plugin is heavily inspired from the above stated work with some improvements and modernization.

  • The current plugin uses HTML templates and headless chromium to generate reports instead of LaTeX. grafana-image-renderer is a prerequisite for both current and original plugins.

  • The current plugin app exposes the reporter as a custom API end point of Grafana instance without needing to run the grafana-reporter as a separate web service. The advantage of the plugin approach is the authenticated access to the reporter app is guaranteed by Grafana auth.

  • The plugin is capable of including all the repeated rows and/or panels in the generated report.

  • The plugin can include selected panels data into report which can be chosen using query parameters to the report API.

  • The plugin can be configured by Admins from Configuration Page and users using query parameters to the report API.

Documentation

More documentation can be found in README

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL