x4Trace Documentation
Welcome to the official x4Trace Documentation.
This documentation describes the public interfaces, extension points, and user-facing behavior of the x4Trace system.
It is intended for developers, system integrators, and advanced users who work with x4Trace in production or development environments.
What you will find here
📘 API Reference
Detailed API documentation generated directly from the source code.
This section covers:
- Public interfaces and contracts
- Data structures and constants
- Extension points for custom development
Use this section when you are implementing integrations, drivers, plugins, or extensions.
🖥 GUI Documentation
Documentation related to the graphical user interface.
This section explains:
- How to use the x4Trace desktop and server UI
- Configuration workflows
- Screens, dialogs, and their behavior
Use this section if you want to understand how the system behaves from a user’s perspective.
🖧 Server Documentation
Documentation for server-side components and services.
This section includes:
- Server architecture and responsibilities
- Server-side APIs
- Service configuration and lifecycle
Use this section when working with the x4Trace server, services, or backend integrations.
Scope of this documentation
This documentation intentionally focuses on stable, supported, and public parts of the system.
Internal implementation details and core components that are not part of the public API are not documented here and may change without notice.
Getting started
- If you are new to x4Trace, start with the GUI section.
- If you are developing integrations or extensions, go directly to the API Reference.
- If you are deploying or operating x4Trace, see the Server section.
x4Trace is designed to be modular, extensible, and transparent in its behavior.
This documentation aims to reflect those principles.