Skip to main content

KPI Manager

Config and stream KPI metrics from the robot in real time.

nimbus kpi <command>
CommandDescription
monitor-updatesDisplays live agent metric emissions from the shared periodic cadence and dynamic update surface, including periodic telemetry, component/runtime state, config state, NAV2, recordings, task status, agent operational state, and custom user KPI metrics
export-user-kpi-config <path>Export current user Kpi config to a JSON file
import-user-kpi-config <path>Import user Kpi config from a JSON file and apply it

Example

nimbus kpi monitor-updates

→ Streams the metrics emitted through the agent periodic/dynamic monitor surface, including:

Appendix: monitor-updates metrics​

CPU​

Metric type: SystemMetricType.Cpu
Properties shown: CPU usage percentage.

RAM​

Metric type: SystemMetricType.Ram
Properties shown: RAM usage percentage.

Disk​

Metric type: SystemMetricType.Disk
Properties shown: Disk usage.

Network​

Metric type: SystemMetricType.Network
Properties shown: Total uploaded KB and total downloaded KB.

GPU​

Metric type: SystemMetricType.Gpu
Properties shown: Detected GPU devices and their reported information.

Ping​

Metric type: SystemMetricType.Ping
Properties shown: Ping latency in milliseconds.

Wi-Fi​

Metric type: SystemMetricType.Wifi
Properties shown: Network name, bitrate, and signal strength.

Thermal​

Metric type: SystemMetricType.Thermal
Properties shown: Maximum reported temperature across thermal sensors.

Devices​

Metric type: SystemMetricType.Devices Properties shown: Number of USB/device entries.

Components​

Metric type: SystemMetricType.Components Properties shown: Number of component entries, including environment stats when the periodic component-stats cadence emits them.

Recordings​

Metric type: SystemMetricType.Recordings Properties shown: Number of recorder status entries.

Configuration​

Metric type: SystemMetricType.Configuration
Properties shown: Active configuration information.

ROS Configuration​

Metric type: SystemMetricType.RosConfig
Properties shown: ROS master URI, ROS IP, and ROS 2 domain ID.

User KPI Settings​

Metric type: SystemMetricType.UserKpiSettingsConfig Properties shown: Number of configured user KPI settings.

Security​

Metric type: SystemMetricType.Security
Properties shown: Whether HTTP is blocked, USB storage is blocked, Wi-Fi is disabled, and Bluetooth is disabled.

Recording Profile​

Metric type: SystemMetricType.RecordingProfileConfig
Properties shown: Number of CSV and video recorders, plus recorder details such as auto-recording, stream count, max file size, id, alias, and source type.

Task Catalog​

Metric type: SystemMetricType.TaskManagerConfig Properties shown: Task count and up to eight task summaries with name, id, enabled state, subtask count, and trigger count.

Task Run Status​

Metric type: SystemMetricType.TaskRunStatusList Properties shown: Latest-known task run start, current subtask, cancellation request, and terminal state entries from the aggregate status list.

Agent Operational State​

Metric type: SystemMetricType.AgentOperationalState
Properties shown: Agent status and version.

Metric type: SystemMetricType.Nav2 Properties shown: Latest NAV2 status update payload.

Resources Storage​

Metric type: SystemMetricType.ResourcesStorage Properties shown: Configured resources storage provider, local resources quota, provider-specific details such as bucket name, region, masked credentials, local disk size, and used bytes.

Docker Registry​

Metric type: SystemMetricType.DockerRegistryConfig
Properties shown: Configured registry entries including URL, username, and masked password.

Notification Settings​

Metric type: SystemMetricType.NotificationSettingsConfig Properties shown: Notification settings configuration summary.

Custom User KPI​

Metric type: SystemMetricType.Custom
Properties shown: KPI name, status, source stream, field, aggregation function, and current value.