https://github.com/maxikg/minepm

Application Performance Management (APM) for Minecraft servers.
https://github.com/maxikg/minepm

apm elasticsearch kibana logstash metrics minecraft minecraft-server

Last synced: about 2 months ago
JSON representation

Application Performance Management (APM) for Minecraft servers.

• Host: GitHub
• URL: https://github.com/maxikg/minepm
• Owner: maxikg
• Created: 2015-11-23T16:07:21.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-22T14:04:01.000Z (about 9 years ago)
• Last Synced: 2023-04-03T19:01:11.674Z (over 1 year ago)
• Topics: apm, elasticsearch, kibana, logstash, metrics, minecraft, minecraft-server
• Language: Java
• Homepage:
• Size: 124 KB
• Stars: 8
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# MinePM [![Build Status](https://travis-ci.org/maxikg/MinePM.svg)](https://travis-ci.org/maxikg/MinePM)

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](http://zeromq.org/) for distributing data. You can use it for transporting it to a

[Logstash](https://www.elastic.co/products/elasticsearch) server which inserts it into

[ElasticSearch](https://www.elastic.co/products/elasticsearch). From there you can use

[Kibana](https://www.elastic.co/products/kibana) to visualize/analyze collected data. For an example configuration

file see: [docs/logstash/config.conf](/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](/docs/img/example_001.png "Kibana example #001")

This screenshot shows ~15 minutes gameplay. You can [import](/docs/kibana/README.md) this dashboard from the

[json file](/docs/kibana/dashboards/example_001.json).

## 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](/docs/elasticsearch/mappings/README.md))

 5. Ensure, logstash is running (you can use [this configuration file](/docs/logstash/config.conf))

 6. Start Minecraft Vanilla/Bukkit/Spigot: `java -javaagent:minepm/minepm.jar -jar `

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

## ToDo

 * Additional dashboards

 * Documentation