Repository navigation
Installation
The dashboard needs three things around it:
- Grafana 13 or newer. The dashboard is a v2 dashboard, which hides the rows a server or a singleplayer world doesn't need.
- Prometheus scraping minecraft-exporter, which reads a Paper server through WorldAPI.
- The Infinity plugin for Grafana, only for the chat, event, and console tables. Data sources sets it up.
Pick one of three ways in. Each brings the same dashboard, with the uid minecraft-worldapi and the title “Minecraft server (minecraft-exporter)”.
- In Grafana, open Dashboards → New → Import.
- Enter
25941and press Load. - Pick a folder and press Import.
- At the top of the dashboard, pick your Prometheus in the “Prometheus” variable.
grafana.com gets each release a little after GitHub, since its revisions go up by hand. For the newest one, import the release file.
- Download
minecraft.json. This link always reaches the newest release. - In Grafana, open Dashboards → New → Import and upload the file.
- Pick a folder and press Import, then pick your Prometheus at the top.
Dashboard settings show the release in the description, like “(v1.1.0)”.
Grafana can load the dashboard from disk on start and reload it when the file changes. The dashboard picks its data sources through variables, so the file needs no editing.
-
Put
minecraft.jsonin a folder Grafana can read, like/var/lib/grafana/dashboards/. -
Point a dashboard provider at that folder, in
provisioning/dashboards/minecraft.yml:apiVersion: 1 providers: - name: minecraft type: file options: path: /var/lib/grafana/dashboards
-
Restart Grafana. The dashboard opens at
/d/minecraft-worldapi.
To update it, download the newest minecraft.json over the old one. Don't edit a provisioned copy in Grafana: the next file change replaces it.
minecraft-exporter's examples/ folder holds a whole stack in Docker Compose: Prometheus, Grafana with both data sources, and this dashboard, provisioned.
Next: Data sources
Server owners
Developers