From 6b667910909b332e78105ccdf17e39e4b286ed39 Mon Sep 17 00:00:00 2001 From: houjingwen Date: Fri, 3 Jul 2015 07:58:25 +0000 Subject: Add support for measuring storage performance use fio A simple test case is added that will test writes to ephemeral storage. See samples/fio.yaml The Fio test type can also be used to test block storage, just modify the "filename" argument. JIRA: YARDSTICK-34 Change-Id: I1758d2999f8a5fdd44726e1dfc3e9769ea39dad6 Signed-off-by: houjingwen --- samples/fio.yaml | 74 +++++++++++ setup.py | 7 +- tools/ubuntu-server-cloudimg-modify.sh | 1 + yardstick/benchmark/scenarios/storage/__init__.py | 0 yardstick/benchmark/scenarios/storage/fio.py | 139 +++++++++++++++++++++ .../benchmark/scenarios/storage/fio_benchmark.bash | 81 ++++++++++++ 6 files changed, 301 insertions(+), 1 deletion(-) create mode 100644 samples/fio.yaml create mode 100644 yardstick/benchmark/scenarios/storage/__init__.py create mode 100644 yardstick/benchmark/scenarios/storage/fio.py create mode 100644 yardstick/benchmark/scenarios/storage/fio_benchmark.bash diff --git a/samples/fio.yaml b/samples/fio.yaml new file mode 100644 index 000000000..f70912a15 --- /dev/null +++ b/samples/fio.yaml @@ -0,0 +1,74 @@ +--- +# Sample benchmark task config file +# measure storage performance using fio +# +# For this sample just like running the command below on the test vm and +# getting benchmark info back to the yardstick. +# +# sudo fio -filename=/home/ec2-user/data.raw -bs=4k -rw=write -ramp_time=10 \ +# -runtime=60 -name=yardstick-fio -ioengine=libaio -direct=1 \ +# -group_reporting -numjobs=1 -time_based --output=yardstick-fio.log +# +# When the above fio command done, the yardstick-fio.log file will contain +# information like below and the benchmark script will take iops, throughput +# and latency info marked with "" to create json style output. +# +# yardstick-fio: (g=0): rw=write, bs=4K-4K/4K-4K/4K-4K, ioengine=libaio, iodepth=1 +# fio-2.1.3 +# Starting 1 process +# +# yardstick-fio: (groupid=0, jobs=1): err= 0: pid=1421: Mon Jul 6 01:25:41 2015 +# write: io=1985.4MB, bw=33882KB/s, iops="8470", runt= 60001msec +# slat (usec): min=6, max=15049, avg=10.29, stdev=19.42 +# clat (usec): min=1, max=18517, avg=105.68, stdev=37.76 +# lat ("usec"): min=85, max=18528, avg="116.30", stdev=43.57 +# clat percentiles (usec): +# | 1.00th=[ 83], 5.00th=[ 85], 10.00th=[ 87], 20.00th=[ 88], +# | 30.00th=[ 90], 40.00th=[ 93], 50.00th=[ 98], 60.00th=[ 102], +# | 70.00th=[ 110], 80.00th=[ 124], 90.00th=[ 137], 95.00th=[ 149], +# | 99.00th=[ 173], 99.50th=[ 181], 99.90th=[ 203], 99.95th=[ 290], +# | 99.99th=[ 604] +# bw (KB /s): min= 0, max=39816, per=99.26%, avg=33631.46, stdev=4369.58 +# lat (usec) : 2=0.01%, 50=0.01%, 100=55.44%, 250=44.50%, 500=0.02% +# lat (usec) : 750=0.04%, 1000=0.01% +# lat (msec) : 2=0.01%, 4=0.01%, 10=0.01%, 20=0.01% +# cpu : usr=4.09%, sys=16.38%, ctx=604931, majf=0, minf=27 +# IO depths : 1=118.9%, 2=0.0%, 4=0.0%, 8=0.0%, 16=0.0%, 32=0.0%, >=64=0.0% +# submit : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0% +# complete : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0% +# issued : total=r=0/w=508237/d=0, short=r=0/w=0/d=0 +# +# Run status group 0 (all jobs): +# WRITE: io=1985.4MB, aggrb="33881KB/s", minb=33881KB/s, maxb=33881KB/s, mint=60001msec, maxt=60001msec +# +# Disk stats (read/write): +# vda: ios=0/604235, merge=0/211, ticks=0/61964, in_queue=61804, util=86.25% + +schema: "yardstick:task:0.1" + +scenarios: +- + type: Fio + options: + filename: /home/ec2-user/data.raw + bs: 4k + rw: write + ramp_time: 10 + host: fio.demo + runner: + type: Duration + duration: 60 + interval: 60 + +context: + name: demo + image: yardstick-trusty-server + flavor: yardstick-flavor + user: ec2-user + servers: + fio: + floating_ip: true + networks: + test: + cidr: "10.0.1.0/24" + external_network: "net04_ext" diff --git a/setup.py b/setup.py index 742192c6f..7adaa05dc 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,12 @@ setup( version="0.1.dev0", packages=find_packages(), include_package_data=True, - package_data={'yardstick': ['benchmark/scenarios/networking/*.bash']}, + package_data={ + 'yardstick': [ + 'benchmark/scenarios/networking/*.bash', + 'benchmark/scenarios/storage/*.bash' + ] + }, url="https://www.opnfv.org", install_requires=["backport_ipaddress", # remove with python3 "flake8", diff --git a/tools/ubuntu-server-cloudimg-modify.sh b/tools/ubuntu-server-cloudimg-modify.sh index c2977896f..96447d8d9 100755 --- a/tools/ubuntu-server-cloudimg-modify.sh +++ b/tools/ubuntu-server-cloudimg-modify.sh @@ -27,6 +27,7 @@ grep trusty /etc/apt/sources.list && \ echo "deb http://archive.ubuntu.com/ubuntu/ trusty-backports main restricted universe multiverse" >> /etc/apt/sources.list apt-get update apt-get install -y \ + fio \ iperf3 \ lmbench \ stress diff --git a/yardstick/benchmark/scenarios/storage/__init__.py b/yardstick/benchmark/scenarios/storage/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/yardstick/benchmark/scenarios/storage/fio.py b/yardstick/benchmark/scenarios/storage/fio.py new file mode 100644 index 000000000..a39af06aa --- /dev/null +++ b/yardstick/benchmark/scenarios/storage/fio.py @@ -0,0 +1,139 @@ +############################################################################## +# Copyright (c) 2015 Huawei Technologies Co.,Ltd. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## +import pkg_resources +import logging +import json + +import yardstick.ssh as ssh +from yardstick.benchmark.scenarios import base + +LOG = logging.getLogger(__name__) +LOG.setLevel(logging.DEBUG) + + +class Fio(base.Scenario): + """Execute fio benchmark on host + + Parameters + filename - file name for fio workload + type: string + unit: na + default: /home/ec2-user/data.raw + bs - block size used for the io units + type: int + unit: bytes + default: 4k + rw - type of io pattern [read, write, randwrite, randread, rw, randrw] + type: string + unit: na + default: write + ramp_time - run time before logging any performance + type: int + unit: seconds + default: 20 + + Read link below for more fio args description: + http://www.bluestop.org/fio/HOWTO.txt + """ + __scenario_type__ = "Fio" + + TARGET_SCRIPT = "fio_benchmark.bash" + + def __init__(self, context): + self.context = context + self.setup_done = False + + def setup(self): + '''scenario setup''' + self.target_script = pkg_resources.resource_filename( + "yardstick.benchmark.scenarios.storage", + Fio.TARGET_SCRIPT) + user = self.context.get("user", "root") + host = self.context.get("host", None) + key_filename = self.context.get("key_filename", "~/.ssh/id_rsa") + + LOG.debug("user:%s, host:%s", user, host) + self.client = ssh.SSH(user, host, key_filename=key_filename) + self.client.wait(timeout=600) + + # copy script to host + self.client.run("cat > ~/fio.sh", + stdin=open(self.target_script, "rb")) + + self.setup_done = True + + def run(self, args): + """execute the benchmark""" + default_args = "-ioengine=libaio -direct=1 " \ + "-group_reporting -numjobs=1 -time_based" + + if not self.setup_done: + self.setup() + + options = args["options"] + filename = options.get("filename", "/home/ec2-user/data.raw") + bs = options.get("bs", "4k") + rw = options.get("rw", "write") + ramp_time = options.get("ramp_time", 20) + name = "yardstick-fio" + # if run by a duration runner + duration_time = self.context.get("duration", None) + # if run by an arithmetic runner + arithmetic_time = options.get("duration", None) + if duration_time: + runtime = duration_time + elif arithmetic_time: + runtime = arithmetic_time + else: + runtime = 30 + + args = "-filename=%s -bs=%s -rw=%s -ramp_time=%s -runtime=%s -name=%s" \ + % (filename, bs, rw, ramp_time, runtime, name) + cmd = "sudo bash fio.sh %s %s %s" \ + % (filename, args, default_args) + LOG.debug("Executing command: %s", cmd) + status, stdout, stderr = self.client.execute(cmd) + if status: + raise RuntimeError(stderr) + + data = json.loads(stdout) + + # TODO: add sla check + + return data + + +def _test(): + '''internal test function''' + key_filename = pkg_resources.resource_filename("yardstick.resources", + "files/yardstick_key") + ctx = { + "host": "10.0.0.101", + "user": "ec2-user", + "key_filename": key_filename + } + + logger = logging.getLogger("yardstick") + logger.setLevel(logging.DEBUG) + + fio = Fio(ctx) + + options = { + "filename": "/home/ec2-user/data.raw", + "bs": "4k", + "rw": "write", + "ramp_time": 10, + } + args = {"options": options} + + result = fio.run(args) + print result + +if __name__ == '__main__': + _test() diff --git a/yardstick/benchmark/scenarios/storage/fio_benchmark.bash b/yardstick/benchmark/scenarios/storage/fio_benchmark.bash new file mode 100644 index 000000000..0fa319dd4 --- /dev/null +++ b/yardstick/benchmark/scenarios/storage/fio_benchmark.bash @@ -0,0 +1,81 @@ +#!/bin/sh + +############################################################################## +# Copyright (c) 2015 Huawei Technologies Co.,Ltd. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + +set -e + +# Commandline arguments +FIO_FILENAME=$1 +shift +OPTIONS="$@" +OUTPUT_FILE="yardstick-fio.log" + +# setup data file for fio +setup() +{ + if [ ! -f $FIO_FILENAME ]; then + dd if=/dev/zero of=$FIO_FILENAME bs=1M count=1024 oflag=direct > /dev/null 2>&1 + fi +} + +# run fio test +run_test() +{ + fio $OPTIONS --output=$OUTPUT_FILE +} + +# write the result to stdout in json format +output_json() +{ + read_bw=$(grep "READ.*aggrb" $OUTPUT_FILE | awk -F [=\ ,] '{printf $9}') + write_bw=$(grep "WRITE.*aggrb" $OUTPUT_FILE | awk -F [=\ ,] '{printf $8}') + eval $(grep -e '\ lat.*stdev' -e "read.*iops" -e "write.*iops" -e "trim.*iops" $OUTPUT_FILE | sed 'N;s/\n/ /g' | grep read | awk -F [=\ ,\(\)] '{printf("read_iops=%s; read_lat_unit=%s; read_lat=%s", $12, $24, $33)}') + eval $(grep -e '\ lat.*stdev' -e "read.*iops" -e "write.*iops" -e "trim.*iops" $OUTPUT_FILE | sed 'N;s/\n/ /g' | grep write | awk -F [=\ ,\(\)] '{printf("write_iops=%s; write_lat_unit=%s; write_lat=%s", $11, $23, $32)}') + + read_bw=${read_bw:-N/A} + write_bw=${write_bw:-N/A} + read_iops=${read_iops:-N/A} + write_iops=${write_iops:-N/A} + if [ "x$read_lat" = "x" ]; then + read_lat="N/A" + else + read_lat=$read_lat$read_lat_unit + fi + if [ "x$write_lat" = "x" ]; then + write_lat="N/A" + else + write_lat=$write_lat$write_lat_unit + fi + + echo -e "{ \ + \"read_bw\":\"$read_bw\", \ + \"write_bw\":\"$write_bw\", \ + \"read_iops\":\"$read_iops\", \ + \"write_iops\":\"$write_iops\", \ + \"read_lat\":\"$read_lat\", \ + \"write_lat\":\"$write_lat\" \ + }" +} + +# main entry +main() +{ + # setup the test + setup + + # run the test + run_test >/dev/null + + # output result + output_json +} + +main + -- cgit 1.2.3-korg