OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history
×

Monitoring OpenShift sandboxed containers

You can use the OpenShift Container Platform web console to monitor metrics related to the health status of your sandboxed workloads and nodes.

OpenShift sandboxed containers has a pre-configured dashboard available in the web console, and administrators can also access and query raw metrics through Prometheus.

About OpenShift sandboxed containers metrics

OpenShift sandboxed containers metrics enable administrators to monitor how their sandboxed containers are running. You can query for these metrics in Metrics UI in the web console.

OpenShift sandboxed containers metrics are collected for the following categories:

Kata agent metrics

Kata agent metrics display information about the kata agent process running in the VM embedded in your sandboxed containers. These metrics include data from /proc/<pid>/[io, stat, status].

Kata guest OS metrics

Kata guest OS metrics display data from the guest OS running in your sandboxed containers. These metrics include data from /proc/[stats, diskstats, meminfo, vmstats] and /proc/net/dev.

Hypervisor metrics

Hypervisor metrics display data regarding the hypervisor running the VM embedded in your sandboxed containers. These metrics mainly include data from /proc/<pid>/[io, stat, status].

Kata monitor metrics

Kata monitor is the process that gathers metric data and makes it available to Prometheus. The kata monitor metrics display detailed information about the resource usage of the kata-monitor process itself. These metrics also include counters from Prometheus data collection.

Kata containerd shim v2 metrics

Kata containerd shim v2 metrics display detailed information about the kata shim process. These metrics include data from /proc/<pid>/[io, stat, status] and detailed resource usage metrics.

Viewing metrics for OpenShift sandboxed containers

You can access the metrics for OpenShift sandboxed containers in the Metrics page in the web console.

Prerequisites

  • You have OpenShift Container Platform 4.11 installed.

  • You have OpenShift sandboxed containers installed.

  • You have access to the cluster as a user with the cluster-admin role or with view permissions for all projects.

Procedure

  1. From the Administrator perspective in the web console, navigate to Observe → Metrics.

  2. In the input field, enter the query for the metric you want to observe.

    All kata-related metrics begin with kata. Typing kata will display a list with all of the available kata metrics.

The metrics from your query are visualized on the page.

Additional resources

  • For more information about creating PromQL queries to view metrics, see Querying metrics.

Viewing the OpenShift sandboxed containers dashboard

You can access the OpenShift sandboxed containers dashboard in the Dashboards page in the web console.

Prerequisites

  • You have OpenShift Container Platform 4.11 installed.

  • You have OpenShift sandboxed containers installed.

  • You have access to the cluster as a user with the cluster-admin role or with view permissions for all projects.

Procedure

  1. From the Administrator perspective in the web console, navigate to Observe → Dashboards.

  2. From the Dashboard drop-down list, select the Sandboxed Containers dashboard.

  3. Optional: Select a time range for the graphs in the Time Range list.

    • Select a pre-defined time period.

    • Set a custom time range by selecting Custom time range in the Time Range list.

      1. Define the date and time range for the data you want to view.

      2. Click Save to save the custom time range.

  4. Optional: Select a Refresh Interval.

The dashboard appears on the page with the following metrics from the Kata guest OS category:

Number of running VMs

Displays the total number of sandboxed containers running on your cluster.

CPU Usage (per VM)

Displays the CPU usage for each individual sandboxed container.

Memory Usage (per VM)

Displays the memory usage for each individual sandboxed container.

Hover over each of the graphs within a dashboard to display detailed information about specific items.

Additional resources