Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 2.02 KB

README.md

File metadata and controls

46 lines (32 loc) · 2.02 KB
Raw

MinePM Build Status

Application Performance Management (APM) for Minecraft servers.

The most server operators who have worked for a server with ~50 or more concurrent players know the pain of performance issues. They are hard to reproduce and harder to fix. This software tries to address this issue. It continually saves performance metrics and helps to isolate errors to its root cause.

It uses ZeroMQ for distributing data. You can use it for transporting it to a Logstash server which inserts it into ElasticSearch. From there you can use Kibana to visualize/analyze collected data. For an example configuration file see: docs/logstash/config.conf.

Features

  • Collecting different metrics
    • Current ticks per second (TPS)
    • Player count/max players
    • Long-running event executors
    • Chunk load time

Example

Kibana example #001

This screenshot shows ~15 minutes gameplay. You can import this dashboard from the json file.

Usage

To use this software you need to run Java 8.

  1. Download the latest binary or build the project by yourself
  2. Extract the minepm directory inside the archive into your Minecraft server root directory
  3. Configure minepm/config.properties
  4. Ensure, ElasticSearch is running and create necessary mappings (see here)
  5. Ensure, logstash is running (you can use this configuration file)
  6. Start Minecraft Vanilla/Bukkit/Spigot: java -javaagent:minepm/minepm.jar -jar <your-server-jar>

Make sure that you include -javaagent:minepm/minepm.jar in command line arguments.

ToDo

  • Additional dashboards
  • Documentation