Prometheus metrics for Minecraft servers and proxies — Paper, Purpur, Folia, Spigot, Sponge, Velocity, BungeeCord and Geyser.
VaniaMetrics is a small core plugin that serves /metrics over HTTP, plus one optional plugin per integration. Install the core, add only the collectors for the plugins you run, and point Prometheus at the server.
The documentation lives on vania-metrics.github.io: how to get started and configure it, which platforms each collector supports, and every metric with its labels.
- No runtime dependencies. The core runs on the JDK alone: nothing shaded, nothing relocated.
- One jar per integration. Each collector declares
depend: [VaniaMetrics], so a missing target plugin disables that collector cleanly instead of breaking the core. - Bounded cardinality. Per-player series have a hard cap, and rare values are folded away rather than exploding your TSDB.
- Tested on real servers. Java 21, Minecraft 1.21.11: every platform a repository claims is started in a container and checked by its CI, and the site shows the latest result.
Every release is built and published by CI, with its jars and their SHA512SUMS.
- The core: latest release. One jar per platform:
vania-metrics-bukkitcovers Paper, Purpur, Folia, Spigot and CraftBukkit; the others are for Sponge, Velocity, BungeeCord (and Waterfall) and Geyser. - A collector: its latest release, in the table below. It goes next to the core and to the plugin it measures.
The core measures the JVM, the container (CPU, memory, disk), ticks, worlds, players and proxies. Each collector adds the metrics of one plugin, from its own repository, collector-<name>.
| Plugin | What the collector measures | Download | |
|---|---|---|---|
| BetonQuest | Conversations, journal entries, points and tags | Latest release | |
| Chunky | Pre-generation tasks | Latest release | |
| EssentialsX | Economy balances, accounts and Gini coefficient; AFK players | Latest release | |
| ExcellentEconomy | Balances, transactions and money flow | Latest release | |
| GrimAC | Flags, setbacks and violation levels | Latest release | |
| LuckPerms | Groups, tracks, users, and online players by group | Latest release | |
| Multiverse-Core | Worlds | Latest release | |
| Multiverse-Inventories | Group switches | Latest release | |
| Multiverse-Portals | Portal use | Latest release | |
| MythicMobs | Spawns, deaths and despawns | Latest release | |
| Nova | Tile entities | Latest release | |
| PacketEvents | Packets, and players by protocol version | Latest release | |
| PhoenixCrates | Openings, keys, rewards and drop odds | Latest release | |
| PlaceholderAPI | Any placeholder value, as a gauge | Latest release | |
| spark | TPS, tick duration, CPU, GC, allocation rate and ping | Latest release | |
| WorldGuard | Regions and denied PvP | Latest release |
Depend on fr.samflix:vania-metrics-api, implement Collector, register it on enable. The core README covers the API, and any collector-* repository is a working template.
Metric names follow mc_<domain>_<subject>, base units (seconds, bytes), and Prometheus naming conventions.
Issues and pull requests are welcome: see CONTRIBUTING. main only takes reviewed pull requests, squash-merged, whose title starts with a type (feat:, fix:, docs:…): releases are computed from it. Report a vulnerability privately, as SECURITY explains.
Core 0.6.0, for Minecraft 1.21.11; each collector has its own version and releases. Pre-1.0: the API may still change between minor versions. Everything is open source, under the GPL-3.0.