Part 1: Create a Grafana API Token
Before proceeding, you need to generate a token from your Grafana instance so the plugin can fetch your metric data safely.
- Log into your Grafana instance.
- On the left-hand sidebar, navigate to Administration → Users and access → Service accounts.
(Note: Depending on your Grafana version, this may also be under Configurations > API Keys). - Click Add service account.
- Give it a name like
Stream Deck Plugin. - Set the Role to Viewer. (Do not give it Admin or Editor privileges).
- Click Create.
- Inside the newly created service account, click Add token.
- Copy the generated token immediately and store it securely. You will not be able to see it again!
Part 2: Stream Deck Configuration
Now, let's wire it up to your Stream Deck. Return to the property inspector panel and follow the instructions for your preferred setup method below:
Step 1: Server Authentication
- API Host: Enter your base Grafana API URL. This typically ends in
/api(e.g.,https://your-domain.com/api). - API Token: Paste the read-only service account token you copied in Part 1.
Step 2: Choose Your Configuration Mode
Method A: Auto Configuration (Recommended)
This pulls your existing layout settings directly from Grafana.
- Set the Configuration Mode toggle to
Auto. - Click the Dashboard dropdown. The plugin will fetch a list of your accessible Grafana dashboards. Select the one you want.
- Click the Panel dropdown and select the specific Stat or Gauge panel you want to display on the key.
Method B: Manual Configuration
Use this if you want to override a current dashboard setup, or build a custom key display from scratch.
- Set the Configuration Mode toggle to
Manual. - Title: Give your key a custom display name.
- Key Press Opens URL: Paste a URL to send your browser directly to a dashboard when clicked.
- Data Source: Type the name (e.g.,
Prometheus). - Query: Input your query expression (PromQL, etc.)
- Adjust Unit, Time Range, and Thresholds to customize display.
Next Steps
Your Stream Deck should now be displaying your Grafana metrics! Here are some helpful resources: