Skip to main content

Getting Started

This guide will walk you through the process of setting up UnifiedMetrics on your server.

Getting UnifiedMetrics

First, you must download and install UnifiedMetrics on your server. After downloading the JAR, put the plugin/mod in the respective folder. Installing UnifiedMetrics exclusively on your proxy server(s) will not export backend metrics, such as TPS.

  • Spigot/Paper/etc, Velocity, BungeeCord: plugins
  • Fabric: mods
  • Minestom: extensions

Downloads »

Metrics Driver

Then, you must select a metric driver to use. Please follow the respective guide to set them up.

Prometheus is an open-source systems monitoring and alerting toolkit. This is the recommended metrics driver and is perfect for integrated environments like Kubernetes and Docker.

Set up Prometheus »

InfluxDB

InfluxDB is an open-source time series database. This is useful for pushing metrics to a remote server.

Set up InfluxDB »

Visualization

Grafana

Grafana Dashboard

Grafana is a multi-platform open source analytics and interactive visualization web application. It provides charts, graphs, and alerts for the web when connected to supported data sources.

Set up Grafana »