diff --git a/README.md b/README.md index e671f7ff..9610aac7 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,11 @@ report command: -output="stdout": Output file -reporter="text": Reporter [text, json, plot, hist[buckets]] +dump command: + -dumper="": Dumper [json, csv] + -inputs="stdin": Input files (comma separated) + -output="stdout": Output file + global flags: -cpus=8 Number of CPUs to use @@ -171,12 +176,12 @@ means every single hit runs in its own worker. ``` $ vegeta report -h Usage of vegeta report: - -input="stdin": Input files (comma separated) + -inputs="stdin": Input files (comma separated) -output="stdout": Output file -reporter="text": Reporter [text, json, plot, hist[buckets]] ``` -#### -input +#### -inputs Specifies the input files to generate the report of, defaulting to stdin. These are the output of vegeta attack. You can specify more than one (comma separated) and they will be merged and sorted before being used by the @@ -259,6 +264,32 @@ Bucket # % Histogram [6ms, +Inf] 4771 25.93% ################### ``` +### dump +``` +$ vegeta dump -h +Usage of vegeta dump: + -dumper="": Dumper [json, csv] + -inputs="stdin": Input files (comma separated) + -output="stdout": Output file +``` + +#### -inputs +Specifies the input files containing attack results to be dumped. You can specify more than one (comma separated). + +#### -output +Specifies the output file to which the dump will be written to. + +#### -dumper +Specifies the dump format. + +##### json +Dumps attack results as JSON objects. + +##### csv +Dumps attack results as CSV records with six columns. +The columns are: unix timestamp in ns since epoch, http status code, +request latency in ns, bytes out, bytes in, and lastly the error. + ## Usage (Library) ```go package main diff --git a/dump.go b/dump.go index 447ba485..e22d35f2 100644 --- a/dump.go +++ b/dump.go @@ -13,7 +13,7 @@ import ( func dumpCmd() command { fs := flag.NewFlagSet("vegeta dump", flag.ExitOnError) - dumper := fs.String("dumper", "", "Reporter [json, csv]") + dumper := fs.String("dumper", "", "Dumper [json, csv]") inputs := fs.String("inputs", "stdin", "Input files (comma separated)") output := fs.String("output", "stdout", "Output file") return command{fs, func(args []string) error {