Skip to content

Grafana panel to integrate with any kind of HTTP/REST API

License

Notifications You must be signed in to change notification settings

cloudspout/cloudspout-button-panel

Repository files navigation

Button Panel

Node.js CI GitHub release)

All Contributors

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 via syntax-highlighiting editor
  • Support for custom header parameter or query parameter
  • Variable support via $variableName in
    • URL
    • Header/Query parameter name & value
    • POST body payload
    • 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

Contributors ✨

Thanks goes to these wonderful people (emoji key):


raúl

🤔 💻

Jorge Villada

🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT

Icons made by Pixel perfect from www.flaticon.com.

ButtonPayloadEditor highly influenced from gapitio/gapit-htmlgraphics-panel.