13_monitoring.adoc added

Arquisoft · Apr 28, 2024 · a129340 · a129340
1 parent 2a9358e
commit a129340
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 2 deletions.
diff --git a/docs/images/endpoint_monitoring.png b/docs/images/endpoint_monitoring.png
diff --git a/docs/images/response_time_monitoring.png b/docs/images/response_time_monitoring.png
diff --git a/docs/images/system_usage.png b/docs/images/system_usage.png
diff --git a/docs/index.adoc b/docs/index.adoc
@@ -93,8 +93,12 @@ include::src/10_quality_requirements.adoc[]
 include::src/11_technical_risks.adoc[]
 
 <<<<
+// 12. Testing
 include::src/12_testing.adoc[]
 
 <<<<
-// 12. Glossary
-include::src/13_glossary.adoc[]
+// 13. Monitoring
+include::src/13_monitoring.adoc[]
+<<<<
+// 14. Glossary
+include::src/14_glossary.adoc[]
diff --git a/docs/src/13_monitoring.adoc b/docs/src/13_monitoring.adoc
@@ -0,0 +1,26 @@
+ifndef::imagesdir[:imagesdir: ../images]
+
+[[section-monitoring]]
+== Monitoring with Grafana and Prometheus
+
+Monitoring is a crucial part of application development as it allows us to obtain real-time information about the performance and health of the system. In this case, we used Grafana and Prometheus to collect and visualize monitoring data.
+
+=== Memory and CPU Usage
+
+Grafana and Prometheus enable us to monitor the memory and CPU usage of the system. This helps us identify potential bottlenecks and optimize the performance of our application. We can visualize real-time graphs that show the evolution of memory and CPU usage over time.
+image::system_usage.png[align="center",title="System Usage Monitoring"]
+
+
+=== Number of Requests and Response Time
+
+In addition to memory and CPU usage, we can also monitor the number of requests our application receives and the response time of these requests. This allows us to identify potential performance issues and optimize the responsiveness of our application. Grafana and Prometheus allow us to visualize graphs that show the evolution of the number of requests and response time.
+image::response_time_monitoring.png[align="center",title="Response Time Monitoring"]
+
+
+=== Number of Calls to Each Endpoint
+
+Another important metric we can monitor is the number of calls made to each endpoint of our application. This helps us identify the most frequently used endpoints and optimize their performance. Grafana and Prometheus allow us to visualize graphs that show the number of calls to each endpoint.
+image::endpoint_monitoring.svg[align="center",title="Endpoint Monitoring"]
+
+
+With monitoring using Grafana and Prometheus, we can gain a comprehensive view of the performance and health of our application. This enables us to make informed decisions to improve the performance and responsiveness of our application.
diff --git a/docs/src/13_glossary.adoc → docs/src/14_glossary.adoc b/docs/src/13_glossary.adoc → docs/src/14_glossary.adoc