Create a Spark Report for Hytale

Join our Discord and be part of our community!

Create a Spark Report for Hytale

This guide explains how to install Spark and create profiler reports for your Hytale server. Spark generates timing reports to analyze server performance, detect lag, and optimize your server in depth. For complete details, see the official documentation.

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 covers the mod installation method.

Install the Spark Mod

Navigate to your File Manager
Search for a folder called mods
Drag and drop the spark.jar file into the mods folder.

The mods folder should contain the spark.jar file:

Install the Spark Mod via Installer

Navigate to the 1 Hytale Mods tab.
Search for the 2 Spark mod.
Click the 3 Install button.

Restart the Server

Restart your server to load the newly installed mod.
After restarting, type spark healthreport to verify the installation.

Create a Spark Report

Use /spark profiler start --timeout 600 to run a 10-minute Spark report. It stops and posts the results in chat automatically after 10 minutes.

To start a Spark report, type /spark profiler start.
This starts a report running on your server. To get the results, type /spark profiler stop.

If you do not stop the profiler, the report appears empty when you view it.
Do not stop the profiler immediately after starting it. Let it run for at least 30 seconds to collect meaningful data.

Once you stop the profiler, the server posts a link in the chat.
Click the link to view your Spark report.

The Spark report interface should display timing data:

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.