hsbench/README.md

# 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.  

The test is loosely based on the Nasuni benchmark used to test the performance of different cloud
storage providers.

# Building the Program
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 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 (which can be displayed using -help):

```
  -a string
        Access key
  -b string
        Bucket for testing (default "wasabi-benchmark-bucket")
  -d int
        Duration of each test in seconds (default 60)
  -l int
        Number of times to repeat test (default 1)
  -s string
        Secret key
  -t int
        Number of threads to run (default 1)
  -u string
        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.