Skip to content

Commit

Permalink
added details in readme for Splunk reporting
Browse files Browse the repository at this point in the history
  • Loading branch information
PeaStew committed Apr 24, 2022
1 parent c18c085 commit 5459c5a
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ GLOBAL OPTIONS:
--output value, -o value output query results in easy to grasp PDF report
--print, -p output technical query results to terminal (default: false)
--json, -j output technical query results as json to terminal (default: false)
--splunk -s select a JSON or YAML file to load Splunk output parameters
--quiet, -q don't show progress bar (default: false)
--help, -h show help (default: false)
--version, -v print the version (default: false)
Expand Down Expand Up @@ -77,6 +78,17 @@ GLOBAL OPTIONS:
request_rate: 500
```
## Sample Splunk Input
### JSON
```json
{
"url":"https://example.com/hec/services/collector/event",
"authkey":"Splunk xyz",
"source": "rtapi for splunk by PeaStew"
}
```

### Default Values

Only the `target.url` parameter is required. If no method is specified the default is "GET", while in the case of the body and headers these will simply remain empty during the benchmark.
Expand Down

0 comments on commit 5459c5a

Please sign in to comment.