diff --git a/README.md b/README.md index 3b0c4c1..4200f40 100644 --- a/README.md +++ b/README.md @@ -10,37 +10,23 @@ Demo setup for Spring Boot apps with Prometheus, Grafana, Loki, Tempo, Eureka, a docker compose up ``` -## Stop dependencies - -```shell -docker compose down -``` - -## Stop dependencies and purge data - -```shell -docker compose down --volumes -``` - ## Remove logs ```shell rm -rf logs ``` -## Start the apps (using in-memory H2 DB) - +## Start the apps +If you want to use an in-memory DB (H2): ```shell ./gradlew bootRun ``` -## Start the apps using MySQL - -This is needed if you want to inject latency on the network (see [ToxiProxy](#useful-urls)). - +If you want to use a real DB (MySQL): ```shell ./gradlew bootRun -Pprofiles=mysql ``` +You need a real DB if you want to inject latency on the network (see [ToxiProxy](#useful-urls)). ## Start load tests @@ -50,6 +36,18 @@ See `SteepTeaSimulation.java` for duration, request rate, and traffic patterns. ./gradlew :load-gen:gatlingRun ``` +## Stop dependencies + +```shell +docker compose down +``` + +## Stop dependencies and purge data + +```shell +docker compose down --volumes +``` + ## Useful URLs - Tea UI: http://localhost:8090/steep @@ -84,7 +82,7 @@ make errors ## Latency simulation -If you [start the apps with the `mysql` profile](#start-the-apps-using-mysql), the apps are not connected to the DB directly but through [ToxiProxy](#useful-urls) so that you can inject failures (i.e.: latency) on the network. You can do this in multiple ways (e.g.: using the [ToxiProxy UI](#useful-urls) or the ToxiProxy CLI). The `Makefile` contains a goal for this to make it simple for you, you can run this to inject latency: +If you [start the apps with the `mysql` profile](#start-the-apps), the apps are not connected to the DB directly but through [ToxiProxy](#useful-urls) so that you can inject failures (i.e.: latency) on the network. You can do this in multiple ways (e.g.: using the [ToxiProxy UI](#useful-urls) or the ToxiProxy CLI). The `Makefile` contains a goal for this to make it simple for you, you can run this to inject latency: ```shell make chaos