Clean up

camba1 · Apr 10, 2021 · cae2c91 · cae2c91
1 parent 786da9f
commit cae2c91
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 7 deletions.
diff --git a/grafana/README.md b/grafana/README.md
@@ -1,17 +1,15 @@
 # Grafana integration
 
-**Work in Progress**
-
 The application is integrated with Prometheus and Grafana to provide metrics observability.
-Currently, it is set up to collect metrics from all services, databases and NATS metrics.
+Currently, it is set up to collect metrics from all services, databases and NATS.
 
 ### Folder Organization
 
 This folder is organized as follows:
 
 - `Provisioning`: Folder that contains Grafana configuration
 
-    - `dashboards`: contains all the dashboards that will be available by default when it first comes up.
+    - `dashboards`: contains all the dashboards that will be available by default when the system first comes up.
     - `datasources`: Definition of the data sources used by Grafana
 
 - `docker-compose.env`: Environment variables required to run the service when running the Grafana with docker-compose
diff --git a/prometheus/README.md b/prometheus/README.md
@@ -1,9 +1,8 @@
 # Prometheus integration
 
-**Work in Progress**
 
 The application is integrated with Prometheus and Grafana to provide metrics observability.
-Currently, it is set up to collect metrics from all services, databases and NATS metrics.
+Currently, it is set up to collect metrics from all services, databases and NATS.
 
 ### Folder Organization
 
@@ -14,4 +13,8 @@ The `./prometheus` folder is organized as follows:
 - `timescaledbExporter`: Settings related to the PostgresSQL metrics exporter that allow Prometheus to scrape the database metrics
 - `prometheus.yml`: Prometheus scrape targets configuration
 
-Note that ArangoDB and NATS provide end point for Prometheus to scrape metrcis directly and thus there is no need for exporters. 
+Notes:
+- The microservices, ArangoDB and NATS provide endpoints for Prometheus to scrape metrics directly and thus they do not need exporters.
+- Since Micro automatically manages the K8s objects for the microservices,
+exposing the metrics ports to Prometheus is done by patching the Micro created K8s services via service patches. 
+The patches can be found under `cicd/K8s/microservicesPatch`