Prometheus Exporter

Description

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. This currently has builds for the following versions:

• Minecraft 1.21.8 with Fabric 0.130.0.
• Minecraft 1.21.8 with Forge 58.0.0.
• Minecraft 1.21.6 with Fabric 0.128.0.
• Minecraft 1.21.6 with Forge 56.0.0.
• Minecraft 1.21.5 with Fabric 0.119.0.
• Minecraft 1.21.4 with Fabric 0.115.0.
• Minecraft 1.21.4 with Forge 54.0.0.
• Minecraft 1.21.4 with NeoForge 21.4.0.
• Minecraft 1.21.1 with Fabric 0.103.0.
• Minecraft 1.21.1 with Forge 52.0.0.
• Minecraft 1.21.1 with NeoForge 21.1.0.
• Minecraft 1.21.0 with Fabric 0.102.0.
• Minecraft 1.21.0 with Forge 51.0.0.
• Minecraft 1.20.6 with Fabric 0.100.0.
• Minecraft 1.20.6 with Forge 50.1.0.
• Minecraft 1.20.6 with NeoForge 20.6.0.
• Minecraft 1.20.4 with Fabric 0.97.0
• Minecraft 1.20.4 with Forge 49.1.0.
• Minecraft 1.20.4 with NeoForge 20.4.0.
• Minecraft 1.20.2 with Forge 48.1.0.
• Minecraft 1.20.1 with Fabric 0.92.0.
• Minecraft 1.20.1 with Forge 47.0.0.
• Minecraft 1.19.4 with Fabric 0.87.0.
• Minecraft 1.19.3 with Forge 44.1.0.
• Minecraft 1.19.2 with Forge 43.0.0.
• Minecraft 1.18.2 with Forge 40.0.0.
• Minecraft 1.18.2 with Fabric 0.77.0.
• Minecraft 1.18.1 with Forge 39.0.0.
• Minecraft 1.16.5 with Fabric 0.42.0.
• Minecraft 1.16.5 with Forge 36.0.0.
• Minecraft 1.15.2 with Forge 21.2.0.
• Minecraft 1.14.4 with Forge 28.1.0.
• Minecraft 1.12.2 with Forge 14.23.0.
• Minecraft 1.7.10 with Forge 10.13.4.

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, or 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.

What means Verified?

• Compatibility: The mod should be compatible with the latest version of Minecraft and be clearly labeled with its supported versions.
• Functionality: The mod should work as advertised and not cause any game-breaking bugs or crashes.
• Security: The mod should not contain any malicious code or attempts to steal personal information.
• Performance: The mod should not cause a significant decrease in the game's performance, such as by causing lag or reducing frame rates.
• Originality: The mod should be original and not a copy of someone else's work.
• Up-to-date: The mod should be regularly updated to fix bugs, improve performance, and maintain compatibility with the latest version of Minecraft.
• Support: The mod should have an active developer who provides support and troubleshooting assistance to users.
• License: The mod should be released under a clear and open source license that allows others to use, modify, and redistribute the code.
• Documentation: The mod should come with clear and detailed documentation on how to install and use it.

How to Install