Urpagin/MCWatcher
1
0
Fork 0
mirror of https://github.com/Urpagin/MCWatcher.git synced 2025-11-21 19:56:34 +01:00
Code Issues Projects Packages Wiki Activity
A Rust-based tool that periodically probes Minecraft servers, logging detailed data for performance monitoring, analytics, and visualization.
11 commits 1 branch 0 tags 108 KiB
Find a file
Exact
Urpagin 5b92a22ab0
 Update README.md
2025-08-23 09:50:10 +02:00
data_visualisation Add gantt visualisation template 2025-07-22 17:54:55 +02:00
src Add dockerisation. Update docs 2025-07-24 20:58:53 +02:00
.env.example Add dockerisation. Update docs 2025-07-24 20:58:53 +02:00
.gitignore Add dockerisation. Update docs 2025-07-24 20:58:53 +02:00
Cargo.lock initial code 2025-07-10 20:25:46 +02:00
Cargo.toml initial code 2025-07-10 20:25:46 +02:00
docker-compose.yml Add dockerisation. Update docs 2025-07-24 20:58:53 +02:00
Dockerfile Add dockerisation. Update docs 2025-07-24 20:58:53 +02:00
LICENSE Initial commit 2025-07-10 01:34:22 +02:00
README.md Update README.md 2025-08-23 09:50:10 +02:00

README.md

MCWatcher

Probes a Minecraft server at regular intervals to collect comprehensive data for later analysis and visualization.

Quickstart ⚡

  1. Set the MC_ADDR environment variable in a .env file at the root of the project as follows:

Tip

Copy-paste the .env.example file into a .env file and modify its contents.

MC_ADDR=mc.hypixel.net
  1. Compile and run the program with:
cargo run

Let the program probe the server. Once sufficient data has been collected, stop the program and analyze the generated data.csv file.

Docker Compose 🐳

  1. Populate the .env file just as described in the Quickstart heading.

  2. Launch the program:

docker compose up -d
  1. All done. A ./data directory will be created with data.csv inside. To follow the container logs:
docker compose logs -f

Data format 📊

The data.csv file is appended every 30 seconds and structured as follows:

MC Address Timestamp Probed Latency Version Max Players Online Players Sample Players

The Sample Players column lists entries as name@uuid separated by ! with no trailing delimiter, like this:

<player_name>@<player_uuid>!<player_name>@<player_uuid>!<player_name>@<player_uuid>

Example:

Technoblade@b876ec32-e396-476b-a115-8438d83c67d4!popbob@0f75a81d-70e5-43c5-b892-f33c524284f2!Notch@069a79f4-44e9-4726-a5be-fca90e38aaf5

TODO / Ideas 🧠

  • Support for probing multiple servers.
  • API endpoint for dynamically adding servers.
  • Simple frontend for managing servers, downloading data, and generating graphs.
  • Use Parquet or an SQL database for data storage.
  • Configurable probe interval via .env file.