Profiling Helper Tool

Use the Profiling Helper Tool to export profiling data from your Kanzi application in a format that is compatible with visualization tools, such as Google Chrome trace viewer and Perfetto UI.

Profiling data is often critical in understanding the overall flow of the application, in identifying bottlenecks, and in identifying optimization opportunities to improve performance. Kanzi Engine comes with a profiling functionality that enables measurements on the different parts of an application.

Kanzi Engine can provide information on startup performance, per frame performance of the application covering measuring, layouting and rendering phases, and resource profiling. Kanzi Engine generates data in a raw format and dumps into memory every measurement point, which can be stored in the file system. See Measuring application performance.

The Profiling Helper Tool helps you to gather profiling data and visualize it using visualization tools.

Note

This is a prerelease of the Profiling Helper Tool. Some functionality, workflows, and the API is going to change in the future releases of Kanzi.

Your feedback is very important to us. To send your questions, findings, and comments use the Kanzi Support Portal at support.rightware.com. When submitting a request regarding the Profiling Helper Tool, set the Product field to Profiling Helper Tool.

Requirements

Profiling Helper Tool works with all Kanzi 3.9 versions on all platforms that Kanzi supports.

For Kanzi 3.9 system requirements, see Installing Kanzi.

Converting profiling data from legacy format to a format compatible with Perfetto UI and Google Chrome trace viewer requires Python 3. See Using legacy profiling data output format.

Contents of the plugin package

Directory or file name	Description
Application/src/doc	Contains this documentation.
Application/src/plugin	Contains tool source code and CMake configuration files.
Application/src/executable	Contains example project source code and CMake configuration files.
Application/src/lib	Contains prebuilt binaries.
Application/generate_cmake_vs2017_solution.bat	Generates an example project with Profiling Helper Tool integrated for Visual Studio 2017.
Application/generate_cmake_vs2019_solution.bat	Generates an example project with Profiling Helper Tool integrated for Visual Studio 2019.
Application/bin	Contains a converter script (profiling2chrometrace.py) and the Profiling Helper Tool configuration file (profilinghelper.cfg).
Tool_project	Contains a Kanzi Studio example project that uses Profiling Helper Tool.
templates	Contains the project templates that you can use to create a Kanzi Studio project with Profiling Helper Tool.

Installing the plugin

To install the Profiling Helper Tool:

1. Extract the content of the package to the <KanziWorkspace>/Engine/plugins directory.

2. Copy the <KanziWorkspace>/Engine/plugins/profilinghelper/templates directory to the <KanziWorkspace>/Templates directory.

To learn how to create a project that uses the Profiling Helper Tool, see Getting started with Profiling Helper Tool.

To integrate the Profiling Helper Tool to existing projects, see Integration.

See also

Getting started with Profiling Helper Tool