atridad/loadr
1
0
Fork 0
Code Activity

Readme updates

Browse source
This commit is contained in:
Atridad Lahiji 2024-01-15 00:50:30 -07:00
parent 56c20462ff
commit c68d43e330
No known key found for this signature in database
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -2,16 +2,16 @@
A lightweight REST load testing tool with rubust support for different verbs, token auth, and performance reports. A lightweight REST load testing tool with rubust support for different verbs, token auth, and performance reports.
Example using source: ## Example using source:
1. `go run main.go -rate=20 -max=100 -url=https://api.example.com/resource -type=POST -json=./data.json -token=YourBearerTokenHere` 1. `go run main.go -rate=20 -max=100 -url=https://api.example.com/resource -type=POST -json=./data.json -token=YourBearerTokenHere`
Example using binary: ## Example using binary:
1. go build 1. go build
2. `./loadr -rate=20 -max=100 -url=https://api.example.com/resource -type=POST -json=./data.json -token=YourBearerTokenHere` 2. `./loadr -rate=20 -max=100 -url=https://api.example.com/resource -type=POST -json=./data.json -token=YourBearerTokenHere`
Flags: ## Flags:
- `-rate`: Number of requests per second. Default is 10. - `-rate`: Number of requests per second. Default is 10.
- `-max`: Maximum number of requests to send. Must be a non-zero integer. Default is 50. - `-max`: Maximum number of requests to send. Must be a non-zero integer. Default is 50.
@ -19,3 +19,7 @@ Flags:
- `-type`: Type of HTTP request. Can be GET, POST, PUT, DELETE, etc. Default is "GET". - `-type`: Type of HTTP request. Can be GET, POST, PUT, DELETE, etc. Default is "GET".
- `-json`: Path to the JSON file with request data. If not provided, no data is sent with the requests. - `-json`: Path to the JSON file with request data. If not provided, no data is sent with the requests.
- `-token`: Bearer token for authorization. If not provided, no Authorization header is sent with the requests. - `-token`: Bearer token for authorization. If not provided, no Authorization header is sent with the requests.
## Reports
Reports are logged at the end of a test run. They are also saved in a directory called `.reports`. All reports are saved as text files with `YYYYMMdd-HHmmss` time format names.