Skip to content

Commit 131e46e

Browse files
committed
Add API load testing documentation
1 parent 9887ad8 commit 131e46e

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,25 @@ The Public API will run on `$(docker-machine ip):8082`
221221
By default, the `HDMA Platform` runs with a log level of `INFO`. This can be changed by establishing a different log level in the `HMDA_LOGLEVEL` environment variable.
222222
For the different logging options, see the [reference.conf](https://github.com/akka/akka/blob/master/akka-actor/src/main/resources/reference.conf#L38) default configuration file for `Akka`.
223223

224+
#### API Load Testing
225+
226+
A load testing scenario for the API has been built using [Gatling](https://gatling.io/). The parameters for this test can be configured in the `cluster/src/test/resources/application.conf` file.
227+
To run the default scenario:
228+
229+
```shell
230+
$ sbt
231+
> project cluster
232+
> gatling:test
233+
```
234+
235+
After the test is run, some statistics will be presented on the screen. To further study the results of the test, a report can be opened on a browser from the sbt prompt:
236+
237+
```shell
238+
> gatling:lastReport
239+
```
240+
241+
** NOTE: The load test requires the sample panel [file](loader/src/main/resources/inst_data_2017_dummy.csv) to be loaded before running it.
242+
224243
#### To run the entire platform
225244

226245
1. Ensure you have a Docker Machine with sufficient resources, as described in the [Docker](#docker) section above.

0 commit comments

Comments
 (0)