命令分析器

命令分析器

一个用于分析和记录命令与函数性能的模组

管理

Command Profiler 是一个模组,可让你使用 /cmdprof 对命令和函数进行性能分析。

使用性能分析器

如果你拥有管理员权限,可以使用 /cmdprof enable 命令启动性能分析器。要让性能分析器停止收集数据,请执行 /cmdprof disable;要重置当前已分析的数据,请执行 /cmdprof reset。

查看性能分析结果

有三种不同的数据呈现格式:

  1. 在控制台显示文本(以 print 开头的子命令)
  2. 保存为 JSON(以 save 开头的子命令)
  3. 保存为字节(与 save 相同,但需要提供 bytes 作为参数)

这意味着你需要访问服务器控制台才能查看性能分析结果。

有 print 和 save 子命令,用于查看性能分析器整个运行期间的结果。(print 按总耗时排序)

还有 print_trace 和 save_trace 子命令,用于查看最近一次捕获的 tick 的性能分析结果。(按执行顺序排序)

注意:要使用这些命令查看跟踪数据,你必须先启用 cmdprof:local/trace。同时,对于性能分析数据,你必须启用 cmdprof:local/profile,该选项默认启用。

配置性能分析器

你可以使用 /cmdprof config 子命令配置性能分析器,目前有几个选项:

  • cmdprof:granularity - 当设置为 command 时,所有命令都会被分析;当设置为 function 时,命令不会被单独分析
  • cmdprof:command/macro_templates - 当设置为 false 时,带有宏的命令会将其参数内联到命令中
  • cmdprof:function/line_numbers - 当设置为 true 时,命令会包含其行号,而不是设置为 0
  • cmdprof:local/profile,当设置为 true 时,/cmdprof print 和 /cmdprof save 可用
  • cmdprof:local/trace,当设置为 true 时,/cmdprof print_trace 和 /cmdprof save_trace 可用
  • cmdprof:memory_usage,当设置为 true 时,所有事件都会跟踪内存使用情况(这会大幅降低性能,除非你正在尝试制作一个修复内存使用问题的模组,否则不值得使用)
  • cmdprof:macro/instantiations,当设置为 true 时,性能分析结果会将实例化宏函数所需的时间作为一个单独步骤包含在内,而不是将其与执行实例化的命令合并
  • cmdprof:online/scoreboard - 当设置为 true 时,服务器在启用后会将计分板数据发送到在线数据页面。

在线查看数据

你可以使用 /cmdprof online view 在线打开性能分析器,并使用 /cmdprof online stop 停止它。请注意,你需要先使用 /cmdprof enable 启用性能分析器,否则将不会提供任何数据。如果你想在线查看计分板数据,请执行 /cmdprof config cmdprof:online/scoreboard true。

性能分析器在运行时每秒自动刷新数据。计分板数据大约每个 tick 更新一次。

对函数进行基准测试

使用 /cmdprof benchmark run <name>,你可以对函数或函数标签进行基准测试,这可能需要一段时间,但完成后会在聊天中显示结果。你可以通过 /cmdprof benchmark cancel 取消当前正在运行的基准测试。成功执行 /reload 会自动取消所有待处理的基准测试。被基准测试的函数在服务器命令上下文中运行,而不是在运行它的玩家上下文中运行。

此外,你还可以使用 /cmdprof benchmark command <command> 对单条命令进行基准测试。

注意:进行基准测试并不需要启用性能分析器,你可能应该执行 /cmdprof disable,以便更准确地表示函数的运行速度。不过,如果你想要导出结果,你可能仍然希望保持性能分析器启用。