{"id":50385112,"url":"https://github.com/stackhpc/stackhpc-io-tools","last_synced_at":"2026-05-30T14:31:00.050Z","repository":{"id":51305540,"uuid":"154692707","full_name":"stackhpc/stackhpc-io-tools","owner":"stackhpc","description":"Tools for running and post-processing fio benchmark data.","archived":false,"fork":false,"pushed_at":"2023-09-05T09:44:37.000Z","size":6911,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-04-14T22:50:22.725Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stackhpc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-10-25T15:15:14.000Z","updated_at":"2023-08-30T15:12:04.000Z","dependencies_parsed_at":"2022-09-24T16:50:25.576Z","dependency_job_id":null,"html_url":"https://github.com/stackhpc/stackhpc-io-tools","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/stackhpc/stackhpc-io-tools","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackhpc%2Fstackhpc-io-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackhpc%2Fstackhpc-io-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackhpc%2Fstackhpc-io-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackhpc%2Fstackhpc-io-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stackhpc","download_url":"https://codeload.github.com/stackhpc/stackhpc-io-tools/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackhpc%2Fstackhpc-io-tools/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33696681,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-30T02:00:06.278Z","response_time":92,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-05-30T14:30:59.286Z","updated_at":"2026-05-30T14:31:00.041Z","avatar_url":"https://github.com/stackhpc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# To install\n\nInstallation from local files into a local virtualenv:\n\n    virtualenv venv\n    source venv/bin/activate\n    pip install .\n\nInstallation direct from the git repo:\n\n    pip install git+https://github.com/stackhpc/stackhpc-io-tools\n\n# To build and push docker image\n\n    make docker DOCKER_ID=stackhpc\n\n# To run fio locally (which launches a single client locally)\n\nThe `DATA_PATH` and `RESULTS_PATH` here refer to the path to read the\ndata from and dump results to locally.\n\n    make local SCENARIO=beegfs FIO_RW=randread NUM_CLIENTS=1 \\\n      DATA_PATH=/path-to-test-dir RESULTS_PATH=/path-to-result-dir\n\n# To run remote baremetal batch jobs:\n\nThis expects you to be able to SSH into the nodes normally and `fio_jobfiles` is available in the home directory of the default user which you can copy over using the following:\n\n    make copy NUM_NODES=2 NODE_PREFIX=centos@kata-worker\n\nThen to invoke the batch job:\n\n    for c in 1 64; do\n      for rw in write randwrite read randread; do\n        make remote SCENARIO=beegfs FIO_RW=$rw NUM_CLIENTS=$c \\\n          DATA_PATH=/mnt/storage-nvme \\\n          RESULTS_PATH=/mnt/storage-nvme/bharat/results/bare \\\n          NUM_NODES=2 NODE_PREFIX=centos@kata-worker\n      done\n    done\n\nIf you have a large number of clients, make sure that you update the\nMaxStartups paramater in `/etc/ssh/sshd_config` and restart `sshd` in worker\nnodes otherwise your connections may get dropped because the default setting of\n`10:30:50` means that `30%` of connections when there are more than `10` will get\ndropped up to a maximum of `50` after which all connections are dropped.\n\n# To run as a Kubernetes job:\n\nThe `DATA_HOSTPATH` and `RESULTS_HOSTPATH` here refer to the path to read the\ndata from and dump results to on the Kubernetes worker nodes. These paths are\nmapped to the default `DATA_PATH` and `RESULTS_PATH` inside containers spawned\nby Kubernetes.\n\n    for c in 1 64; do\n      for rw in write randwrite read randread; do\n        make k8s SCENARIO=beegfs FIO_RW=$rw NUM_CLIENTS=$c \\\n          DATA_HOSTPATH=/mnt/storage-nvme/bharat \\\n          RESULTS_HOSTPATH=/mnt/storage-nvme/bharat/results/runc\n      done\n    done\n\nThere is an option to add `RUNTIME_CLASS` if it is supported by the Kubernetes cluster:\n\n    for c in 1 64; do\n      for rw in write randwrite read randread; do\n        make k8s SCENARIO=beegfs FIO_RW=$rw NUM_CLIENTS=$c \\\n          DATA_HOSTPATH=/mnt/storage-nvme \\\n          RESULTS_HOSTPATH=/mnt/storage-nvme/bharat/results/kata \\\n          RUNTIME_CLASS=kata-qemu\n      done\n    done\n\nAs the test is running, it might be useful to look at the verbose output of the test as follows:\n\n    kubectl --namespace default logs jobs/beegfs-randread-1 --follow\n\nFor debugging, you can also invoke shell inside the pod:\n\n    kubectl --namespace default exec -it beegfs-randread-1-n44kj sh\n\n# To generate plot:\n\n    make parse RESULTS_PATH=/path-to-result-dir OUTPUT_PATH=/path-to-output-dir\n\nNOTE: `RESULTS_PATH` is the path for raw data generated by `fio` and\n`OUTPUT_PATH` is the parsed data analysed by `bin/fio_parse` executable\npresented in this repo.\n\n# Typical output figures:\n\n![Blocksize vs commit latency](example/blocksize-vs-commit-latency.png)\n![Commit latency frequency distribution](example/commit-latency-freq-dist.png)\n![Stacked blocksize vs read bandwidth](example/stacked-blocksize-vs-bandwidth.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackhpc%2Fstackhpc-io-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackhpc%2Fstackhpc-io-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackhpc%2Fstackhpc-io-tools/lists"}