https://github.com/kernelci/grafana-singlevalue-panel
A simple Grafana plugin similar to singlestat, but the displayed value is a link.
https://github.com/kernelci/grafana-singlevalue-panel
Last synced: about 1 month ago
JSON representation
A simple Grafana plugin similar to singlestat, but the displayed value is a link.
- Host: GitHub
- URL: https://github.com/kernelci/grafana-singlevalue-panel
- Owner: kernelci
- License: gpl-3.0
- Created: 2023-02-13T10:58:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-13T11:03:44.000Z (over 3 years ago)
- Last Synced: 2025-07-20T16:42:16.078Z (11 months ago)
- Language: JavaScript
- Size: 106 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Singlevalue Grafana plugin
This plugin is similar to the `singlestat` plugin, with two
differences:
* The value shown is a link, not just plain text.
* Otherwise, this plugin has fewer features and is simpler than `singlestat`.
## Maintainers
Esteban Manchado Velázquez (primary) and Nikolai
Kondrashov (secondary).
## Design principles
This plugin should be familiar to Grafana users (eg. it looks similar
to Singlestat and supports a small subset of the `${__cell*}` syntax
in Table), but should be as simple as possible. Most of the code is in
the `SingleValueCtrl` class in `src/singlevalue_ctrl.js`.
## Development
To develop this plugin you need a Grafana installation. It's easy to
get one with Docker. To make it easier to develop it is better if you
use a Docker volume. You can do so by running the following commands:
```
docker volume create grafana-storage
docker run -d -p 127.0.0.1:3001:3000 -e GF_INSTALL_PLUGINS="" -v grafana-storage:/var/lib/grafana --name grafana grafana/grafana:6.6.0
```
Other plugins you might need to install are data sources,
eg. `doitintl-bigquery-datasource`. The Docker volume files will be
under `/var/lib/docker/volumes/grafana-storage`, so you can install
the plugin code there and start developing.
### How to test
Create a new dashboard and then a new panel. The panel should be a
visualization, and the type should be "Singlevalue panel". Then input
your query and set appropriate values for the "Text template" and "URL
template" fields. Usually these will be static values, or the special
macro `${__cell_XXX}`, where `XXX` is the 0-based column index (only
the first result of the query will be considered).
Short testing checklist:
* Go through every configuration value, changing it and checking that
the changes produce the desired results.
* Check that leaving the URL empty will remove the link and leave the
text.
### Making a release
To make a new release, update the `version` field in `plugin.json`,
tag the release, then upload a ZIP with the new release to GitLab.
To make a release ZIP file, type `grunt zip`. That will leave a file
called `grafana-singlevalue-panel-VERSION.zip` in the current
directory.