diff --git a/README.md b/README.md index b2ba1e54..65f0aaf1 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,15 @@ licensed under [GNU LGPLv3](COPYING.LESSER). - Prometheus - InfluxDB +## Getting started + +Read the [wiki](https://github.com/Cubxity/UnifiedMetrics/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 | @@ -47,34 +54,51 @@ licensed under [GNU LGPLv3](COPYING.LESSER). | tick | Tick duration histogram | Bukkit, Minestom | true | | world | World entities, players, and chunks count | Bukkit, Minestom | true | -## Getting started +
-Read the [wiki](https://github.com/Cubxity/UnifiedMetrics/wiki) for instructions. - -## Data visualization and analysis +## Special Thanks -We recommend using [Grafana](https://grafana.com/) as it provides highly customizable diagrams. Grafana provides -out-of-box support for Prometheus and InfluxDB. +UnifiedMetrics is a proud partner of DedicatedMC! Get your Raw Power Hosting today with **15% OFF** using +code `UnifiedMetrics`! -See the [wiki](https://github.com/Cubxity/UnifiedMetrics/wiki/Grafana) for detailed instructions. +[![DedicatedMC Logo](.github/assets/dmc.png)](https://dedimc.promo/UnifiedMetrics) -> **Note:** InfluxDB Grafana dashboard may be inaccurate due to complications with Flux queries. +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](https://www.yourkit.com/java/profiler/), +[YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/), +and [YourKit YouMonitor](https://www.yourkit.com/youmonitor/). -### UnifiedMetrics 0.3.x (stable) +[![YourKit Logo](https://www.yourkit.com/images/yklogo.png)](https://www.yourkit.com/) -- [InfluxDB (Flux)](https://grafana.com/grafana/dashboards/14755) -- [Prometheus](https://grafana.com/grafana/dashboards/14756) +## Servers using UnifiedMetrics -### UnifiedMetrics 0.2.x (legacy) +

+ + Craftadia + + + OctaneMC + +

-- [InfluxDB (InfluxQL)](https://grafana.com/grafana/dashboards/13860) -- [Prometheus](https://grafana.com/grafana/dashboards/14017) +> **Pssst!** You can add your server here by submitting a *Pull Request*! ## Building from source +
+ Instructions (click to show) + **Requirements:** -- JDK 11+ +- JDK 8+ (16+ for Fabric) - Git (Optional) To build UnifiedMetrics, you need to obtain the source code first. You can download the source from GitHub or use the @@ -97,6 +121,7 @@ $ `./gradlew :unifiedmetrics-platform-bukkit:assemble` ``` The output artifacts can be found in `subproject/build/libs`. +
## API @@ -108,38 +133,4 @@ import dev.cubxity.plugins.metrics.api.UnifiedMetricsProvider /* ... */ val api = UnifiedMetricsProvider.get() -``` - -## Special Thanks - -UnifiedMetrics is a proud partner of DedicatedMC! Get your Raw Power Hosting today with **15% OFF** using code `UnifiedMetrics`! - -[![DedicatedMC Logo](.github/assets/dmc.png)](https://dedimc.promo/UnifiedMetrics) - -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](https://www.yourkit.com/java/profiler/), -[YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/), -and [YourKit YouMonitor](https://www.yourkit.com/youmonitor/). - -[![YourKit Logo](https://www.yourkit.com/images/yklogo.png)](https://www.yourkit.com/) - -## Servers using UnifiedMetrics - -

- - Craftadia - - - OctaneMC - -

- -> **Pssst!** You can add your server here by submitting a *Pull Request*! +``` \ No newline at end of file