minecraft-exporter/README.md

84 lines
1.8 KiB
Markdown
Raw Normal View History

2019-10-26 16:00:27 +02:00
# minecraft-exporter
2019-10-26 16:20:05 +02:00
2019-10-26 16:00:27 +02:00
this is a prometheus minecraft exporter
2019-10-26 16:20:05 +02:00
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 is used to get online Players
On Forge Servers enable FORGE_SERVER to get tps information
2019-10-26 16:20:05 +02:00
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 FORGE_SERVER="True" \
2020-03-27 21:56:05 +01:00
-e DYNMAP_ENABLED="True" \
2019-10-26 16:20:05 +02:00
-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
2020-05-09 20:07:07 +02:00
mc_custom # for 1.15
2019-10-26 16:20:05 +02:00
```
the following Metrics are only exported if RCON is configured:
```
dim_tps
dim_ticktime
overall_tps
overall_ticktime
2019-10-30 18:37:33 +01:00
player_online
2019-10-26 16:20:05 +02:00
```
2020-03-27 21:56:05 +01:00
the following Metrics are exposed if Dynmap Support is enabled:
```
dynmap_tile_render_statistics
dynmap_chunk_loading_statistics_count
dynmap_chunk_loading_statistics_duration
```
2019-10-26 16:20:05 +02:00
# Dashboards
In the folder dashboards you'll find grafana dashboards for these metrics, they are however incomplete and can be expanded
2019-10-26 17:13:00 +02:00
or use the following dasboards:
2020-03-27 22:41:43 +01:00
https://grafana.com/grafana/dashboards/11993
2020-03-27 22:41:10 +01:00
https://grafana.com/grafana/dashboards/11994