feat: simplify kbench metrics to focus on key performance indicators #15
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|
|
||
|
Comment on lines
+73
to
+83
There was a problem hiding this comment. 🛠️ Refactor suggestion Consider enhancing image tag for better traceability. The Docker image build and push step for branches is well-configured with multi-platform support. However, the current tagging strategy can be improved. Consider adding a timestamp or short commit hash to the image tag for better traceability. This can help identify exactly which commit the image was built from. Here's a suggested improvement: - name: Set image tag
run: |
echo "IMAGE_TAG=${{ env.branch }}-$(date +%Y%m%d%H%M%S)-${GITHUB_SHA::8}" >> $GITHUB_ENV
- name: Build and push Docker image
uses: docker/build-push-action@v5
with:
context: ./
push: true
platforms: linux/amd64,linux/arm64
tags: longhornio/kbench:${{ env.IMAGE_TAG }}
file: package/DockerfileThis will create a tag like |
||
| - 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 | ||
|
|
||
|
Comment on lines
+84
to
+93
There was a problem hiding this comment. 🛠️ Refactor suggestion Enhance tagging strategy for release versions. The Docker image build and push step for tags is well-configured, but the tagging strategy can be improved to provide more flexibility for users. Consider the following enhancements:
Here's a suggested improvement: - name: Generate Docker tags
if: startsWith(github.ref, 'refs/tags/')
run: |
VERSION=${GITHUB_REF#refs/tags/v}
MAJOR=${VERSION%%.*}
MINOR=${VERSION%.*}
echo "DOCKER_TAGS=longhornio/kbench:latest,longhornio/kbench:${VERSION},longhornio/kbench:${MINOR},longhornio/kbench:${MAJOR}" >> $GITHUB_ENV
- name: Build and push Docker image for tags
if: startsWith(github.ref, 'refs/tags/')
uses: docker/build-push-action@v5
with:
context: ./
push: true
platforms: linux/amd64,linux/arm64
tags: ${{ env.DOCKER_TAGS }}
file: package/DockerfileThis will create tags like |
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| bs=128K | ||
| iodepth=16 | ||
| numjobs=4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,9 @@ | ||
| [seq-read-bandwidth] | ||
| readwrite=read | ||
| include bandwidth-include.fio | ||
| include quick-include.fio | ||
|
|
||
| [seq-write-bandwidth] | ||
| readwrite=write | ||
| include bandwidth-include.fio | ||
| include quick-include.fio |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| [rand-read-bandwidth] | ||
| readwrite=randread | ||
| include bandwidth-include.fio | ||
| include common-include.fio |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| [rand-write-bandwidth] | ||
| readwrite=randwrite | ||
| include bandwidth-include.fio | ||
| include common-include.fio |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| [seq-read-bandwidth] | ||
| readwrite=read | ||
| include bandwidth-include.fio | ||
| include common-include.fio |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| [seq-write-bandwidth] | ||
| readwrite=write | ||
| include bandwidth-include.fio | ||
| include common-include.fio |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,10 @@ | ||
| [seq-write-bandwidth] | ||
| readwrite=write | ||
| include bandwidth-include.fio | ||
| include common-include.fio | ||
|
|
||
| [seq-read-bandwidth] | ||
| readwrite=read | ||
| include bandwidth-include.fio | ||
| include common-include.fio | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Consider refining the build job for better specificity and efficiency.
The build job covers essential steps, but there are opportunities for improvement:
The
makecommand is used without a specific target. Consider specifying the exact target(s) needed for the build to ensure consistency and avoid unnecessary work.The artifact upload step includes all files in
./bin/. To optimize storage and download times, consider being more selective about which files are uploaded.Here's a suggested improvement for the 'Build binaries' step:
And for the 'Upload binaries' step:
This will ensure only the necessary binaries are uploaded as artifacts.