Repository navigation
Releases
minecraft-exporter 3.1.1
- Dependencies. go.yaml.in/yaml/v3 3.0.6 and prometheus/common 0.73.1.
Docker: docker pull ghcr.io/mairwunnx/minecraft-exporter:3.1.1
minecraft-exporter 3.1.0
WorldAPI 4.2.0 runs on Fabric and NeoForge, and in singleplayer worlds. The exporter tells them apart; no metric changes its name.
- 🧭 Where it runs.
minecraft_infogainsplatform(paper,fabric, orneoforge) andside(dedicated, orintegratedfor a singleplayer world). An older WorldAPI reads aspaperanddedicated. - 🧩 Plugins or mods.
minecraft_plugin_enabledgainskind:pluginon Paper,modon Fabric and NeoForge. - ⏸️
minecraft_pausedis 1 while a singleplayer game sits paused and nothing ticks. - 🎮 A preset for singleplayer.
examples/singleplayer/compose.yamlruns Prometheus and Grafana with the dashboard for the world you play, with the exporter beside the game, since a singleplayer world listens on this computer only.
Docker: docker pull ghcr.io/mairwunnx/minecraft-exporter:3.1.0
minecraft-exporter 3.0.0
- 💥 Breaking:
minecraft_world_days_totalis nowminecraft_world_days, a gauge. The day count is no counter:/time setcan move it back, andrate()orincrease()over it made no sense. Change your queries and alerts to the new name; minecraft-grafana 1.4.0 already uses it.
Docker: docker pull ghcr.io/mairwunnx/minecraft-exporter:3.0.0
minecraft-exporter 2.0.1
Checked against WorldAPI 4.0.0: every endpoint the exporter reads still answers the same, and it never used the bridge that 4.0 removed.
- Old numbers no longer linger. Plugins, statistics, the player list, and what crowds each world keep their last answer for five
EXPORTER_STATS_INTERVALs or 10 minutes, whichever is longer, while WorldAPI can't give a new one; then their metrics drop. A world that unloads takes its metrics away at the next scrape. minecraft_exporter_request_errors_totalsays in its help that a refusal doesn't count, as it hasn't since 1.1.0.- The start-up log hides a password in
WORLDAPI_URL. - CI checks for known vulnerabilities with
govulncheck. Go 1.27.3, newer Prometheus modules.
Docker: docker pull ghcr.io/mairwunnx/minecraft-exporter:2.0.1
minecraft-exporter 2.0.0
- Mo’Bosses is gone.
minecraft_mobosses_alive,minecraft_mobosses_spawned_total, andminecraft_mobosses_killed_totalno longer exist, and the exporter no longer reads/extensions/mobosses/stats. A plugin's events still count inminecraft_events_total, like any other plugin's. examples/mock/fakes a day of a busy server, with no Minecraft and no exporter, for the dashboard's screenshots.
Docker: docker pull ghcr.io/mairwunnx/minecraft-exporter:2.0.0
minecraft-exporter 1.1.0
- 🔐 More with a token. Each WorldAPI permission opens its own metrics: the host's load, memory, disk, and open files (
system:read); console lines by level, and warnings and errors by who logged them (logs:read); plugins and their versions, and what crowds each world: items on the ground, villagers, pets, named mobs, the five busiest chunks with their hoppers (server:read); where each online player stands (players:private); chat messages per player (chat:read); bans, operators, and the whitelist (players:moderate). - Mo’Bosses: bosses alive, and spawned and killed by type and class, when the plugin shares its data through WorldAPI.
- A missing permission is no longer an error. The exporter leaves an endpoint its token can't read for 10 minutes, and
minecraft_exporter_endpoint_allowedshows which ones are open;minecraft_exporter_request_errors_totalcounts real failures only. - With a token, statistics refresh 12 at a time instead of 6.
- The README warns to keep the metrics of a token private and shows a read-only token for WorldAPI's config.
Docker: docker pull ghcr.io/mairwunnx/minecraft-exporter:1.1.0
minecraft-exporter 1.0.0
The first release: Prometheus metrics of a Paper server through WorldAPI 3.0 or newer.
- Performance: TPS over three windows, tick times by percentile, CPU, and the JVM: heap and pools, garbage collection, threads, classes, buffers.
- Worlds: loaded chunks, entities and their most common types, block entities, players, the day count, time of day, weather, and the border.
- Players: who's online with ping, health, food, level, and idle time, and lifetime statistics from the game for everyone who has played: play time, deaths, kills, damage, blocks mined, items crafted, distance, jumps, fish, breeding, taming, trades, enchanting, diamonds, ancient debris, experience, advancements, first join, and last seen.
EXPORTER_PLAYERS=falseadds every player up instead. - Activity: counters of the events WorldAPI records, other plugins' included, deaths by cause and killer, advancements by frame, and first-time players.
- Many servers:
/probe?target=<name>reads the servers listed inEXPORTER_TARGETS. - Statistics refresh a few at a time, so the exporter stays within WorldAPI's limit for anonymous clients.
- A Docker image for amd64 and arm64 at
ghcr.io/mairwunnx/minecraft-exporter, and binaries for Linux, macOS, and Windows.
Docker: docker pull ghcr.io/mairwunnx/minecraft-exporter:1.0.0