# Packages
# README
Benchviz is a tool that hooks up to an s3 instance and deploys daily benchmark stats as a JSON file to be visualized.
#USAGE
- Setup an AWS account hooked up with S3.
- Install the aws command line tool.
- Setup aws to be connected with your account.
- Set the following environment variables:
AWSBUCKETNAME=<name of your aws bucket>
BENCHDEPLOY=<full path to s3 mirror>
BENCHSAMPLES=<full path to your bench stat data>
##Benchsamples
Benchsamples is a directory that contains folders filled with historical benchmark results. The format of the directory (via example) is
/benchSamples
../01-01-2016
../02-01-2016
..../cockroach
....../kv
......../kv.test.stdout
....../sql
......../parser
........../parser.test.stdout
....../roachpb
....../storage
....../util
../03--01-2016
Important note: the directory must be named the date of the commit where the results were received from in DD-MM-YYYY format. In addition, the directory must store the results of benchmark tests in the directories that have benchmark tests under the name <directory>.test.stdout. This directory hierarchy is designed in this way because this is the format that we have our current historical benchmark data in.