github.com/cpburnz/minecraft-prometheus-exporter @1.21.11-forge-1.4.0

This mod provides a Prometheus exporter for Minecraft. It exports metrics related to the Minecraft server and the JVM for consumption by the open-source systems monitoring toolkit, Prometheus. The mod is intended for server-side use, and does not need to be installed client-side. You can find the latest builds for various versions of Minecraft and mod loaders in Releases.

Is there a newer version of Minecraft not listed? Is the mod outdated for one of the listed Minecraft versions? Let me know by opening an issue on GitHub.

Installation

The Prometheus Exporter mod only needs to be installed on the server. It can be downloaded from GitHub and Curse Forge. To install it, copy the JAR (Prometheus-Exporter-{MC Version}-{Mod Loader}-{Mod Version}.jar) to the server mods/ directory. Since this mod does not add anything to the Minecraft world, it can be safely upgraded by simply replacing an older version with a newer version.

Configuration

The mod configuration is located at world/serverconfig/prometheus_exporter-server.toml with Forge and Fabric, and config/prometheus_exporter-server.toml with NeoForge. It will be automatically generated upon server start if it does not already exist. The default configuration can be seen in the example prometheus_exporter-server.toml.

Exporter

The metrics are documented in metrics.md.

A sample output from the exporter can be seen in the example output.txt.

Dashboards

Known compatible Grafana dashboards are listed in dashboards.md.