UnifiedMetrics

Fully-featured metrics collection agent for Minecraft servers. Supports Prometheus and InfluxDB.

5,34k

Quick challenge

How far can you run before the mobs catch you?

UnifiedMetrics

UnifiedMetrics

LicenseLicense

IssuesIssues

Workflow StatusWorkflow Status

DiscordDiscord

UnifiedMetrics is a fully-featured free and open-source metrics collection plugin for Minecraft servers. This project is licensed under GNU LGPLv3.

Grafana DashboardGrafana Dashboard

*Dashboard included out-of-box!* Click here for live preview!

Features

- Free and open-source. Get the same metrics and features on any supported platform. - Free and open-source with Prometheus/InfluxDB and provided Grafana dashboards. - Free and open-source metric collection. Low to none performance impact on the server's performance. - Free and open-source. The code is free and open for anyone to audit and contribute to.

Compatibility

Server:

- 1.8+ Spigot servers *(includes Spigot-based forks)* - 1.16+ Fabric servers - Minestom - Velocity - BungeeCord

Metrics:

- Prometheus - InfluxDB

Getting started

Read the wiki for instructions on how to get started.

Metrics

Table of metrics (click to show)

| 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 |

Special Thanks

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.

Bloom logoBloom logo

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.

YourKit LogoYourKit Logo

Building from source

Instructions (click to show)

Requirements:

- JDK 8+ (16+ for Fabric, 17+ for Minestom) - Git (Optional)

To build UnifiedMetrics, you need to obtain the source code first. You can download the source from GitHub or use the Git CLI.

```bash $ 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.

```bash $ ./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:

```bash $ ./gradlew :unifiedmetrics-platform-bukkit:assemble -x signArchives ```

The output artifacts can be found in `subproject/build/libs`.

API

Instructions (click to show)

Examples

Example plugins can be found under examples directory.

Gradle (Kotlin)

```kotlin repositories { mavenCentral() maven("https://s01.oss.sonatype.org/content/repositories/snapshots/") } ```

```kotlin dependencies { // ... compileOnly("dev.cubxity.plugins", "unifiedmetrics-api", "0.3.3-SNAPSHOT") } ```

Usage

Add `:unifiedmetrics-api` as a dependency (compileOnly/provided). Prefer using platform's service manager if possible.

```kotlin import dev.cubxity.plugins.metrics.api.UnifiedMetricsProvider

/* ... */

val api = UnifiedMetricsProvider.get() ```

ADS