HomeJavaModsTickScope
TickScope
ModsJava

TickScope

by gabezim · on Modrinth

Prometheus metrics for Paper servers in a lightweight plugin with zero runtime dependencies. Exact MSPT percentiles, per-world entity and chunk counts…

⬇ Download on Modrinth
TickScope — screenshot 1TickScope — screenshot 2
TickScope icon

TickScope — Minecraft monitoring for Prometheus and Grafana

TickScope is a lightweight Prometheus exporter for Minecraft Paper and Folia servers. The dependency-free plugin exposes tick health, players, per-world counters, JVM and CPU statistics, and player event counters for dashboards in Grafana.

mc_mspt_ms{quantile="p99"} 21.6336
mc_tps{window="1m"} 20.0
mc_players_online 4
mc_world_entities_by_type{world="world",type="chicken"} 35

Highlights

Quick start

  1. Download the latest jar from the Files tab at the top of this page.
  2. Put TickScope-*.jar in the server's plugins/ directory and restart.
  3. Scrape the default endpoint at http://127.0.0.1:9101/metrics.
scrape_configs:
  - job_name: minecraft
    static_configs:
      - targets: ["127.0.0.1:9101"]

The default endpoint is open but bound to loopback. When Minecraft runs in Docker, follow the Docker installation notes before changing the bind address. Configure bearer authentication and TLS whenever metrics cross a network you do not fully control.

Grafana dashboard

TickScope Grafana dashboard showing players, TPS, exact MSPT percentiles, and heap use

Download the dashboard JSON, import it into Grafana, and select the Prometheus data source that scrapes TickScope. A built-in server selector supports one Paper server or a network of independently labeled backends.

Collection health and alerting

Track collection freshness and failures even when the HTTP endpoint remains reachable. Folia sampling publishes partial coverage and bounds outstanding work per player. World exclusions and an entity-type allowlist help control collection scope.

See health metrics, filters, and setup instructions, the Prometheus alert rules, and the optional per-server dashboard.

Documentation

The full manual lives in the TickScope wiki:

Guide Covers
Installation Requirements, upgrades, Prometheus, and Docker
Configuration Every setting, bearer authentication, and commands
Metrics reference Metric names, labels, semantics, and PromQL notes
Grafana and Prometheus Scrape, remote-write, and dashboard examples
Design and privacy Architecture, collection cost, and security model
Troubleshooting Compatibility, missing series, and lag diagnosis
Development and releases Building, testing, releases, and support
Metric stability Compatibility guarantees for names, labels, and semantics

Compatibility

Paper 1.18.2+, Paper-compatible Purpur servers, Folia, and Folia-compatible Canvas servers are supported. Spigot, Bukkit, Velocity, and BungeeCord are not supported. Install TickScope on each backend in a proxy network and assign each server a unique server-id.

Paper exposes a single server tick, so TickScope publishes exact mc_mspt_ms, mc_tick_samples, and mc_tps series there. Folia has no truthful server-wide equivalent. On Folia, those series are intentionally absent and are replaced by mc_folia_region_tps summaries sampled at online player locations. Servers exposing regional average tick times, including Canvas, also receive mc_folia_region_mspt_ms; this is average MSPT per player-active region rather than a global percentile. Per-world entity totals, tile-entity totals, and the entity-type breakdown are unavailable on Folia, because walking a world crosses region ownership boundaries; per-world chunk and player counts, and all other server, player, event, JVM, and process metrics, remain available.

On Paper those three series come from a slower scan (entity-types.interval-ticks, 600 ticks by default) rather than from every collection, because counting tile entities walks the loaded chunks and, before Minecraft 26, counting entities walked every entity.

Support

TickScope is maintained by Gabe Zimbric and licensed under GPL-3.0-or-later.

Quick facts

Install steps are the general flow for this file type — How to install Minecraft Java mods & modpacks walks through it step by step.

TickScope is a free Minecraft Java mod. Compatible with Minecraft 1.18.2, 1.19, 1.19.1, 1.19.2 and newer. Downloaded 5 times (via Modrinth). Download it and open it directly in the game.

Explore more