1. Documentation
×

Reviewing monitoring dashboards

OKD 4 provides a comprehensive set of monitoring dashboards that help you understand the state of cluster components and user-defined workloads.

Use the Administrator perspective to access dashboards for the core OKD components, including the following items:

  • API performance

  • etcd

  • Kubernetes compute resources

  • Kubernetes network resources

  • Prometheus

  • USE method dashboards relating to cluster and node performance

  • Node performance metrics

monitoring dashboard administrator
Figure 1. Example dashboard in the Administrator perspective

Use the Developer perspective to access Kubernetes compute resources dashboards that provide the following application metrics for a selected project:

  • CPU usage

  • Memory usage

  • Bandwidth information

  • Packet rate information

observe dashboard developer
Figure 2. Example dashboard in the Developer perspective

In the Developer perspective, you can view dashboards for only one project at a time.

Reviewing monitoring dashboards as a cluster administrator

In the Administrator perspective, you can view dashboards relating to core OKD cluster components.

Prerequisites

  • You have access to the cluster as a user with the cluster-admin cluster role.

Procedure

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

  2. Choose a dashboard in the Dashboard list. Some dashboards, such as etcd and Prometheus dashboards, produce additional sub-menus when selected.

  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. Input or select the From and To dates and times.

      2. Click Save to save the custom time range.

  4. Optional: Select a Refresh Interval.

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

Reviewing monitoring dashboards as a developer

In the Developer perspective, you can view dashboards relating to a selected project. You must have access to monitor a project to view dashboard information for it.

Prerequisites

  • You have access to the cluster as a developer or as a user.

  • You have view permissions for the project that you are viewing the dashboard for.

Procedure

  1. In the Developer perspective in the OKD web console, navigate to Observe → Dashboard.

  2. Select a project from the Project: drop-down list.

  3. Select a dashboard from the Dashboard drop-down list to see the filtered metrics.

    All dashboards produce additional sub-menus when selected, except Kubernetes / Compute Resources / Namespace (Pods).

  4. 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. Input or select the From and To dates and times.

      2. Click Save to save the custom time range.

  5. Optional: Select a Refresh Interval.

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

Additional resources

Next steps