Home

TickScope documentation

TickScope is a lightweight Prometheus exporter for Minecraft Paper and Folia servers. It exposes tick performance, players, per-world entity and chunk counts, JVM and CPU statistics, and player event counters without runtime dependencies.

One jar supports Paper and Purpur from Minecraft 1.18.2 onward, plus Folia and compatible Canvas releases, on Java 17 or newer.

Start here

1. Download the latest release.
2. Put TickScope-*.jar in the server's plugins/ directory.
3. Start the server and scrape http://127.0.0.1:9101/metrics.

scrape_configs:
  - job_name: minecraft
    static_configs:
      - targets: ["127.0.0.1:9101"]

If Minecraft runs in Docker, read the Docker installation notes before changing the bind address.

Documentation

• Installation — requirements, installation, Prometheus, Docker
• Configuration — every setting, bearer authentication, commands
• Metrics reference — metric names, labels, semantics, PromQL notes
• Grafana and Prometheus — scrape and remote-write examples
• Metric stability — compatibility guarantees for names, labels, and semantics
• Design and privacy — architecture, performance, security model
• Troubleshooting — compatibility, missing series, lag diagnosis
• Development and releases — building, testing, releases, support

Project links

• Source
• GitHub releases
• Modrinth
• Bug reports
• Questions and discussions
• Private security reports

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