Create a Spark Report

Join our Discord and be part of our community!

Create a Spark Report

In this guide, we will explain how to use Spark. Spark is a tool to create timing reports or as an in-depth way to check your servers’ statistics. We recommend to check out the documentation as it goes into depth of how Spark works.

Spark is also a mod that you can download here, and then upload to the mods folder and continue to follow along the guide on creating a spark report. This guide will cover the plugin method.

Install Spark Plugin

First, navigate to the 1 Plugins page.
Search for Spark, click the 2 Install button, and wait for the installation to complete.

Restart the Server

Next, restart your server to ensure the plugin is installed correctly.
After your server has restarted, connect to your server to start issuing commands.

Start Spark Profiler

You can use /spark profiler start --timeout 600 to have spark record for 10 minutes and automatically create a paste.

To start a Spark report, you can type /spark profiler start.
This will start a report running on your server. To get the results from the profiler, you have to type /spark profiler stop.

If you don't stop the profiler, it will appear empty when you try to check it.

Once the profiler has been stopped, a link will be posted in the chat.
Follow the link to see your Spark report.

Analyze Report

The link should be posted in the chat once you have stopped the profiler.
Follow that link to see your Spark report.
You can analyze the spark report to see what is causing the performance issue. If you are reaching out to our support team, they will often request a spark report to help diagnose the issue of your server.

If you require further assistance, you can open a support ticket here.

Feedback and suggestions can be submitted here or further discussed on our Discord server.