GoogleCloudPlatform / GoogleCloudPlatform/PerfKitBenchmarker

Add cryptsetup benchmark

Open
#5,242 0 comments 0 reactions 0 assignees View on GitHub
good first issue
Dominant language
Python
Stars
2k
Forks
562
Avg merge
4h 55m
Merged PRs (30d)
69

Description

https://man7.org/linux/man-pages/man8/cryptsetup-benchmark.8.html

This task adds cryptsetup as a new benchmark for PKB. It can be divided into a few different components:

1) Add the benchmarking framework
create cryptsetup_benchmark.py file in linux_benchmarks
populate BENCHMARK_NAME and BENCHMARK_CONFIG constants so that the benchmark can be found by PKB.
create GetConfig, Prepare, Run and Cleanup functions handlers with pass/return [] as function content.
At this point you can run your new benchmark in PKB (though it will not do anything yet).
2) Install cryptsetup
- cryptsetup comes with linux distributions so validate that installation is not needed
3) Add a function in cryptsetup.py that you added to linux_packages with a sensible name, e.g. ParseResults
Parse results should take a str as input and produce a list of PKB Samples as output. You goal is to parse the output into useful samples, where each sample as a metric name, metric value, metric unit, metric metadata. Each row of output should be a separate metric.
Test the parser function

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.