From 49c74c4b5b17077da92c3b358aa0382249d2d396 Mon Sep 17 00:00:00 2001 From: Jeff Flowers Date: Fri, 9 Jun 2017 12:36:33 -0400 Subject: [PATCH] Updated README file. --- README.md | 35 +++++++++++++++++++++++++++++++---- 1 file changed, 31 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 31de8c4..71fcaee 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# s3-benchmark +# Introduction s3-benchmark is a program for performing S3 operations PUT, GET, and DELETE for objects. Besides the bucket configuration, the object size and number of threads can be given for different tests. @@ -6,14 +6,22 @@ The test is loosely based on the Nasuni benchmark used to test the performance o storage providers. # Building the Program -If the test is being run on the Ubuntu version 16.04 LTS (the current long term release), the binary +Obtain a local copy of the repository using the following git command: + +``` +git clone https://github.com/wasabi-tech/s3-benchmark.git +``` + +If the test is being run on Ubuntu version 16.04 LTS (the current long term release), the binary executable s3-benchmark.ubuntu will run the benchmark without building. -Otherwise, to build the test, you must install the Go 1.7 system along with the supporting libraries. +Otherwise, to build the test, you must install Go 1.7 development system along with the supporting libraries +given in the import section. # Command Line Arguments -Below are the command line arguments to the program: +Below are the command line arguments to the program (which can be displayed using -help): +``` -a string Access key -b string @@ -30,6 +38,25 @@ Below are the command line arguments to the program: URL for host with method prefix (default "http://s3.wasabisys.com") -z string Size of objects in bytes with postfix K, M, and G (default "1M") +``` # Example Benchmark +Below is an example run of the benchmark for 10 threads with the default 1MB object size. The benchmark reports +for each operation PUT, GET and DELETE the results in terms of data speed and operations per second. The program +writes all results to the log file benchmark.log. +``` +ubuntu:~/s3-benchmark$ ./s3-benchmark.ubuntu -a MY-ACCESS-KEY -b jeff-s3-benchmark -s MY-SECRET-KEY -t 10 +Wasabi benchmark program v2.0 +Parameters: url=http://s3.wasabisys.com, bucket=jeff-s3-benchmark, duration=60, threads=10, loops=1, size=1M +Loop 1: PUT time 60.1 secs, objects = 5484, speed = 91.3MB/sec, 91.3 operations/sec. +Loop 1: GET time 60.1 secs, objects = 5483, speed = 91.3MB/sec, 91.3 operations/sec. +Loop 1: DELETE time 1.9 secs, 2923.4 deletes/sec. +Benchmark completed. +``` + +#Note +Your benchmark results may vary most often because of limitations of your network connection to the cloud storage +provider. Wasabi performance claims are tested under conditions that remove any latency (which can be shown using +the ping command) and bandwidth bottlenecks that restrict how fast data can be moved. For more information, +contact Wasabi customer support. \ No newline at end of file