Skip to content

Commit

Permalink
fix lint
Browse files Browse the repository at this point in the history
  • Loading branch information
s-radyuk committed Dec 22, 2021
1 parent 371959d commit 1520386
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/ghz/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ You can specify resource limits and requests for the containers to ensure that w

The following environment variables can be specified to configure this parameter:

```
```bash
GHZ_CPU_LIMITS
GHZ_CPU_REQUESTS
GHZ_MEMORY_LIMITS
Expand Down
3 changes: 2 additions & 1 deletion docs/locust/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ Let's break it down the parameters:
- `targetURL` is the host to be prefixed on all relative URLs in the locustfile

> Note: If you don't specify `duration`, your tests will run infinitely.
<!-- comment -->
> Note: If you don't specify `targetURL`, be sure to use absolute URLs on your locustfile or your tests will fail.
Expand Down Expand Up @@ -79,7 +80,7 @@ You can specify resource limits and requests for Locust master and worker contai

The following environment variables can be specified to configure this parameter:

```
```bash
LOCUST_MASTER_CPU_LIMITS
LOCUST_MASTER_CPU_REQUESTS
LOCUST_MASTER_MEMORY_LIMITS
Expand Down
18 changes: 9 additions & 9 deletions docs/user-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ We expect users to communicate with Kangal by only using API, which is provided
Here is an example of requests users can send to Kangal API to manage their load test.

## Create
## Create
Create a new load test by making a POST request to Kangal Proxy.

> **Note**: The sample CURL commands below use example test files, those files can be found in [Kangal repository](https://github.com/hellofresh/kangal/).
Expand Down Expand Up @@ -66,22 +66,22 @@ curl -X POST http://${KANGAL_PROXY_ADDRESS}/load-test \
```
**Note:** For locust only master image will be taken into account!!

## Check
## Check
Check the status of the load test.

```
```bash
curl -X GET \
http://${KANGAL_PROXY_ADDRESS}/load-test/loadtest-name
```

## Live monitoring
Get logs and monitor your tests. 
Get logs and monitor your tests.
For the logs of the main load generator process use the following command:
```
```bash
curl -X GET http://${KANGAL_PROXY_ADDRESS}/load-test/loadtest-name/logs
```
### Advanced logs monitoring
For the logs of the worker pod use the index number of the worker.
For the logs of the worker pod use the index number of the worker.
Index numbers are `0`, `1`, etc, according to the number of workers you created.
```bash
curl -X GET http://${KANGAL_PROXY_ADDRESS}/load-test/loadtest-name/logs/0
Expand All @@ -91,17 +91,17 @@ You can also monitor the behavior of your service with your custom tools e.g. Gr

Example of monitoring for JMeter is described at [docs/jmeter/reporting.md](jmeter/reporting.md).

## Get static report.
## Get static report
When the test is finished successfully the backend will save the report.

The report for a particular test can be found by the link `https://${KANGAL_PROXY_ADDRESS}/load-test/loadtest-name/report/`.

> Report persistence depends on the backend implementation.
## Delete
## Delete
Delete your finished load test.

```
```bash
curl -X DELETE http://${KANGAL_PROXY_ADDRESS}/load-test/loadtest-name
```

Expand Down

0 comments on commit 1520386

Please sign in to comment.