Merge pull request #4 from andypern/regions

Regions

README.md

@@ -1,14 +1,14 @@
 # S3 Bench
-This tool offers the ability to run very basic throughput benchmarking against 
-an S3-compatible endpoint. It does a series of put operations followed by a 
-series of get operations and displays the corresponding statistics. The tool 
+This tool offers the ability to run very basic throughput benchmarking against
+an S3-compatible endpoint. It does a series of put operations followed by a
+series of get operations and displays the corresponding statistics. The tool
 uses the AWS Go SDK.
 
 ## Requirements
 * Go
 
 ## Installation
-Run the following command to build the binary. 
+Run the following command to build the binary.
 
 ```
 go get github.com/igneous-systems/s3bench
@@ -20,19 +20,35 @@ The s3bench command is self-describing. In order to see all the available option
 just run s3bench -help.
 
 ### Example input
-The following will run a benchmark from 2 concurrent clients, which in 
-aggregate will put a total of 10 unique new objects. Each object will be 
-exactly 1024 bytes. The objects will be placed in a bucket named loadgen. 
-The S3 endpoint will be ran against http://endpoint1:80 and 
+The following will run a benchmark from 2 concurrent clients, which in
+aggregate will put a total of 10 unique new objects. Each object will be
+exactly 1024 bytes. The objects will be placed in a bucket named loadgen.
+The S3 endpoint will be ran against http://endpoint1:80 and
 http://endpoint2:80. Object name will be prefixed with loadgen.
 
 ```
 ./s3bench -accessKey=KEY -accessSecret=SECRET -bucket=loadgen -endpoint=http://endpoint1:80,http://endpoint2:80 -numClients=2 -numSamples=10 -objectNamePrefix=loadgen -objectSize=1024
 ```
 
+#### Note on regions & endpoints
+By default, the region used will be `igneous-test` , a fictitious region which
+is suitable for using with the Igneous Data Service.  However, you can elect to
+use this tool with Amazon S3, in which case you will need to specify the proper region.
+
+It is also important when using Amazon S3 that you specify the proper endpoint, which
+will generally be `http://s3-regionName.amazonaws.com:80`. EG: if the bucket which you are
+testing is in Oregon, you would specify:
+
+```
+-endpoint http://s3-us-west-2.amazonaws.com:80 -region us-west-2
+```
+
+For more information on this, please refer to [AmazonS3 documentation.](https://aws.amazon.com/documentation/s3/)
+
+
 
 ### Example output
-The output will consist of details for every request being made as well as the 
+The output will consist of details for every request being made as well as the
 current average throughput. At the end of the run summaries of the put and get
 operations will be displayed.
 

s3bench.go

@@ -27,6 +27,7 @@ var bufferBytes []byte
 
 func main() {
 	endpoint := flag.String("endpoint", "", "S3 endpoint(s) comma separated - http://IP:PORT,http://IP:PORT")
+	region := flag.String("region", "igneous-test", "AWS region to use, eg: us-west-1|us-east-1, etc")
 	accessKey := flag.String("accessKey", "", "the S3 access key")
 	accessSecret := flag.String("accessSecret", "", "the S3 access secret")
 	bucketName := flag.String("bucket", "bucketname", "the bucket for which to run the test")
@@ -79,7 +80,7 @@ func main() {
 	// Start the load clients and run a write test followed by a read test
 	cfg := &aws.Config{
 		Credentials:      credentials.NewStaticCredentials(*accessKey, *accessSecret, ""),
-		Region:           aws.String("igneous-test"),
+		Region:           aws.String(*region),
 		S3ForcePathStyle: aws.Bool(true),
 	}
 	params.StartClients(cfg)