Fully-featured metrics collection agent for Minecraft servers. Supports Prometheus and InfluxDB. Dashboard included out-of-box.
UnifiedMetrics is a fully-featured free and open-source metrics collection plugin for Minecraft servers. This project is licensed under GNU LGPLv3.
Dashboard included out-of-box! Click here for live preview!
Server:
Metrics:
Read the wiki for instructions on how to get started.
Collector | Description | Platform | Default |
---|---|---|---|
systemGc | Garbage collection duration and freed bytes | All | true |
systemMemory | Memory used, committed, max and init | All | true |
systemProcess | CPU load, seconds, and process start time | All | true |
systemThread | Current, daemon, started, and peak thread count | All | true |
events | Login, join, quit, chat, and ping event counter | All | true |
server | Plugins count and player counts | All | true |
tick | Tick duration histogram | Bukkit, Minestom | true |
world | World entities, players, and chunks count | Bukkit, Minestom | true |
Bloom Host has kindly provided UnifiedMetrics with development servers. Bloom has server splitting built-in, which makes it extremely easy to build your monitoring stack. Get high performance servers at Bloom by using this link.
YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.
Requirements:
To build UnifiedMetrics, you need to obtain the source code first. You can download the source from GitHub or use the Git CLI.
$ git clone https://github.com/Cubxity/UnifiedMetrics && cd UnifiedMetrics
Open a terminal in the cloned directory and run the following command. The following command will build all subprojects.
$ ./gradlew assemble -x signArchives
-x signArchives
is required to skip signing, unless you have signing set up
To build a specific subproject, you can prefix it with the subproject path. For example:
$ ./gradlew :unifiedmetrics-platform-bukkit:assemble -x signArchives
The output artifacts can be found in subproject/build/libs
.
Example plugins can be found under examples directory.
repositories {
mavenCentral()
// Snapshots repository (only required for -SNAPSHOT versions)
maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
}
dependencies {
// Replace this with the desired version
compileOnly("dev.cubxity.plugins", "unifiedmetrics-api", "0.3.6")
}
Add :unifiedmetrics-api
as a dependency (compileOnly/provided). Prefer using platform's service manager if possible.
import dev.cubxity.plugins.metrics.api.UnifiedMetricsProvider
/* ... */
val api = UnifiedMetricsProvider.get()