
UnifiedMetrics
Fully-featured metrics collection agent for Minecraft servers. Supports Prometheus and InfluxDB.
- Загрузки
- 6K
- Подписчики
- 137
- Обновлён
- 23 апреля 2023 г.
- Лицензия
- LGPL-3.0-only
Опубликован 5 октября 2021 г.

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 signArchivesis 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()
Ченджлог
0.3.8Релиз1.19.2, 1.19.3, 1.19.4 · 23 апреля 2023 г.
Bug Fixes
- deps: update all non-major dependencies (#75) (renovate[bot])
- deps: update all non-major dependencies (#76) (renovate[bot])
- deps: update all non-major dependencies (#79) (renovate[bot])
- build: dependency issues (Cubxity)
- gitignore and .idea directory (Cubxity)
- velocity: login counter metric (Cubxity)
- deps: update all non-major dependencies (#82) (renovate[bot])
- deps: update all non-major dependencies (#92) (renovate[bot])
- build: signArchives and shadowJar (Cubxity)
- build: signArchives and shadowJar (Cubxity)
- build: fabric compileJava (Cubxity)
- build: java target version (Cubxity)
Builds
- minestom: upgrade dependency (Cubxity)
Chores
- improve renovate configuration (Cubxity)
- bump version to 0.3.8-SNAPSHOT (Cubxity)
- deps: exclude fabric yarn from renovate (Cubxity)
- deps: update all non-major dependencies (#81) (renovate[bot])
- deps: update all non-major dependencies (#89) (renovate[bot])
- deps: update dependency gradle to v8 (#88) (renovate[bot])
- deps: update plugin com.github.johnrengelman.shadow to v8 (#91) (renovate[bot])
- deps: update all non-major dependencies (#93) (renovate[bot])
- deps: update minestom dependencies (Cubxity)
- bump version to 0.3.8 (Cubxity)
0.3.8Релиз1.19.2, 1.19.3, 1.19.4 · 23 апреля 2023 г.
Bug Fixes
- deps: update all non-major dependencies (#75) (renovate[bot])
- deps: update all non-major dependencies (#76) (renovate[bot])
- deps: update all non-major dependencies (#79) (renovate[bot])
- build: dependency issues (Cubxity)
- gitignore and .idea directory (Cubxity)
- velocity: login counter metric (Cubxity)
- deps: update all non-major dependencies (#82) (renovate[bot])
- deps: update all non-major dependencies (#92) (renovate[bot])
- build: signArchives and shadowJar (Cubxity)
- build: signArchives and shadowJar (Cubxity)
- build: fabric compileJava (Cubxity)
- build: java target version (Cubxity)
Builds
- minestom: upgrade dependency (Cubxity)
Chores
- improve renovate configuration (Cubxity)
- bump version to 0.3.8-SNAPSHOT (Cubxity)
- deps: exclude fabric yarn from renovate (Cubxity)
- deps: update all non-major dependencies (#81) (renovate[bot])
- deps: update all non-major dependencies (#89) (renovate[bot])
- deps: update dependency gradle to v8 (#88) (renovate[bot])
- deps: update plugin com.github.johnrengelman.shadow to v8 (#91) (renovate[bot])
- deps: update all non-major dependencies (#93) (renovate[bot])
- deps: update minestom dependencies (Cubxity)
- bump version to 0.3.8 (Cubxity)
0.3.8Релиз1.19.2, 1.19.3, 1.19.4 · 23 апреля 2023 г.
Bug Fixes
- deps: update all non-major dependencies (#75) (renovate[bot])
- deps: update all non-major dependencies (#76) (renovate[bot])
- deps: update all non-major dependencies (#79) (renovate[bot])
- build: dependency issues (Cubxity)
- gitignore and .idea directory (Cubxity)
- velocity: login counter metric (Cubxity)
- deps: update all non-major dependencies (#82) (renovate[bot])
- deps: update all non-major dependencies (#92) (renovate[bot])
- build: signArchives and shadowJar (Cubxity)
- build: signArchives and shadowJar (Cubxity)
- build: fabric compileJava (Cubxity)
- build: java target version (Cubxity)
Builds
- minestom: upgrade dependency (Cubxity)
Chores
- improve renovate configuration (Cubxity)
- bump version to 0.3.8-SNAPSHOT (Cubxity)
- deps: exclude fabric yarn from renovate (Cubxity)
- deps: update all non-major dependencies (#81) (renovate[bot])
- deps: update all non-major dependencies (#89) (renovate[bot])
- deps: update dependency gradle to v8 (#88) (renovate[bot])
- deps: update plugin com.github.johnrengelman.shadow to v8 (#91) (renovate[bot])
- deps: update all non-major dependencies (#93) (renovate[bot])
- deps: update minestom dependencies (Cubxity)
- bump version to 0.3.8 (Cubxity)
0.3.8Релиз1.19.2, 1.19.3, 1.19.4 · 23 апреля 2023 г.
Bug Fixes
- deps: update all non-major dependencies (#75) (renovate[bot])
- deps: update all non-major dependencies (#76) (renovate[bot])
- deps: update all non-major dependencies (#79) (renovate[bot])
- build: dependency issues (Cubxity)
- gitignore and .idea directory (Cubxity)
- velocity: login counter metric (Cubxity)
- deps: update all non-major dependencies (#82) (renovate[bot])
- deps: update all non-major dependencies (#92) (renovate[bot])
- build: signArchives and shadowJar (Cubxity)
- build: signArchives and shadowJar (Cubxity)
- build: fabric compileJava (Cubxity)
- build: java target version (Cubxity)
Builds
- minestom: upgrade dependency (Cubxity)
Chores
- improve renovate configuration (Cubxity)
- bump version to 0.3.8-SNAPSHOT (Cubxity)
- deps: exclude fabric yarn from renovate (Cubxity)
- deps: update all non-major dependencies (#81) (renovate[bot])
- deps: update all non-major dependencies (#89) (renovate[bot])
- deps: update dependency gradle to v8 (#88) (renovate[bot])
- deps: update plugin com.github.johnrengelman.shadow to v8 (#91) (renovate[bot])
- deps: update all non-major dependencies (#93) (renovate[bot])
- deps: update minestom dependencies (Cubxity)
- bump version to 0.3.8 (Cubxity)
0.3.7Релиз1.19, 1.19.1, 1.19.2 · 25 сентября 2022 г.
Bug Fixes
- apiProvider being initialized after saveConfig (Cubxity)
Chores
- build: upgrade kotlin (Cubxity)
- build: upgrade dependencies (Cubxity)
- deps: add renovate.json (#61) #61 (renovate[bot])
- deps: group non-major renovate dependency upgrades (Cubxity)
- deps: update actions/checkout action to v3 (#71) #71 (renovate[bot])
- deps: update actions/setup-java action to v3 (#72) #72 (renovate[bot])
- deps: update plugin fabric-loom to v1 (#73) #73 (renovate[bot])
- deps: update all non-major dependencies (#74) #74 (renovate[bot])
- bump version to 0.3.7 (Cubxity)
Commits
- 4f37c6a: [skip ci] docs: update readme (Cubxity)
- 5ec26b0: [skip ci] docs: update readme (Cubxity)
- 4beba9f: Merge branch 'dev/0.3.x' (Cubxity)
0.3.7Релиз1.19, 1.19.1, 1.19.2 · 25 сентября 2022 г.
Bug Fixes
- apiProvider being initialized after saveConfig (Cubxity)
Chores
- build: upgrade kotlin (Cubxity)
- build: upgrade dependencies (Cubxity)
- deps: add renovate.json (#61) #61 (renovate[bot])
- deps: group non-major renovate dependency upgrades (Cubxity)
- deps: update actions/checkout action to v3 (#71) #71 (renovate[bot])
- deps: update actions/setup-java action to v3 (#72) #72 (renovate[bot])
- deps: update plugin fabric-loom to v1 (#73) #73 (renovate[bot])
- deps: update all non-major dependencies (#74) #74 (renovate[bot])
- bump version to 0.3.7 (Cubxity)
Commits
- 4f37c6a: [skip ci] docs: update readme (Cubxity)
- 5ec26b0: [skip ci] docs: update readme (Cubxity)
- 4beba9f: Merge branch 'dev/0.3.x' (Cubxity)
0.3.7Релиз1.19, 1.19.1, 1.19.2 · 25 сентября 2022 г.
Bug Fixes
- apiProvider being initialized after saveConfig (Cubxity)
Chores
- build: upgrade kotlin (Cubxity)
- build: upgrade dependencies (Cubxity)
- deps: add renovate.json (#61) #61 (renovate[bot])
- deps: group non-major renovate dependency upgrades (Cubxity)
- deps: update actions/checkout action to v3 (#71) #71 (renovate[bot])
- deps: update actions/setup-java action to v3 (#72) #72 (renovate[bot])
- deps: update plugin fabric-loom to v1 (#73) #73 (renovate[bot])
- deps: update all non-major dependencies (#74) #74 (renovate[bot])
- bump version to 0.3.7 (Cubxity)
Commits
- 4f37c6a: [skip ci] docs: update readme (Cubxity)
- 5ec26b0: [skip ci] docs: update readme (Cubxity)
- 4beba9f: Merge branch 'dev/0.3.x' (Cubxity)
0.3.7Релиз1.19, 1.19.1, 1.19.2 · 25 сентября 2022 г.
Bug Fixes
- apiProvider being initialized after saveConfig (Cubxity)
Chores
- build: upgrade kotlin (Cubxity)
- build: upgrade dependencies (Cubxity)
- deps: add renovate.json (#61) #61 (renovate[bot])
- deps: group non-major renovate dependency upgrades (Cubxity)
- deps: update actions/checkout action to v3 (#71) #71 (renovate[bot])
- deps: update actions/setup-java action to v3 (#72) #72 (renovate[bot])
- deps: update plugin fabric-loom to v1 (#73) #73 (renovate[bot])
- deps: update all non-major dependencies (#74) #74 (renovate[bot])
- bump version to 0.3.7 (Cubxity)
Commits
- 4f37c6a: [skip ci] docs: update readme (Cubxity)
- 5ec26b0: [skip ci] docs: update readme (Cubxity)
- 4beba9f: Merge branch 'dev/0.3.x' (Cubxity)
Комментарии
Загружаем…

