Spark is a Minecraft performance profiling mod and plugin that can be used to display server information, such as TPS, CPU and memory usage, and tick processing timings. One notable feature in particular is the ability to create a performance profile that can be viewed through your browser.
Installing Spark
⚠️ This step can be ignored if you are running Paper versions 1.21 and newer, or Purpur versions 1.19.1 and newer. These platforms include Spark by default and does not need to be downloaded separately.
Install the latest version using the from the Content tab of your server panel. Click the "Browse content" button to open our content installer, and search for "Spark". Once installed, make sure to restart your server to make sure it gets loaded onto the server.
❗️ Spark does not work on vanilla servers. Your server must be running Fabric or NeoForge in order to install the modded version of the project.
Creating a Performance Profile
To create a performance profile using Spark, run the spark profiler start command in the console found in the Overview tab of the server's panel. If you have operator privileges on the server, you can run the command in-game as well. Additional arguments to modify the profiler's behavior can be found in Spark's command documentation.
In order for Spark to capture performance issues, it must be started before you notice the server starting to lag, and be left running for at least 10 minutes before stopping the profiler.
To stop the profiler, run the command spark profiler stop in the console or in-game depending on how you started it above.
If our support team requested you create a Spark profile for them, you'd now send them the generated link!
Reading a Spark Profile
Once the performance profile has been created, a link to spark.lucko.me will be generated which can be found in either the console or in-game depending on where you ran the stop command.
Upon opening the link, you will be greeted with a web page that looks very similar to the image below. This page displays all the data collected from the profiler.
The information in the boxes at the top of the page show general process and system statistics. The middle section shows information about the server itself, and the bottom section is a breakdown of every method being executed by the server.
ℹ️ You'll likely notice that the Memory (physical) statistics are red, which is normal and nothing to worry about. Similarly, the Memory (process) section might appear lower than your plan's memory limit, which too is normal.