Kanzi Monitor 1.41.3

Kanzi Monitor is a Kanzi Engine plugin that extends Kanzi applications with real-time profiling, remote debugging, and runtime inspection tools. With Kanzi Monitor you can collect profiling traces, interact with the application through a command-line interface, and render diagnostic overlays. You can also capture log messages, monitor performance metrics, and remotely inspect the scene graph through the Overwatch service and the Monitor Web UI. From the console you can change the running application without rebuilding the project: set property values, dispatch messages, and build test scenes from nodes, node components, and resources.

Features

Kanzi Monitor provides these features:

• Remote access over TCP sockets, with several clients connected at once, and over serial ports (UART)

• Overwatch remote inspection service with JSON-based introspection of the scene graph, resources, rendering, and performance. It also sets property values and dispatches messages to nodes, and addresses every node and resource by a stable handle

• NodeTree service that creates, instantiates, moves, detaches, and destroys nodes, and adds node components, in the running application

• Resource service that creates resources in the running application, including font families with fallbacks for CJK and emoji

• Profiling trace output compatible with the Perfetto trace viewer, with per-category control, a span for every Monitor command, and support for Kanzi engine-native kzTrace (Debug/Profiling builds)

• GPU timestamp dump of per-frame and per-render-pass GPU timings

• Capture service that records a bounded sequence of screen frames into memory as a keep-last-N ring, so you can replay what led up to an event

• Debug service with property breakpoints that break, log, capture a screenshot, or run a console command when a node property reaches a value

• Logger with support for on-screen presentation and console access

• Performance analysis utilities

• Diagnostic UI overlays

• Monitor Web UI, a browser-based GUI for remote debugging through the Overwatch service

• MCP server that exposes Kanzi Monitor console commands as structured tools for AI assistants such as Claude Code and Claude Desktop

Requirements

Kanzi Monitor has similar platform support as the equivalent release of Kanzi. For a full list of supported Kanzi platforms and requirements, see the Kanzi Engine Platform requirements, or the equivalent page for the Kanzi version you are using in your project.

Contents of the plugin package

The Kanzi Monitor package contains:

• cmake directory contains CMake configuration files for integrating Kanzi Monitor into your project.

• configs directory contains platform-specific configuration files for Android, Linux, and QNX targets.

• doc directory contains this documentation as offline HTML — open doc/html/index.html in a browser.

• examples directory contains example projects that demonstrate how to use Kanzi Monitor.

• include directory contains the public C++ header files for the Kanzi Monitor API.

• lib directory contains prebuilt libraries for supported platforms.

• scripts directory contains build and utility scripts.

• src directory contains the Kanzi Monitor source code.

• tools directory contains the RemoteConsoleClient, SerialConsoleClient, Monitor Web UI, and MCP server.

• kanzimonitor.cfg is the default configuration file for the plugin.

Installing Kanzi Monitor

To install Kanzi Monitor:

1. In Kanzi Portal, on the Studio tab select the Kanzi Studio version on which you want to use Kanzi Monitor.

   

2. Select the Feature Packs tab and on the Kanzi Monitor card, click Download.

   

3. Extract the content of the downloaded zip archive of the Kanzi Monitor to the <KanziWorkspace>/Engine/plugins directory.

After you install Kanzi Monitor, to learn how to start using Kanzi Monitor, see Getting started with Kanzi Monitor.

See also

Integrating Kanzi Monitor into existing projects

Working with Kanzi Monitor services

Working with Kanzi Monitor tools