Skip to main content
Redhat Developers  Logo
  • Products

    Featured

    • Red Hat Enterprise Linux
      Red Hat Enterprise Linux Icon
    • Red Hat OpenShift AI
      Red Hat OpenShift AI
    • Red Hat Enterprise Linux AI
      Linux icon inside of a brain
    • Image mode for Red Hat Enterprise Linux
      RHEL image mode
    • Red Hat OpenShift
      Openshift icon
    • Red Hat Ansible Automation Platform
      Ansible icon
    • Red Hat Developer Hub
      Developer Hub
    • View All Red Hat Products
    • Linux

      • Red Hat Enterprise Linux
      • Image mode for Red Hat Enterprise Linux
      • Red Hat Universal Base Images (UBI)
    • Java runtimes & frameworks

      • JBoss Enterprise Application Platform
      • Red Hat build of OpenJDK
    • Kubernetes

      • Red Hat OpenShift
      • Microsoft Azure Red Hat OpenShift
      • Red Hat OpenShift Virtualization
      • Red Hat OpenShift Lightspeed
    • Integration & App Connectivity

      • Red Hat Build of Apache Camel
      • Red Hat Service Interconnect
      • Red Hat Connectivity Link
    • AI/ML

      • Red Hat OpenShift AI
      • Red Hat Enterprise Linux AI
    • Automation

      • Red Hat Ansible Automation Platform
      • Red Hat Ansible Lightspeed
    • Developer tools

      • Red Hat Trusted Software Supply Chain
      • Podman Desktop
      • Red Hat OpenShift Dev Spaces
    • Developer Sandbox

      Developer Sandbox
      Try Red Hat products and technologies without setup or configuration fees for 30 days with this shared Openshift and Kubernetes cluster.
    • Try at no cost
  • Technologies

    Featured

    • AI/ML
      AI/ML Icon
    • Linux
      Linux Icon
    • Kubernetes
      Cloud icon
    • Automation
      Automation Icon showing arrows moving in a circle around a gear
    • View All Technologies
    • Programming Languages & Frameworks

      • Java
      • Python
      • JavaScript
    • System Design & Architecture

      • Red Hat architecture and design patterns
      • Microservices
      • Event-Driven Architecture
      • Databases
    • Developer Productivity

      • Developer productivity
      • Developer Tools
      • GitOps
    • Secure Development & Architectures

      • Security
      • Secure coding
    • Platform Engineering

      • DevOps
      • DevSecOps
      • Ansible automation for applications and services
    • Automated Data Processing

      • AI/ML
      • Data Science
      • Apache Kafka on Kubernetes
      • View All Technologies
    • Start exploring in the Developer Sandbox for free

      sandbox graphic
      Try Red Hat's products and technologies without setup or configuration.
    • Try at no cost
  • Learn

    Featured

    • Kubernetes & Cloud Native
      Openshift icon
    • Linux
      Rhel icon
    • Automation
      Ansible cloud icon
    • Java
      Java icon
    • AI/ML
      AI/ML Icon
    • View All Learning Resources

    E-Books

    • GitOps Cookbook
    • Podman in Action
    • Kubernetes Operators
    • The Path to GitOps
    • View All E-books

    Cheat Sheets

    • Linux Commands
    • Bash Commands
    • Git
    • systemd Commands
    • View All Cheat Sheets

    Documentation

    • API Catalog
    • Product Documentation
    • Legacy Documentation
    • Red Hat Learning

      Learning image
      Boost your technical skills to expert-level with the help of interactive lessons offered by various Red Hat Learning programs.
    • Explore Red Hat Learning
  • Developer Sandbox

    Developer Sandbox

    • Access Red Hat’s products and technologies without setup or configuration, and start developing quicker than ever before with our new, no-cost sandbox environments.
    • Explore Developer Sandbox

    Featured Developer Sandbox activities

    • Get started with your Developer Sandbox
    • OpenShift virtualization and application modernization using the Developer Sandbox
    • Explore all Developer Sandbox activities

    Ready to start developing apps?

    • Try at no cost
  • Blog
  • Events
  • Videos

Troubleshooting application performance with Red Hat OpenShift metrics, Part 3: Collecting runtime metrics

July 22, 2021
Pavel Macik
Related topics:
KubernetesOperators
Related products:
Developer SandboxRed Hat OpenShift

Share:

    This is the third article in series showing how to use metrics from Red Hat OpenShift to reveal application performance problems. In Part 1, I explained the environment and requirements for our application, the Service Binding Operator. In Part 2, I showed you how to set up a test environment in the Developer Sandbox for Red Hat OpenShift and introduced the test scenarios. Now, we can start to focus on the metrics themselves.

    Read the whole series:

    • Part 1: Performance requirements
    • Part 2: The test environment
    • Part 3: Collecting runtime metrics
    • Part 4: Gathering performance metrics
    • Part 5: Test rounds and results

    Collecting runtime metrics with the OpenShift monitoring tool

    To see what is going on with Service Binding Operator and the OpenShift cluster under heavy load, it is important to collect metrics for the duration of the test. OpenShift's monitoring tool, a combination of Prometheus and Grafana with predefined, out-of-the-box metrics, can collect the necessary data for the lifespan of the cluster. At first, it seems an ideal solution to simply use that feature, let the monitoring stack gather the data normally, and collect it after the test is done. The problem is that all of the monitoring tools—the Prometheus and Graphana instances—are deployed on the same cluster as the application they're monitoring, including the OpenShift cluster's own resources. So, if the cluster goes down (which we expect to happen while stress testing), the monitoring subsystem goes down along with it, and all the gathered data is lost. Keep in mind that we are using a temporary development cluster that is terminated after about 10 hours anyway.

    To ensure results are preserved on a node that won't crash, I've created the following collector script. It uses the OpenShift Client tool (oc) to pull the runtime metrics every 30 seconds or so for the duration of the test and stores it in a set of simple CSV files, one for nodes and one for each monitored pod. I start the script in the background before the user provisioning starts in order to catch the "before" state, and leave the script running for some time after the load generation ends to see the long-term behavior of the watched resources:

    PERIOD="${1:-30}"
    RESULTS=${2:-metrics-$(date "+%F_%T")}
    
    mkdir -p "$RESULTS"
    
    strip_unit(){
        echo -n $1 | sed -e 's,\([0-9]\+\)m,\1,g' | sed -e 's,\([0-9]\+\)Mi,\1,g' | sed -e 's,\([0-9]\+\)%,\1,g'
    }
    
    # Nodes
    oc get nodes > $RESULTS/nodes.yaml
    oc describe nodes > $RESULTS/nodes.info
    
    node_info_file(){
        readlink -m "$RESULTS/node-info.$1.csv"
    }
    
    node_line(){
        node=$1
        node_json="$(oc get node $node -o json)"
        echo -n "$(echo "$node_json" | jq -rc '.status.conditions[] | select(.type=="MemoryPressure").status');"
        echo -n "$(echo "$node_json" | jq -rc '.status.conditions[] | select(.type=="DiskPressure").status');"
        echo -n "$(echo "$node_json" | jq -rc '.status.conditions[] | select(.type=="PIDPressure").status');"
        echo -n "$(echo "$node_json" | jq -rc '.status.conditions[] | select(.type=="Ready").status');"
        node_info=($(oc adm top node $node --no-headers))
        echo -n "$(strip_unit ${node_info[1]});"
        echo -n "$(strip_unit ${node_info[2]});"
        echo -n "$(strip_unit ${node_info[3]});"
        echo "$(strip_unit ${node_info[4]})"
    }
    
    NODES=($(oc get nodes -o json | jq -rc '.items[].metadata.name' | sort))
    for node in "${NODES[@]}"; do
        echo "Time;MemoryPressure;DiskPressure;PIDPressure;Ready;CPU_millicores;CPU_percent;Memory_MiB;Memory_percent" > $(node_info_file $node)
    done
    
    # Operator pods
    pod_info_file(){
        readlink -m "$RESULTS/pod-info.$1.csv"
    }
    
    pod_line(){
        pod=$1
        ns=$2
        pod_info=($(oc adm top pod $pod -n $ns --no-headers))
        echo -n "$(strip_unit ${pod_info[1]});"
        echo "$(strip_unit ${pod_info[2]})"
    }
    
    for namespace in openshift-operators openshift-monitoring openshift-apiserver openshift-kube-apiserver openshift-sdn openshift-operator-lifecycle-manager service-binding-operator; do
        PODS=($(oc get pods -n $namespace -o json | jq -rc '.items[].metadata.name' | grep -E 'operator|prometheus|apiserver|sdn|ovs|olm|packageserver' | sort))
        for pod in "${PODS[@]}"; do
            echo "Time;CPU_millicores;Memory_MiB" > $(pod_info_file $pod)
        done
    done
    
    echo "Collecting metrics"
    # Periodical collection
    while true; do
        echo -n "."
        for namespace in openshift-operators openshift-monitoring openshift-apiserver openshift-kube-apiserver openshift-sdn openshift-operator-lifecycle-manager service-binding-operator; do
            PODS=($(oc get pods -n $namespace -o json | jq -rc '.items[].metadata.name' | grep -E 'operator|prometheus|apiserver|sdn|ovs|olm|packageserver' | sort))
            for pod in "${PODS[@]}"; do
                pod_file=$(pod_info_file $pod)
                echo -n "$(date -u '+%F %T.%N');" >> $pod_file
                pod_line $pod $namespace >> $pod_file
            done
        done
        for node in ${NODES[@]}; do
            node_file=$(node_info_file $node)
            echo -n "$(date -u '+%F %T.%N');" >> $node_file
            node_line $node >> $node_file
        done
        sleep ${PERIOD}s
    done
    

    If the cluster survives the entire duration of the stress test, we can use Grafana to download the collected data from Prometheus in a form of similar CSV files.

    Compiling a performance report

    Since these tests were arranged pretty quickly and the metrics were collected in the raw form of CSV files, I had to manually convert the data into charts to put them into perspective. I used Google Sheets for that purpose.

    Next steps

    Finally, we have all the infrastructure we need for performance testing. In the next article, we will take our first look at the actual metrics and how they are gathered.

    Read next: Part 4: Gathering performance metrics.

    Last updated: January 15, 2025

    Related Posts

    • Troubleshooting application performance with Red Hat OpenShift metrics, Part 2: The test environment

    • Generate automated Grafana metrics dashboards for MicroProfile apps

    Recent Posts

    • More Essential AI tutorials for Node.js Developers

    • How to run a fraud detection AI model on RHEL CVMs

    • How we use software provenance at Red Hat

    • Alternatives to creating bootc images from scratch

    • How to update OpenStack Services on OpenShift

    Red Hat Developers logo LinkedIn YouTube Twitter Facebook

    Products

    • Red Hat Enterprise Linux
    • Red Hat OpenShift
    • Red Hat Ansible Automation Platform

    Build

    • Developer Sandbox
    • Developer Tools
    • Interactive Tutorials
    • API Catalog

    Quicklinks

    • Learning Resources
    • E-books
    • Cheat Sheets
    • Blog
    • Events
    • Newsletter

    Communicate

    • About us
    • Contact sales
    • Find a partner
    • Report a website issue
    • Site Status Dashboard
    • Report a security problem

    RED HAT DEVELOPER

    Build here. Go anywhere.

    We serve the builders. The problem solvers who create careers with code.

    Join us if you’re a developer, software engineer, web designer, front-end designer, UX designer, computer scientist, architect, tester, product manager, project manager or team lead.

    Sign me up

    Red Hat legal and privacy links

    • About Red Hat
    • Jobs
    • Events
    • Locations
    • Contact Red Hat
    • Red Hat Blog
    • Inclusion at Red Hat
    • Cool Stuff Store
    • Red Hat Summit

    Red Hat legal and privacy links

    • Privacy statement
    • Terms of use
    • All policies and guidelines
    • Digital accessibility

    Report a website issue