Kanzi Monitor 1.40.0

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.

_images/kanzi-monitor.png

Features

Kanzi Monitor provides these features:

  • Profiling trace output compatible with the Perfetto trace viewer, including support for Kanzi engine-native kzTrace (Debug/Profiling builds)

  • Remote access over TCP sockets and serial ports (UART)

  • Diagnostic UI overlays

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

  • Performance analysis utilities

  • Overwatch remote inspection service with JSON-based introspection of the scene graph, resources, rendering, and performance

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

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

_images/architecture-overview.svg

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.

  • docs directory contains this documentation.

  • 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 Hub, in the Feature Packs, select your Kanzi Studio version and the platform on which you want to use Kanzi Monitor.

    _images/kanzi-hub-feature-packs-studio-version-platform.png

  2. Click Download to download and extract the Kanzi Monitor to the <KanziWorkspace>/Engine/plugins directory.

    _images/kanzi-hub-kanzi-monitor-download.png

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