Functional Explanation
System Metrics provides a live operational overview of the application and its connected components. It is organized into sections covering KPI tiles, internal services, redundancy state, and communication driver status. Engineers and administrators use this page to verify system health, monitor execution times, and identify performance or connectivity issues.
System Metrics refreshes automatically. It is accessible to Administrators only.
KPI Tiles
The top section shows KPI tiles with key system counters and timing values at a glance, such as total variable count, active alarm count, and execution timing.
Services Section
The Services section shows the runtime state and execution timing of the internal system services. Each service can be individually restarted from this page.
Redundancy Section
The Redundancy section shows the current primary-standby state when redundancy is enabled. It displays the local and partner node roles, synchronization state, participant numbers, and any synchronization lag.
Communication Driver Sections
Each configured communication driver has its own section showing the state of each device and its variables.
Messaging and forwarding
The Messaging and forwarding panel lists one row per MQTT client, MQTT device, Kafka device, MQTT publisher, and data forwarder. The MQTT devices are listed under their MQTT client. The number next to the panel title counts the MQTT clients, Kafka devices, MQTT publishers, and data forwarders. The right side of the panel header shows the state of the embedded MQTT broker with its number of clients and of the OPC UA server with its number of sessions.
| Column | Description |
|---|---|
| Connection | Name of the MQTT client, MQTT device, Kafka device, MQTT publisher, or data forwarder. The line under the name shows details of the row. |
| Type | MQTT client, MQTT device, Kafka, MQTT publisher, or Data forwarder. |
| Status | Current state of the row. |
| Queue | MQTT client: messages waiting to be published. Kafka: messages waiting to be produced. MQTT publisher: linked variables waiting to be published. |
| Variables | MQTT device: variables of the device. Kafka and MQTT publisher: enabled variables linked to it through the Kafka Device or MQTT Publisher field of the variable. |
| Cycle | MQTT client and data forwarder: duration of the last cycle. Kafka: duration of the last produce cycle. |
No rows match the filter.
The rows of MQTT clients and Kafka devices carry a Restart device button, which is available for enabled rows on the primary server. Kafka and MQTT publisher rows show the following details under the name, and the following states:
| Type | Details | States |
|---|---|---|
| Kafka | Duration of the last produce cycle and of the last consume cycle. | Connected: every active client reached the broker. Disconnected: a configured producer or consumer is not connected. Idle: Producer Topic or Produce Format is empty and Consumer is off, so no client runs. Error: a configured client cannot start. Disabled. Standby on the standby server. |
| MQTT publisher | Broker URL and Port, with TLS when Use TLS is on, the number of published messages, the time since the last publish, and the last error. | Connected, Connecting, Reconnecting, Disabled, and Standby on the standby server. |
No rows match the filter.
On the primary server, the health summary at the top of the page lists an issue for every enabled row of this panel that needs action. On the standby server, MQTT clients, Kafka devices, and MQTT publishers are in the Standby state by design and raise no issue. Select an issue to scroll to the panel. The messaging issues are:
- MQTT publisher [name] [state]: an enabled MQTT publisher that is not connected, for example while it is Connecting or Reconnecting. It counts as an item that needs attention.
- Kafka [name] disconnected: an enabled Kafka device with a configured producer or consumer that is not connected to the broker. It counts as an item that needs attention. A Kafka device in the Idle state runs no client and raises no issue.
- Kafka device [name] has a configuration error, followed by the reason: a configured client of the Kafka device cannot start, for example because Consumer is on and Group Id is empty. It counts as an item that needs attention.
- Kafka [name] queue [count]: 10000 or more messages are waiting to be produced. It is listed as a notice.
- MQTT client [name] [state]: an enabled MQTT client that is not connected. It counts as an item that needs attention.
- [name] timed out: an enabled MQTT device that has timed out. It is listed as a notice.
- Forwarder [name] in error and Forwarder [name] stopped: an enabled data forwarder in the Error or Stopped state. The first counts as an item that needs attention, the second is listed as a notice.
System Section
The System section shows host-level information including Docker status, computer name, operating system, OS version, manufacturer, and metrics service execution time.
Notes
Execution times shown in the Services and driver sections reflect how long each cycle takes. Elevated execution times may indicate a performance issue or an overloaded component.
The Restart button on each service card stops and restarts that service only. Use it during diagnostics when a service must be reset without restarting the full application.
System Metrics is a diagnostic and support tool. It is not intended for use as a normal operator screen.