Plugins 〉Base64 Image/Video/Audio/PDF
Base64 Image/Video/Audio/PDF
Base64 Image/Video/Audio/PDF panel for Grafana
Introduction
The Base64 Image/Video/Audio/PDF visualization panel is a plugin for Grafana that displays Base64 encoded files in PNG, JPG, GIF, MP4, WEBM, MP3, OGG, PDF formats.
Requirements
- Grafana 8.5+, Grafana 9.0+ is required for version 3.X.
- Grafana 8.0+ is required for version 2.X.
- Grafana 7.1+ is required for version 1.X.
Getting Started
Base64 Image/Video/Audio/PDF visualization panel can be installed from the Grafana Catalog or utilizing the Grafana command line tool.
For the latter, use the following command.
grafana-cli plugins install volkovlabs-image-panel
Features
- The returned value can contain base64 with or without definition (
data:image/jpg;base64,ENCODED-CONTENT
ordata:application/pdf;base64,ENCODED-CONTENT
). - The file type is determined automatically based on the first Base64 symbol if definition is not provided.
- If the data source returns more than one field with type
string
, you can select the Field Name in the panel's display options. - If the data source returns multiple rows, the panel will display the image from the last row.
- Image height and width can be auto-adjusted to panel's size, kept original or customized base on the field's value or display's panel options.
- Allows adding URL with title to navigate to other dashboard when clicking on the image. URL supports dashboard variables.
- Support MP4, WEBM video files with definition (
data:video/mp4;base64,ENCODED-CONTENT
anddata:video/webm;base64,ENCODED-CONTENT
) - Support MP3, OGG audio files with definition (
data:audio/mp3;base64,ENCODED-CONTENT
anddata:audio/ogg;base64,ENCODED-CONTENT
)
Documentation
Section | Description |
---|---|
Data Sources | Demonstrates how to retrieve data from data sources. |
Supported formats | Explains what formats are supported and how to display media files. |
Variables | Explains how to use Dashboard and Global variables. |
Feedback
We love to hear from you. There are various ways to get in touch with us:
- Ask a question, request a new feature, and file a bug with GitHub issues.
- Sponsor our open-source plugins for Grafana with GitHub Sponsor.
- Star the repository to show your support.
License
- Apache License Version 2.0, see LICENSE.
Grafana Cloud Pro
- $25 / user / month and includes a free trial for new users
- Available with a Grafana Cloud Pro plan
- Access to 1 Enterprise plugin
- Fully managed service (not available to self-manage)
Grafana Cloud Advanced / Grafana Enterprise
- Available with a Grafana Cloud Advanced plan or Grafana Enterprise license
- Access to all Enterprise plugins
- Run fully managed or self-manage on your own infrastructure
Installing Base64 Image/Video/Audio/PDF on Grafana Cloud:
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
For more information, visit the docs on plugin installation.
Installing on a local Grafana:
For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.
1. Install the Panel
Use the grafana-cli tool to install Base64 Image/Video/Audio/PDF from the commandline:
grafana-cli plugins install
The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.
Alternatively, you can manually download the .zip file for your architecture below and unpack it into your grafana plugins directory.
Alternatively, you can manually download the .zip file and unpack it into your grafana plugins directory.
2. Add the Panel to a Dashboard
Installed panels are available immediately in the Dashboards section in your Grafana main menu, and can be added like any other core panel in Grafana.
To see a list of installed panels, click the Plugins item in the main menu. Both core panels and installed panels will appear.
Changelog
3.5.0 (2023-03-07)
Features / Enhancements
- Update CI and Release workflows (#64)
- Update to Grafana 9.4.3 (#65)
- Set NoPadding to use panel corner to corner (#66)
3.4.0 (2023-01-08) "New Year" edition
Features / Enhancements
- Update to Grafana 9.3.2 (#60)
- Add Documentation links (#61)
- Update README and documentation (#62)
3.3.0 (2022-10-30) "Halloween" edition
Features / Enhancements
- Support for sanitized variables in URL field (#53)
- Update CI to Node 16 and Synchronize with Release workflow (#55)
- Update to Grafana 9.2.2 (#56)
3.2.0 (2022-10-05)
Features / Enhancements
- Update to Grafana 9.1.4 (#47)
- Add Compatibility Check Workflow (#48)
- Add option to disable PDF Toolbar (#50)
- Update to Grafana 9.1.7 (#51)
3.1.0 (2022-08-13)
Features / Enhancements
- Update README and Provisioning dashboards (#43)
- Add YouTube video in README (#44)
- Rebuild based on 9.0.7 (#45)
- Update Grafana Marketplace image (#46)
3.0.0 (2022-06-16)
Breaking changes
- Requires Grafana 8.5+ and 9.0+
Features / Enhancements
- Rebuild based on 9.0.0-beta3 (#36)
- Update PDF loader to start in Docker (#38)
- Support short Video encoded using Base64 (#39)
- Support MP3, OGG Audio playback in Base64 (#40)
- Add Options for Video/Audio Controls and Auto Play (#41)
- Rebuild based on 9.0.0 (#42)
2.6.0 (2022-04-26)
Features / Enhancements
- Rebuild using 8.3.6 (#32)
- Rebuild using 8.4.0 and use PluginCheck v2 (#33)
- Rebuild using 8.4.3 (#34)
- Based on Grafana 8.5.0 (#35)
2.5.0 (2022-01-24)
Features / Enhancements
- Update README to add Grafana Marketplace (#29)
- Rebuild using 8.3.4 (#28)
2.4.0 (2021-12-16)
Features / Enhancements
- Upgrade to Grafana 8.2.5 (#22)
- Upgrade to Grafana 8.3.0 (#23)
- Update to Grafana 8.3.2 (#24)
- Update Components naming (#25)
- Supporting PDF documents more than 2Mb size (#26)
2.3.1 (2021-11-09)
Features / Enhancements
- Add
display:block
to display href properly [https://github.com/grafana/grafana/issues/41445] (#21)
2.3.0 (2021-11-08)
Features / Enhancements
- Navigate to another dashboard from image click (#19)
- Upgrade to Grafana 8.2.3 (#20)
2.2.0 (2021-11-02)
Features / Enhancements
- Upgrade to Grafana 8.1.5 (#16)
- Upgrade to Grafana 8.2.0 (#17)
- Upgrade to Grafana 8.2.2 (#18)
2.1.1 (2021-08-18)
Features / Enhancements
- Add Radio to select Image Size modes (#14)
2.1.0 (2021-08-12)
Features / Enhancements
- Update README (#10)
- Upgrade to Grafana 8.1.1 (#12)
- Add Options and Fields to resize an image (#13)
2.0.0 (2021-06-19)
Breaking changes
- Supports Grafana 8.0+, for Grafana 7.X use version 1.0.1 or 1.1.0
Features / Enhancements
- Based on Grafana 8.0.2 (#9)
1.1.0 (2021-06-19)
Features / Enhancements
- Display base64 image with header (#7)
- Display base64 Image from InfluxDB (#6)
- Increase tests coverage (#4)
1.0.1 (2021-06-07)
Features / Enhancements
- Add screenshots for Static and Redis data sources (#5)
1.0.0 (2021-06-07)
Features / Enhancements
- Initial release based on Grafana 7.5.7
- Supports PNG, JPG, GIF and PDF