Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tsenart committed Nov 21, 2014
1 parent d5abca4 commit e27d8d7
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 3 deletions.
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion dump.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down

0 comments on commit e27d8d7

Please sign in to comment.