UnifiedMetrics

Quick rating

UnifiedMetrics

No reviews yet

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

Mod Loaders
Fabric
Paper
Spigot
Minecraft

Community voices

Reviews

Versions
Loading versions…
Match includes

Click once to include, again to exclude, again to clear

Rating Any
Any 0.5 1.0 1.5 2.0 2.5 3.0 3.5 4.0 4.5 5.0
Min
Max
Play Status
Reviews
Time Played
hrs+
Verified developers only
Has developer response
List view
Grid view
Compact view
Sort by
Date
Rating
Helpful
Unhelpful
Edited
Sort ascending
Delete this review?

This removes your review from the project. You can write a new review after.

Review submitted for moderation

Your review has been sent to moderators, who will check that it meets our guidelines before it appears publicly.

No reviews yet. Be the first to review this project!

Get it on

Available Platforms

Compatibility

Supported Environments

Where It Runs
Server Only

Runs entirely on the server. Also works in singleplayer.

About

Project Details

Type
Mod
License
GNU Lesser General Public License v3.0 only
Latest Version
0.3.8
Authors

For authors

Embed Badge

If you're the author of this project, you can embed a live badge anywhere that supports HTML or Markdown. It updates automatically whenever ratings change.

Custom banner text
ModDex rating badge preview

Use HTML for any page that supports it, or Markdown for README files and Markdown-based descriptions.

Identifiers

Platform IDs

Modrinth ID

Resources

External Links

About

Description

UnifiedMetrics

License Issues Workflow Status Discord

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

Grafana Dashboard 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.

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

$ 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()

Screenshots

Gallery

  • Grafana Dashboard
    Grafana Dashboard

Versions

Files

Relations

Project Relations

More like this

Similar Mods

Suggestions use data such as tags, dependencies, dependents, descriptions, titles, and more to rank how much they overlap with this mod.

On ModDex

Community snapshot

0
Ratings
0
Followers
0
In stacks

By the numbers

Statistics

~5,000
Downloads
Last Updated
CurseForge
Created
Last synced
When ModDex last fetched this project from CurseForge or Modrinth. Every project is re-checked on a schedule, and any project that ships a new file is synced automatically within hours of the release.
New file updates sync automatically
How syncing works