SparkReviewer Guide
This page introduces SparkReviewer as a public staff guide. It focuses on what the tool does, how authorized staff get started, and which commands are useful.
What It Does
Section titled “What It Does”SparkReviewer is a server-management feature plugin for performance triage.
How Staff Use It
Section titled “How Staff Use It”Start with /sparkreviewer status. The sections below explain what SparkReviewer is for, which commands authorized staff can use, and what its output means.
Available features include:
- Captures live TPS, average MSPT when Paper exposes it, memory usage, player count, world count, and CMI/CMILib/Spark/MobFarmManager status.
- Counts loaded entities per world, including living entities, monsters, animals, item drops, projectiles, vehicles, hopper minecarts, tile entities, and hopper blocks in scanned loaded chunks.
- Lists chunk hotspots by entity/item/hopper/tile count.
- Reviews Paper, Bukkit, Spigot, per-world Paper, MobFarmManager, and selected CMI config values whose paths look performance-relevant.
- Reviews Paper bundled Spark enablement from config/paper-global.yml when present.
- Reviews logs/latest.log for startup Done (…), shutdown/save lines, Spark report URLs, SparkReviewer markers, Can’t keep up!, watchdog/stall lines, warnings, errors, and exceptions.
- Dispatches Spark health and profiler commands from a single command surface.
- Writes named snapshots for before/after comparisons such as mfm-on versus mfm-off.
Quick Start
Section titled “Quick Start”- Start with
/sparkreviewer statusto open or view SparkReviewer. - Use
/sparkreviewer statusto check your current progress, settings, or state. - Try
/sparkreviewer reviewwhen you are ready to use one of the feature actions.
Commands
Section titled “Commands”| Command | What it does | Example |
|---|---|---|
/sparkreviewer status | Shows your current SparkReviewer status. | /sparkreviewer status |
/sparkreviewer review | Runs the SparkReviewer review action. | /sparkreviewer review |
/sparkreviewer findings [page] | Runs the SparkReviewer findings action. | /sparkreviewer findings |
/sparkreviewer entities [page] | Runs the SparkReviewer entities action. | /sparkreviewer entities |
/sparkreviewer chunks [page] | Runs the SparkReviewer chunks action. | /sparkreviewer chunks |
/sparkreviewer logs [page] | Runs the SparkReviewer logs action. | /sparkreviewer logs |
/sparkreviewer mfm [page] | Runs the SparkReviewer mfm action. | /sparkreviewer mfm |
/sparkreviewer compare <before> <after> [page] | Runs the SparkReviewer compare action. | /sparkreviewer compare example example |
/sparkreviewer spark status | Runs the SparkReviewer spark action. | /sparkreviewer spark status |
/sparkreviewer spark health | Runs the SparkReviewer spark action. | /sparkreviewer spark health |
/sparkreviewer spark start [seconds] [label] | Runs the SparkReviewer spark action. | /sparkreviewer spark start |
/sparkreviewer spark stop [label] | Runs the SparkReviewer spark action. | /sparkreviewer spark stop |
/sparkreviewer spark cancel | Runs the SparkReviewer spark action. | /sparkreviewer spark cancel |
/sparkreviewer stress <label> [seconds] | Runs the SparkReviewer stress action. | /sparkreviewer stress example |
/sparkreviewer dump | Runs the SparkReviewer dump action. | /sparkreviewer dump |
Aliases
Section titled “Aliases”/sreview/spreview
Examples
Section titled “Examples”/sparkreviewer review/sparkreviewer findings/sparkreviewer entities/sparkreviewer chunks/sparkreviewer logs/sparkreviewer mfm/sparkreviewer spark health/sparkreviewer spark start 180 farm-test/sparkreviewer stress mfm-on 180/sparkreviewer stress mfm-off 180/sparkreviewer compare mfm-on mfm-off/sparkreviewer dump
Good To Know
Section titled “Good To Know”- This is a permission-gated staff or server-management feature, not a normal player feature.
- Review the full reference before changing settings or using any command that can write data.
Full Reference
Section titled “Full Reference”The full synced SparkReviewer reference is available for exact technical details.