Module Details

When a module is selected in the Device Tree, the Monitoring UI displays detailed runtime and configuration information for that module. This view helps understand how a specific module is operating, how it was deployed, and whether it supports advanced features like logging, command execution or other functionality.

The module details page has different tabs. The default tab is the "Information" page, which contains information grouped into the following sections:

Module Information

This section displays core runtime metadata and capabilities:

  • Module Name The name of the module instance deployed to the device.

  • Restart Policy Defines how the module is restarted by the runtime in case of failure or manual stop:

    • always: automatically restarts on exit

    • on-failure: restarts only on non-zero exit

    • never: does not restart automatically

  • Nexus SDK Supported Indicates whether the module is built using the Nexus Device SDK. If True, additional features such as log streaming and remote command execution are available.

  • Runtime Status The current operational state of the module (e.g., running, stopped, error).


Module Container

Describes the container image used to run the module:

  • Image URI The full registry path of the container image (e.g., mcr.microsoft.com/azure-blob-storage:1.4).

  • Version The version tag of the image.

  • Image Type The containerization technology used. Currently only Docker-compatible is supported.

  • Image Pull Policy Defines when the image is pulled from the registry:

    • always: always pull the latest version

    • on-create: pull only when the module is created

    • if-not-present: pull only if the image is not already cached on the device


Module Lifecycle

Provides information related to the module’s operation:

  • Last Start Time The most recent time the module was started.

  • Last Restart Time The last time the module was automatically or manually restarted.

  • Last Exit Time When the module last stopped running (due to completion, crash, or restart).

  • Last Exit Code The exit code from the most recent module shutdown. This is useful for diagnosing abnormal terminations.


Resource Metrics

This section provides time-series visualizations of the module's system resource usage, given that the module supports the Nexus SDK. These metrics are collected and reported by the module if it is built using the Nexus SDK.

The charts help operators monitor system resources as trends to identify performance bottlenecks, such as memory leaks or CPU overload. Metrics include:

  • CPU Utilization (P99) Displays the 99th percentile of CPU usage over time, highlighting peak load behavior rather than average usage. This is useful for identifying resource spikes and understanding worst-case performance.

  • Memory Usage Shows both used and total memory (in gigabytes), allowing you to assess how much RAM is available and whether the device is under memory pressure.

📊 These charts support configurable time windows, making it easier to correlate resource usage with recent events or issues.

Last updated

Was this helpful?