How to Use the Unity Performance Benchmark Reporter

The Unity Performance Benchmark Reporter is built as a .NET Core assembly so that it is compatible to run across different .NET supported platforms (Windows, OSX, etc). Therefore in order to run it, you'll need ensure you have installed the .NET Core SDK. Executing the Unity Performance Benchmark reporter entails invoking the assembly with the dotnet command like this:

dotnet UnityPerformanceBenchmarkReporter.dll --baseline=D:\UnityPerf\baseline.xml --results=D:\UnityPerf\results --reportdirpath=d:\UnityPerf

After the reporter runs, a directory named UnityPerformanceBenchmark will be created with an html report and supporting .css, .js, and image files in it. Open the html report to view visualizations of the performance metrics captures in the .xml result files.

Command Line Options

• --results the path to a directory where we have one or more non-baseline result .xml files to be included in the html report.

  At least one --results value must be passed to the UnityPerformanceBenchmarkReporter.dll assembly._ This is the only requied field.

  This command line option also can be used to specify the path to a single .xml non-baseline result file. Additionally, you can specify several directories or files by repeating the option like this:

  --results=D:\UnityPerf\results --results=D:\UnityPerf\results.xml

• --baseline the path to a result .xml file that will used to compare other results against.

• --reportdirpath the path to a directory where the reporter will create the performance benchmark report. This is created in a UnityPerformanceBenchmark subdirectory.

  If the report location is not specified, the UnityPerformanceBenchmark subdirectory will be created in the working directory that the UnityPerformanceBenchmarkReporter.dll was invoked.