UnifiedMetrics

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

Автор: cubxity6,3 тыс.129обновлён 23 апр. 2023 г.

ТехнологииУтилиты

Описание

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!

Features

Platform-agnostic & compatible with popular platforms. Get the same metrics and features on any supported platform.
Monitor your server in real-time with Prometheus/InfluxDB and provided Grafana dashboards.
High performance 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.

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.

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.

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

API

Instructions (click to show)

Examples

Example plugins can be found under examples directory.

Gradle (Kotlin)

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

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.

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

/* ... */

val api = UnifiedMetricsProvider.get()

Галерея

Последние версии

Все версии →

release

UnifiedMetrics 0.3.8 (Bungee)

0.3.8

23 апр. 2023 г.496Minecraft: 1.8, 1.8.1, 1.8.2, 1.8.3, 1.8.4, 1.8.5, 1.8.6, 1.8.7, 1.8.8, 1.8.9, 1.9, 1.9.1, 1.9.2, 1.9.3, 1.9.4, 1.10, 1.10.1, 1.10.2, 1.11, 1.11.1, 1.11.2, 1.12, 1.12.1, 1.12.2, 1.13, 1.13.1, 1.13.2, 1.14, 1.14.1, 1.14.2, 1.14.3, 1.14.4, 1.15, 1.15.1, 1.15.2, 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.17, 1.17.1, 1.18, 1.18.1, 1.18.2, 1.19, 1.19.1, 1.19.2, 1.19.3, 1.19.4bungeecord, waterfall

Скачать

Что нового

[Github Release](https://github.com/Cubxity/UnifiedMetrics/releases/tag/v0.3.8) ## Bug Fixes - **deps**: update all non-major dependencies (#75) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/373ae0a3f155bf62249fca292c7daf4bd6e94a3e)) - **deps**: update all non-major dependencies (#76) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/23f04eb9871d23601def8f155fb2994f6b587476)) - **deps**: update all non-major dependencies (#79) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/7332e3f0cf4209c1a60ae7307a1b4c13ccc0a543)) - **build**: dependency issues ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/6490e1f8e86ba23f2e1843d4448158407e8069bd)) - gitignore and .idea directory ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/30982fbe55ea4262331c0bbbb61424100daf8068)) - **velocity**: login counter metric ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/1907a3a7a445eedd91fc00d95278f58ff5b39604)) - **deps**: update all non-major dependencies (#82) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/2e90cedd41b48856cef59f5da1e5f9254126e63c)) - **deps**: update all non-major dependencies (#92) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/91d73c13a8af5c0418c47896a0e036213e1dc554)) - **build**: signArchives and shadowJar ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/99ac6abacc64ae737bf4a2f4e0cd259e86aff671)) - **build**: signArchives and shadowJar ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/73e75ccc1403855f8a6693af8ad3577b96407663)) - **build**: fabric compileJava ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/94eee88f9aa889c38869e8d6719840ba223f4904)) - **build**: java target version ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/e0645ba989878753176af4ec417c044129af91e1)) ## Builds - **minestom**: upgrade dependency ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/5c4ccc45c6e1869e1a4cd6512f003f44f8e8cec2)) ## Chores - improve renovate configuration ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/57ac230364be3f67176fa4bfadafde0d7373f980)) - bump version to 0.3.8-SNAPSHOT ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/a243dd358f192bb4ed7aa3a764058c96252bf4b5)) - **deps**: exclude fabric yarn from renovate ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/432585476783348492ea851c7250d6735a4e0584)) - **deps**: update all non-major dependencies (#81) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/c41de4693c367f288fee2aa75483598c3fe6fce0)) - **deps**: update all non-major dependencies (#89) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/cfdce554968b875a9126e1378cde53c852ccd911)) - **deps**: update dependency gradle to v8 (#88) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/be6fee38aecfa3e6aff23543a0de6291a6cea8c3)) - **deps**: update plugin com.github.johnrengelman.shadow to v8 (#91) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/8788f04641df1d902875259674592180c3f1dc64)) - **deps**: update all non-major dependencies (#93) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/f5314f8c576f835944c4080829ad63fa3a26ef33)) - **deps**: update minestom dependencies ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/ba9390adf82be0252d436e0395e2ee6ea44a186d)) - bump version to 0.3.8 ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/0cbbc0ed72c138fdd51eee60a81db9166d269d24))

release

UnifiedMetrics 0.3.8 (Velocity)

0.3.8

23 апр. 2023 г.916Minecraft: 1.8, 1.8.1, 1.8.2, 1.8.3, 1.8.4, 1.8.5, 1.8.6, 1.8.7, 1.8.8, 1.8.9, 1.9, 1.9.1, 1.9.2, 1.9.3, 1.9.4, 1.10, 1.10.1, 1.10.2, 1.11, 1.11.1, 1.11.2, 1.12, 1.12.1, 1.12.2, 1.13, 1.13.1, 1.13.2, 1.14, 1.14.1, 1.14.2, 1.14.3, 1.14.4, 1.15, 1.15.1, 1.15.2, 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.17, 1.17.1, 1.18, 1.18.1, 1.18.2, 1.19, 1.19.1, 1.19.2, 1.19.3, 1.19.4velocity

Скачать

Что нового

release

UnifiedMetrics 0.3.8 (Bukkit)

0.3.8

23 апр. 2023 г.2,6 тыс.Minecraft: 1.8, 1.8.1, 1.8.2, 1.8.3, 1.8.4, 1.8.5, 1.8.6, 1.8.7, 1.8.8, 1.8.9, 1.9, 1.9.1, 1.9.2, 1.9.3, 1.9.4, 1.10, 1.10.1, 1.10.2, 1.11, 1.11.1, 1.11.2, 1.12, 1.12.1, 1.12.2, 1.13, 1.13.1, 1.13.2, 1.14, 1.14.1, 1.14.2, 1.14.3, 1.14.4, 1.15, 1.15.1, 1.15.2, 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.17, 1.17.1, 1.18, 1.18.1, 1.18.2, 1.19, 1.19.1, 1.19.2, 1.19.3, 1.19.4bukkit, paper, purpur, spigot

Скачать

Что нового

release

UnifiedMetrics 0.3.8 (Fabric)

0.3.8

23 апр. 2023 г.703Minecraft: 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.17, 1.17.1, 1.18, 1.18.1, 1.18.2, 1.19, 1.19.1, 1.19.2, 1.19.3, 1.19.4fabric

Скачать

Что нового

release

UnifiedMetrics 0.3.7

0.3.7

25 сент. 2022 г.239Minecraft: 1.8, 1.8.1, 1.8.2, 1.8.3, 1.8.4, 1.8.5, 1.8.6, 1.8.7, 1.8.8, 1.8.9, 1.9, 1.9.1, 1.9.2, 1.9.3, 1.9.4, 1.10, 1.10.1, 1.10.2, 1.11, 1.11.1, 1.11.2, 1.12, 1.12.1, 1.12.2, 1.13, 1.13.1, 1.13.2, 1.14, 1.14.1, 1.14.2, 1.14.3, 1.14.4, 1.15, 1.15.1, 1.15.2, 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.17, 1.17.1, 1.18, 1.18.1, 1.18.2, 1.19, 1.19.1, 1.19.2velocity

Скачать

Что нового

[**GitHub release**](https://github.com/Cubxity/UnifiedMetrics/releases/tag/v0.3.7) ## Bug Fixes - apiProvider being initialized after saveConfig ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/229769b66c151691c7c689d27f7036e84cbf376c)) ## Chores - **build**: upgrade kotlin ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/4820e03d64d2851a0ff6751ed795ea9db4be2da7)) - **build**: upgrade dependencies ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/81a195d3dd7be43bc089bfd9a3c293da371aaf29)) - **deps**: add renovate.json (#61) [#61](https://github.com/Cubxity/UnifiedMetrics/pull/61) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/ef451c647b32a537aea3e41e541e73192256bff8)) - **deps**: group non-major renovate dependency upgrades ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/008171097193ad4c865ad9f3cafca86a6c3b41d8)) - **deps**: update actions/checkout action to v3 (#71) [#71](https://github.com/Cubxity/UnifiedMetrics/pull/71) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/53dcd0f08db215a0e61fb7103439019e9a3954ad)) - **deps**: update actions/setup-java action to v3 (#72) [#72](https://github.com/Cubxity/UnifiedMetrics/pull/72) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/3ce7becd33bff8c769b77ee34db80a9fe31e2c8d)) - **deps**: update plugin fabric-loom to v1 (#73) [#73](https://github.com/Cubxity/UnifiedMetrics/pull/73) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/e17b97113b093e63bf693a470783ef1a5af10735)) - **deps**: update all non-major dependencies (#74) [#74](https://github.com/Cubxity/UnifiedMetrics/pull/74) ([renovate[bot]](https://github.com/Cubxity/UnifiedMetrics/commit/f472d9786f9b76b6e487223ae9854d3f65e06cec)) - bump version to 0.3.7 ([Cubxity](https://github.com/Cubxity/UnifiedMetrics/commit/877660df8f3c9620338d09830b5f5da5836eff43)) ## Commits - 4f37c6a: [skip ci] docs: update readme (Cubxity) - 5ec26b0: [skip ci] docs: update readme (Cubxity) - 4beba9f: Merge branch 'dev/0.3.x' (Cubxity)

release

UnifiedMetrics 0.3.7

0.3.7

25 сент. 2022 г.140Minecraft: 1.8, 1.8.1, 1.8.2, 1.8.3, 1.8.4, 1.8.5, 1.8.6, 1.8.7, 1.8.8, 1.8.9, 1.9, 1.9.1, 1.9.2, 1.9.3, 1.9.4, 1.10, 1.10.1, 1.10.2, 1.11, 1.11.1, 1.11.2, 1.12, 1.12.1, 1.12.2, 1.13, 1.13.1, 1.13.2, 1.14, 1.14.1, 1.14.2, 1.14.3, 1.14.4, 1.15, 1.15.1, 1.15.2, 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.17, 1.17.1, 1.18, 1.18.1, 1.18.2, 1.19, 1.19.1, 1.19.2bungeecord, waterfall

Скачать

Что нового

release

UnifiedMetrics 0.3.7

0.3.7

25 сент. 2022 г.278Minecraft: 1.8, 1.8.1, 1.8.2, 1.8.3, 1.8.4, 1.8.5, 1.8.6, 1.8.7, 1.8.8, 1.8.9, 1.9, 1.9.1, 1.9.2, 1.9.3, 1.9.4, 1.10, 1.10.1, 1.10.2, 1.11, 1.11.1, 1.11.2, 1.12, 1.12.1, 1.12.2, 1.13, 1.13.1, 1.13.2, 1.14, 1.14.1, 1.14.2, 1.14.3, 1.14.4, 1.15, 1.15.1, 1.15.2, 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.17, 1.17.1, 1.18, 1.18.1, 1.18.2, 1.19, 1.19.1, 1.19.2bukkit, paper, purpur, spigot

Скачать

Что нового

release

UnifiedMetrics 0.3.7

0.3.7

25 сент. 2022 г.234Minecraft: 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.17, 1.17.1, 1.18, 1.18.1, 1.18.2, 1.19, 1.19.1, 1.19.2fabric

Скачать

Что нового

release

UnifiedMetrics 0.3.4

0.3.4

4 дек. 2021 г.277Minecraft: 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.17, 1.17.1, 1.18fabric

Скачать

Что нового

- fix(fabric): tps/mspt on 1.18-pre1

beta

UnifiedMetrics 0.3.4-SNAPSHOT

0.3.4-SNAPSHOT

4 дек. 2021 г.147Minecraft: 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.17.1, 1.18fabric

Скачать