Command Profiler

Command Profiler is a mod which lets you profile commands and functions using /cmdprof.

Using the profiler

You can start the profiler if you have operator privileges using the /cmdprof enable command. For the profiler to stop collecting data do /cmdprof disable, and to reset the current profiled data do /cmdprof reset.

Viewing profiler results

There are three different formats for taking the data

1. display text in console (subcommands that start with print)
2. save as JSON (subcommands that start with save)
3. save as bytes (same as save except you need to provide bytes as an argument)

This does mean that you need access to the server console to view the profiler results.

There are print and save subcommands for viewing the profiler results over the entire duration of the profiler running. (print is sorted by total time taken)

And there are print_trace and save_trace subcommands for viewing the profiler results over the last captured tick. (ordered by execution)

Note: To use these commands to view trace data, you have to enable cmdprof:local/trace first. Meanwhile for profile data, you have to enable cmdprof:local/profile which is enabled by default.

Configuring the profiler

You can configure the profiler using the /cmdprof config subcommand, there are currently several options:

• cmdprof:granularity - when set to command all commands will be profiled, and when set to function commands will not be profiled individually
• cmdprof:command/macro_templates - when set to false, commands which have macros will have their arguments inlined into the command
• cmdprof:function/line_numbers - when set to true, commands will include their line number, instead of being set to 0
• cmdprof:local/profile, when set to true, /cmdprof print and /cmdprof save are usable
• cmdprof:local/trace, when set to true, /cmdprof print_trace and /cmdprof save_trace are usable
• cmdprof:memory_usage, when set to true, all events will track the memory usage (this reduces the performance by quite a bit, not worth using it unless you're trying to make a mod which fixes memory usage issues)
• cmdprof:macro/instantiations, when set to true, profiler results will include how long it takes to instantiate a macro function as a separate step, instead of merging it with the command that executes the instantiation
• cmdprof:online/scoreboard - when set to true, the server will send scoreboard data to the online data page when enabled.

Viewing data online

You can open the profiler online using /cmdprof online view, and stop it using /cmdprof online stop. Note that you need to enable the profiler using /cmdprof enable first, otherwise there will be no data provided. If you want to see scoreboard data online, do /cmdprof config cmdprof:online/scoreboard true.

The profiler automatically refreshes data every second when it is running. The scoreboard data gets updated approximately every tick.

Benchmarking functions

Using /cmdprof benchmark run <name>, you can benchmark a function or a function tag, it might take a while, but after it finishes, it will display the results in chat. You can cancel a currently running benchmark via /cmdprof benchmark cancel. A successful /reload automatically cancels all pending benchmarks. The benchmarked function(s) run in the server command context instead of whoever is running it.

Additionally, you benchmark a single command using /cmdprof benchmark command <command>.

Note: You don't need to have the profiler enabled for benchmarking specifically, you should probably do /cmdprof disable to have a more accurate representation of how fast a function could be. However you might still want to keep the profiler enabled, if you want to dump the results for example.