diff --git a/monitoring/tutorials/otel-demo/README.md b/monitoring/tutorials/otel-demo/README.md index b87b929584f..d9afa131a84 100644 --- a/monitoring/tutorials/otel-demo/README.md +++ b/monitoring/tutorials/otel-demo/README.md @@ -2,11 +2,14 @@ This tutorial provides instructions on setting up and using OpenTelemetry for monitoring target applications under chaos. +otel_demo_tutorial_architecture + + ## Setups ### 0. Prerequisites - Kubernetes 1.24+ -- 6 GB of free RAM for the application +- 8 GB of free RAM - Helm 3.9+ ### 1. Install Litmus @@ -84,18 +87,12 @@ This tutorial provides instructions on setting up and using OpenTelemetry for mo ### 4. Add Grafana Panel Import the `chaos-experiments-dashboard.json` file into Grafana to visualize the results of chaos experiments. -![chaos-experiments-dashboard-1.png](./screenshots/chaos-experiments-dashboard-1.png) -![chaos-experiments-dashboard-2.png](./screenshots/chaos-experiments-dashboard-2.png) ### 5. Experiments on Target Applications Explore the following experiments to test and observe chaos in target applications: -- [Pod Delete](https://github.com/litmuschaos/litmus/blob/master/monitoring/tutorials/otel-demo/recommendation-service) +- [Pod Delete](./recommendation-service) > Performs a Pod delete experiment on the recommendation service. -- [Pod Network Latency](https://github.com/litmuschaos/litmus/blob/master/monitoring/tutorials/otel-demo/cart-service) - > Conducts a network latency experiment on the cart service. - ---- - -Feel free to adjust any details as needed! \ No newline at end of file +- [Pod Network Latency](./cart-service) + > Performs a network latency experiment on the cart service. diff --git a/monitoring/tutorials/otel-demo/cart-service/README.md b/monitoring/tutorials/otel-demo/cart-service/README.md index 6598abb5f0d..335aa14e98d 100644 --- a/monitoring/tutorials/otel-demo/cart-service/README.md +++ b/monitoring/tutorials/otel-demo/cart-service/README.md @@ -22,4 +22,5 @@ 1. Click on the `Run` button 2. Check Experiment Status and Logs 3. Check the Resilience Score -4. Check cart service Spanmetrics Metrics using Grafana ![cartservice_spanmetrics.png](../screenshots/cartservice_spanmetrics.png) \ No newline at end of file +4. Check the Chaos Exporter metrics using Grafana and confirm if the experiment failed. ![cart_service_pod_network_latency_experiment_result_dashboard.png](../screenshots/cart_service_pod_network_latency_experiment_result_dashboard.png) +5. Check cart service Spanmetrics Metrics using Grafana ![cartservice_spanmetrics.png](../screenshots/cartservice_spanmetrics.png) \ No newline at end of file diff --git a/monitoring/tutorials/otel-demo/recommendation-service/README.md b/monitoring/tutorials/otel-demo/recommendation-service/README.md index 009c71b2f21..532ca079ede 100644 --- a/monitoring/tutorials/otel-demo/recommendation-service/README.md +++ b/monitoring/tutorials/otel-demo/recommendation-service/README.md @@ -1,7 +1,8 @@ # recommendation service pod delete ## Description - This experiment injects pod delete chaos to the recommendation service pod. -- The Probe checks the Prometheus metrics for the error rate of the ListRecommendations span. +- The Probe checks the Prometheus metrics for the error rate of the ListRecommendations span + - ListRecommendations is included in the frontend service, even though it utilizes the recommendation service. ## Steps ### 1. Probe Settings - probe type: `Prometheus Probe` @@ -22,4 +23,5 @@ 1. Click on the `Run` button 2. Check Experiment Status and Logs 3. Check the Resilience Score -4. Check Error Rate for frontend using Grafana ![frontend_spanmetrics.png](../screenshots/frontend_spanmetrics.png) \ No newline at end of file +4. Check the Chaos Exporter metrics using Grafana and confirm if the experiment passed. ![recommendation_service_pod_delete_experiment_result_dashboard.png](../screenshots/recommendation_service_pod_delete_experiment_result_dashboard.png) +5. Check Error Rate in frontend service Spanmetrics using Grafana ![frontend_spanmetrics.png](../screenshots/frontend_spanmetrics.png) \ No newline at end of file diff --git a/monitoring/tutorials/otel-demo/screenshots/cart_service_pod_network_latency_experiment_result_dashboard.png b/monitoring/tutorials/otel-demo/screenshots/cart_service_pod_network_latency_experiment_result_dashboard.png new file mode 100644 index 00000000000..54b6a93421e Binary files /dev/null and b/monitoring/tutorials/otel-demo/screenshots/cart_service_pod_network_latency_experiment_result_dashboard.png differ diff --git a/monitoring/tutorials/otel-demo/screenshots/chaos-experiments-dashboard-1.png b/monitoring/tutorials/otel-demo/screenshots/chaos-experiments-dashboard-1.png deleted file mode 100644 index 88368eaeff3..00000000000 Binary files a/monitoring/tutorials/otel-demo/screenshots/chaos-experiments-dashboard-1.png and /dev/null differ diff --git a/monitoring/tutorials/otel-demo/screenshots/chaos-experiments-dashboard-2.png b/monitoring/tutorials/otel-demo/screenshots/chaos-experiments-dashboard-2.png deleted file mode 100644 index ef382edab05..00000000000 Binary files a/monitoring/tutorials/otel-demo/screenshots/chaos-experiments-dashboard-2.png and /dev/null differ diff --git a/monitoring/tutorials/otel-demo/screenshots/otel_demo_tutorial_architecture.png b/monitoring/tutorials/otel-demo/screenshots/otel_demo_tutorial_architecture.png new file mode 100644 index 00000000000..098a6ff622d Binary files /dev/null and b/monitoring/tutorials/otel-demo/screenshots/otel_demo_tutorial_architecture.png differ diff --git a/monitoring/tutorials/otel-demo/screenshots/recommendation_service_pod_delete_experiment_result_dashboard.png b/monitoring/tutorials/otel-demo/screenshots/recommendation_service_pod_delete_experiment_result_dashboard.png new file mode 100644 index 00000000000..10ae21b1be2 Binary files /dev/null and b/monitoring/tutorials/otel-demo/screenshots/recommendation_service_pod_delete_experiment_result_dashboard.png differ