SunRed/minecraft-exporter
1
0
Fork 0
Code Issues Pull requests Releases Activity
A Prometheus Minecraft exporter
28 commits 2 branches 0 tags 57 KiB
Python 99.1%
Dockerfile 0.9%
Find a file
Joshi425 54422f0259 fix 1.15 Support
2020-05-09 20:11:44 +02:00
dashboard update readme and dashboards for quests 2020-01-11 17:25:36 +00:00
docker-compose.yaml fix 1.15 issues 2020-03-07 19:15:47 +08:00
Dockerfile fix 1.15 issues 2020-03-07 19:15:47 +08:00
minecraft_exporter.py fix 1.15 Support 2020-05-09 20:11:44 +02:00
README.md add proper Minecraft 1.15 Support 2020-05-09 20:07:07 +02:00
requirements.txt use latest playername, flush playernamecache everyday at 1:00, rcon connection recycling, fix crash on disabled dynmap metrics, performance improvements 2020-04-20 11:53:15 +02:00

README.md

minecraft-exporter

this is a prometheus minecraft exporter This exporter reads minecrafts nbt files, the advancements files and can optionally connect via RCON to your minecraft server.

to use it mount your world to /world in the container

rcon connection only works on forge servers, it only executes forge tps to get tps and tick time informations

to enable rcon on your minecraft server add the following to the server.properties file:

broadcast-rcon-to-ops=false
rcon.port=25575
rcon.password=Password
enable-rcon=true

The RCON Module is only enabled if RCON_HOST and RCON_PASSWORD is set

Usage

docker run -e RCON_HOST=127.0.0.1 \
	   -e RCON_PORT=25575 \
	   -e RCON_PASSWORD="Password" \
	   -e DYNMAP_ENABLED="True" \
	   -p 8000:8000 \
	   -v /opt/all_the_mods_3/world:/world \
	   joshi425/minecraft_exporter

Metrics

blocks_mined
blocks_picked_up
player_deaths
player_jumps
cm_traveled
player_xp_total
player_current_level
player_food_level
player_health
player_score
entities_killed
damage_taken
damage_dealt
blocks_crafted
player_playtime
player_advancements
player_slept
player_used_crafting_table
player_quests_finished # support for betterquesting
mc_custom # for 1.15

the following Metrics are only exported if RCON is configured:

dim_tps
dim_ticktime
overall_tps
overall_ticktime
player_online

the following Metrics are exposed if Dynmap Support is enabled:

dynmap_tile_render_statistics
dynmap_chunk_loading_statistics_count
dynmap_chunk_loading_statistics_duration

Dashboards

In the folder dashboards you'll find grafana dashboards for these metrics, they are however incomplete and can be expanded or use the following dasboards:

https://grafana.com/grafana/dashboards/11993
https://grafana.com/grafana/dashboards/11994