Menu
Lumberyard
User Guide (Version 1.14)

Logging Data

Logging game data using Statoscope involves selecting data groups. Select only the data groups you want to log and display to minimize the performance impact.

The following figure shows the default view with everything enabled and the entire log fit to the viewport graph. You can unselect unneeded data groups and zoom out to make the graph more readable.

You can log data directly to Statoscope using a socket or you can log data to a file.

If you just want to record some data to see how your game is performing, socket logging is recommended. This gives you real-time updates in Statoscope and avoids the maintenance of having log files.

If you want to log QA sessions or compare time demo runs, file logging is recommended.

Logging Data to a Socket

The following procedure shows how to log data directly to the Statoscope application using a socket.

To log data to Statoscope (socket)

  1. Run a Profile game client on your chosen platform (such as SampleProjectLauncher.exe for example).

  2. Set the relevant console variables either after the game client loads or by editing the bootstrap.cfg file. The following example would enable logging data from all threads with frame rate limiters disabled:

    • profile_allthreads 1

    • r_Vsync 0

    • sys_maxFPS -1

    • e_StatoscopeLogDestination 1

    • e_StatoscopeEnabled 1

    • e_StatoscopeDataGroups your_data_groups. Default data groups are fgmtuO.

  3. Run Statoscope.exe from \Tools\Statoscope.

  4. In Statoscope, select File, Connect. For Windows, accept all defaults. For consoles, enter the IP of your game developer's kit.

  5. Select Log to file, then select the file name to log to. Select the file name quickly or else your session may timeout. For more information, see Guidelines and Best Practices.

You should see your selected data groups being logged.

Logging Data to a File

The following procedure shows how to log data to a file.

To log data to a file

  1. Run a Profile game client on your chosen platform (such as SampleProjectLauncher.exe for example).

  2. Set the relevant console variables either after the game client loads or by editing the bootstrap.cfg file. The following example would enable logging data from all threads with frame rate limiters disabled:

    • profile_allthreads 1

    • r_Vsync 0

    • sys_maxFPS -1

    • e_StatoscopeLogDestination 0

    • e_StatoscopeDataGroups your_data_groups Default data groups are fgmtuO.

  3. Set the e_StatoscopeEnabled 1 console variable from the game client to enable Statoscope.

  4. Run Statoscope.exe from \Tools\Statoscope.

  5. In Statoscope, select File, Open the log file. Log files for Statoscope are located at \cache\launchername\platform\user\log\statoscope\perf_config_0_0_0_0.bin. For Windows, an example file path would be \cache\samplesproject\pc\user\log\statoscope\perf_win64_0_0_0_0.bin .

You should see your selected data groups being logged.

The most recent capture overwrites any existing capture.