Plugins 〉Button Panel


Developer

CloudSpout LLC

Sign up to receive occasional product news and updates:


Grafana Cloud
Grafana Cloud
  • Grafana, of course
  • 10k series Prometheus metrics
  • 50 GB logs
  • 50 GB traces
  • 2,232 app o11y host hours
  • ...and more
Create free account

No credit card needed, ever.


This plugin has been deprecated as it is no longer maintained. Consider use of Canvas or this alternative button panel.
Panel
community

Button Panel

  • Overview
  • Installation
  • Related content

Button Panel

Node.js CI GitHub release)

It provides a simple Grafana 7.x panel that shows only one button - to integrate with any kind of HTTP/REST API:

  • Support GET and POST HTTP verb
    • Adds no new javascript dependencies
    • Uses standard browser APIs and respects CORS
    • Optional text payload for POST requests
  • Support for custom header parameter or query parameter
  • Variable support via $variableName in
    • URL
    • parameter name & value
    • Button label
  • Support for HTTP Basic Auth
  • Custom label text & Grafana template design
    • Customize icon & button colors

Usage

Screencast

Configuration

Screenshot

Basic Auth

⚠️ Please note: ⚠️

Due to the Grafana API & security restrictions in modern browsers the following must be considered before using Basic Auth:

Basic Auth Configuration

  • Neither username nor password are stored encryted in Grafana. The password is there to everyone with access to the dashboard in Grafana!
  • The server at the URL must provide proper resposne to the CORS pre-flight request. That is:

These limitations are inherent and canot be fixed or addressed by the plugin!

Use Basic Auth only if these limitations are acceptable!

Install

CLI

Via the Grafana CLI:

$ grafana-cli --pluginUrl https://github.com/cloudspout/cloudspout-button-panel/releases/download/7.0.23/cloudspout-button-panel.zip \
  plugins install cloudspout-button-panel

Docker

Use Grafana's environment variable to add this plugin to your installation:

$ docker run -p 3000:3000 -it \
  -e "GF_INSTALL_PLUGINS=https://github.com/cloudspout/cloudspout-button-panel/releases/download/7.0.23/cloudspout-button-panel.zip;cloudspout-button-panel" \
  grafana/grafana:7.3.1

License

GPL v3

Icons made by Pixel perfect from www.flaticon.com

Installing Button Panel on Grafana Cloud:

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 Button Panel 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.

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.