rolandvonrotz / minecraft-prometheus-exporter

A Bukkit plugin which exports minecraft server stats to Prometheus

Minecraft Prometheus Exporter

A Bukkit plugin which exports Minecraft server stats for Prometheus.

Quick Start

Drop the the prometheus-exporter.jar into your Bukkit plugins directory and start your Minecraft server.

After startup, the Prometheus metrics endpoint should be available at localhost:9225/metrics (assuming localhost is the server hostname).

The metrics port can be customized in the plugin's config.yml (a default config will be created after the first use).

Prometheus config

Add the following job to the scrape_configs section of your Prometheus configuration:

- job_name: 'minecraft'
  static_configs:
    - targets: ['localhost:9225']

Import Grafana Dashboard

1. Navigate to Grafana -> Dashboards -> Import
2. Paste in or upload minecraft-server-dashboard.json
3. Update "JVM Memory Used" to reflect your server max memory (Default 8G)
4. Edit (bottom right widget) -> Options -> Gauage -> Max

Available metrics

These are the stats that are currently exported by the plugin.

Label	Description
mc_players_total	Online and offline players
mc_loaded_chunks_total	Chunks loaded per world
mc_players_online_total	Online players per world
mc_entities_total	Entities loaded per world
mc_living_entities_total	Living entities loaded per world
mc_jvm_memory	JVM memory usage
mc_tps	Server tickrate (TPS)

Player metrics (experimental!)

⚠️ The following feature is against Prometheus best-practices and is not recommended for production servers!

There is an option to export per-player statistics like the number of blocks mined, mobs killed, items used, etc. The amount of data stored in Prometheus can dramatically increase when this is enabled as individual time-series will be generated for each player that has ever been seen on the server. The statistic collection may also have an impact on the Minecraft server performance for bigger servers but it has not been measured or tested.

On the other hand this should be quite safe for small private servers with limited players.

You can enable the experimental player export in the config.yaml.

individual-player-statistics: true

This will enable the additional metrics.

Label	Description
mc_player_statistic	Player statistics
mc_player_online	Online state by player name

There's a sample dashboard available to get you started.