feat: simplify kbench metrics to focus on key performance indicators

.github/workflows/build.yml

@@ -0,0 +1,93 @@
+name: build
+on:
+  push:
+    branches:
+    - master
+    - v*
+    tags:
+    - v*
+  pull_request:
+  workflow_dispatch:
+jobs:
+  build:
+    name: Build binaries
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Build binaries
+      run: make
+
+    - uses: codecov/codecov-action@v4
+      with:
+        files: ./coverage.out
+        flags: unittests
+        token: ${{ secrets.CODECOV_TOKEN }}
+
+    - name: Upload binaries
+      uses: actions/upload-artifact@v4
+      with:
+        name: binaries_artifact
+        path: ./bin/*
+
+  build_push_image:
+    name: Build and push image
+    runs-on: ubuntu-latest
+    needs: build
+    if: ${{ startsWith(github.ref, 'refs/heads/') || startsWith(github.ref, 'refs/tags/') }}
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Download binaries
+      uses: actions/download-artifact@v4
+      with:
+        name: binaries_artifact
+        path: ./bin/
+
+    - name: Add executable permission
+      run: |
+        chmod +x ./bin/*
+
+    - name: Copy bin folder to package
+      run: |
+        cp -r ./bin ./package/
+
+    # For multi-platform support
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v3
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+
+    - name: Declare branch
+      run: |
+        echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> "$GITHUB_ENV"
+
+    - name: Login to Docker Hub
+      uses: docker/login-action@v3
+      with:
+        username: ${{ secrets.DOCKER_USERNAME }}
+        password: ${{ secrets.DOCKER_PASSWORD }}
+
+    # longhornio/kbench image
+    - name: docker-publish
+      if: ${{ startsWith(github.ref, 'refs/heads/') }}
+      uses: docker/build-push-action@v5
+      with:
+        context: ./
+        push: true
+        platforms: linux/amd64,linux/arm64
+        tags: longhornio/kbench:${{ env.branch }}-head
+        file: package/Dockerfile
+
+    - name: docker-publish-with-tag
+      if: ${{ startsWith(github.ref, 'refs/tags/') }}
+      uses: docker/build-push-action@v5
+      with:
+        context: ./
+        push: true
+        platforms: linux/amd64,linux/arm64
+        tags: longhornio/kbench:${{ github.ref_name }}
+        file: package/Dockerfile
+

Dockerfile.dapper

@@ -1,9 +1,9 @@
-FROM golang:1.17-alpine
+FROM golang:1.23-alpine
 
 RUN apk -U add bash git gcc musl-dev docker vim less file curl wget ca-certificates
 
 ENV DAPPER_ENV REPO TAG
-ENV DAPPER_SOURCE /go/src/github.com/yasker/kbench/
+ENV DAPPER_SOURCE /go/src/github.com/longhorn/kbench/
 ENV DAPPER_OUTPUT ./bin
 ENV DAPPER_DOCKER_SOCKET true
 ENV HOME ${DAPPER_SOURCE}

README.md

@@ -14,17 +14,14 @@ QUICK MODE: DISABLED
 =====================
 IOPS (Read/Write)
         Random:            98368 / 89200
-    Sequential:          108513 / 107636
   CPU Idleness:                      68%
 
 Bandwidth in KiB/sec (Read/Write)
-        Random:          542447 / 514487
     Sequential:          552052 / 521330
   CPU Idleness:                      99%
 
 Latency in ns (Read/Write)
         Random:            97222 / 44548
-    Sequential:            40483 / 44690
   CPU Idleness:                      72%
 ```
 
@@ -39,17 +36,14 @@ QUICK MODE: DISABLED
                              850-pro-raw   vs             850-pro-ext4    :              Change
 IOPS (Read/Write)
         Random:          96,735 / 89,565   vs          98,135 / 88,990    :      1.45% / -0.64%
-    Sequential:        107,729 / 107,352   vs        110,843 / 107,805    :       2.89% / 0.42%
   CPU Idleness:                      68%   vs                      66%    :                 -2%
 
 Bandwidth in KiB/sec (Read/Write)
-        Random:        549,521 / 519,141   vs        549,610 / 511,755    :      0.02% / -1.42%
     Sequential:        551,825 / 522,936   vs        552,337 / 520,364    :      0.09% / -0.49%
   CPU Idleness:                      98%   vs                      98%    :                  0%
 
 Latency in ns (Read/Write)
         Random:          82,899 / 44,437   vs         114,331 / 45,104    :      37.92% / 1.50%
-    Sequential:          40,335 / 44,767   vs          41,741 / 45,271    :       3.49% / 1.13%
   CPU Idleness:                      72%   vs                      73%    :                  1%
 ```
 
@@ -109,26 +103,26 @@ By default:
 Step to deploy:
 1. One line to start benchmarking your default storage class:
     ```
-    kubectl apply -f https://raw.githubusercontent.com/yasker/kbench/main/deploy/fio.yaml
+    kubectl apply -f https://raw.githubusercontent.com/longhorn/kbench/main/deploy/fio.yaml
     ```
 1. Observe the Result:
     ```
     kubectl logs -l kbench=fio -f
     ```
 1. Cleanup:
     ```
-    kubectl delete -f https://raw.githubusercontent.com/yasker/kbench/main/deploy/fio.yaml
+    kubectl delete -f https://raw.githubusercontent.com/longhorn/kbench/main/deploy/fio.yaml
     ```
 
 Note: a single benchmark for FIO will take about 6 minutes to finish.
 
-See [./deploy/fio.yaml](https://github.com/yasker/kbench/blob/main/deploy/fio.yaml) for available options.
+See [./deploy/fio.yaml](https://github.com/longhorn/kbench/blob/main/deploy/fio.yaml) for available options.
 
 #### Deploy Comparison Benchmark in Kubernetes cluster
 
 1. Get a local copy of `fio-cmp.yaml`
     ```
-    wget https://raw.githubusercontent.com/yasker/kbench/main/deploy/fio-cmp.yaml
+    wget https://raw.githubusercontent.com/longhorn/kbench/main/deploy/fio-cmp.yaml
     ```
 1. Set the storage class for each volume you want to compare.
     * By default, it's `local-path` vs `longhorn`.
@@ -153,16 +147,16 @@ See [./deploy/fio.yaml](https://github.com/yasker/kbench/blob/main/deploy/fio.ya
 
 Note: a comparison benchmark for FIO will take about 12 minutes to finish.
 
-See [./deploy/fio-cmp.yaml](https://github.com/yasker/kbench/blob/main/deploy/fio-cmp.yaml) for available options.
+See [./deploy/fio-cmp.yaml](https://github.com/longhorn/kbench/blob/main/deploy/fio-cmp.yaml) for available options.
 
 #### Run Single Volume Benchmark as Container Locally
 
 ```
-docker run -v /volume yasker/kbench:latest /volume/test.img
+docker run -v /volume longhornio/kbench:latest /volume/test.img
 ```
 e.g.
 ```
-docker run -e "SIZE=100M" -v /volume yasker/kbench:latest /volume/test.img
+docker run -e "SIZE=100M" -v /volume longhornio/kbench:latest /volume/test.img
 ```
 
 #### Run Single Volume Benchmark as a Binary Locally

deploy/fio-cmp.yaml

@@ -40,35 +40,23 @@ spec:
     spec:
       containers:
       - name: kbench
-        image: yasker/kbench:latest
+        image: longhornio/kbench:latest
         imagePullPolicy: Always
         env:
 #        - name: MODE
 #          value: "quick" # for debugging
 #        - name: MODE
 #          value: "random-read-iops"
 #        - name: MODE
-#          value: "sequential-read-iops"
-#        - name: MODE
-#          value: "random-read-bandwidth"
-#        - name: MODE
 #          value: "sequential-read-bandwidth"
 #        - name: MODE
 #          value: "random-read-latency"
 #        - name: MODE
-#          value: "sequential-read-latency"
-#        - name: MODE
 #          value: "random-write-iops"
 #        - name: MODE
-#          value: "sequential-write-iops"
-#        - name: MODE
-#          value: "random-write-bandwidth"
-#        - name: MODE
 #          value: "sequential-write-bandwidth"
 #        - name: MODE
 #          value: "random-write-latency"
-#        - name: MODE
-#          value: "sequential-write-latency"
         - name: MODE
           value: "full" # run all tests
         - name: FIRST_VOL_NAME

deploy/fio.yaml

@@ -25,35 +25,23 @@ spec:
     spec:
       containers:
       - name: kbench
-        image: yasker/kbench:latest
+        image: longhornio/kbench:latest
         imagePullPolicy: Always
         env:
 #        - name: MODE
 #          value: "quick" # for debugging
 #        - name: MODE
 #          value: "random-read-iops"
 #        - name: MODE
-#          value: "sequential-read-iops"
-#        - name: MODE
-#          value: "random-read-bandwidth"
-#        - name: MODE
 #          value: "sequential-read-bandwidth"
 #        - name: MODE
 #          value: "random-read-latency"
 #        - name: MODE
-#          value: "sequential-read-latency"
-#        - name: MODE
 #          value: "random-write-iops"
 #        - name: MODE
-#          value: "sequential-write-iops"
-#        - name: MODE
-#          value: "random-write-bandwidth"
-#        - name: MODE
 #          value: "sequential-write-bandwidth"
 #        - name: MODE
 #          value: "random-write-latency"
-#        - name: MODE
-#          value: "sequential-write-latency"
         - name: MODE
           value: "full" # run all tests
         - name: FILE_NAME

fio/bandwidth-include.fio

@@ -0,0 +1,3 @@
+bs=128K
+iodepth=16
+numjobs=4

fio/bandwidth-quick.fio

@@ -1,19 +1,9 @@
-[rand-read-bw]
-readwrite=randread
-include bw-include.fio
-include quick-include.fio
-
-[rand-write-bw]
-readwrite=randwrite
-include bw-include.fio
-include quick-include.fio
-
-[seq-read-bw]
+[seq-read-bandwidth]
 readwrite=read
-include bw-include.fio
+include bandwidth-include.fio
 include quick-include.fio
 
-[seq-write-bw]
+[seq-write-bandwidth]
 readwrite=write
-include bw-include.fio
+include bandwidth-include.fio
 include quick-include.fio

fio/bandwidth-random-read.fio

@@ -1,4 +1,4 @@
-[rand-read-bw]
+[rand-read-bandwidth]
 readwrite=randread
-include bw-include.fio
-include common-include.fio
+include bandwidth-include.fio
+include common-include.fio

fio/bandwidth-random-write.fio

@@ -1,4 +1,4 @@
-[rand-write-bw]
+[rand-write-bandwidth]
 readwrite=randwrite
-include bw-include.fio
+include bandwidth-include.fio
 include common-include.fio

fio/bandwidth-sequential-read.fio

@@ -1,4 +1,4 @@
-[seq-read-bw]
+[seq-read-bandwidth]
 readwrite=read
-include bw-include.fio
-include common-include.fio
+include bandwidth-include.fio
+include common-include.fio

fio/bandwidth-sequential-write.fio

@@ -1,4 +1,4 @@
-[seq-write-bw]
+[seq-write-bandwidth]
 readwrite=write
-include bw-include.fio
+include bandwidth-include.fio
 include common-include.fio

fio/bandwidth.fio

@@ -1,19 +1,10 @@
-[rand-read-bw]
-readwrite=randread
-include bw-include.fio
-include common-include.fio
-
-[rand-write-bw]
-readwrite=randwrite
-include bw-include.fio
+[seq-write-bandwidth]
+readwrite=write
+include bandwidth-include.fio
 include common-include.fio
 
-[seq-read-bw]
+[seq-read-bandwidth]
 readwrite=read
-include bw-include.fio
+include bandwidth-include.fio
 include common-include.fio
 
-[seq-write-bw]
-readwrite=write
-include bw-include.fio
-include common-include.fio