Metrics

.maintain/monitoring/README.md

@@ -0,0 +1,18 @@
+# Metrics
+
+## Requirements
+
+1. `forest` node running locally
+2. `docker` & `docker-compose` must be available in the `$PATH` 
+
+## Run
+
+To run the metrics stack, use the provided Docker compose file to instantiate the `prometheus` and `grafana` processes.
+
+``` sh
+$ sudo docker-compose up --build --force-recreate -d
+```
+
+This will create a `grafana` process which is preloaded with dashboards which render metrics collected by the `prometheus` process from the `forest` node running locally.
+Once the metrics stack is running, open up the `grafana` webapp to view the predefined dashboards.
+

.maintain/monitoring/docker-compose.yml

@@ -0,0 +1,32 @@
+# Docker compose file to start the metrics and monitoring stack for a local Forest node
+#
+# # Processes
+# - Prometheus server
+# - Grafana server
+
+version: "3.7"
+services:
+  prometheus:
+    image: prom/prometheus
+    entrypoint:
+      - "/bin/prometheus"
+      - "--log.level=debug"
+      - "--config.file=/etc/prometheus/prometheus.yml"
+      - "--storage.tsdb.path=/prometheus"
+      - "--web.console.libraries=/usr/share/prometheus/console_libraries"
+      - "--web.console.templates=/usr/share/prometheus/consoles"
+    network_mode: host
+    volumes:
+      - ./prometheus/:/etc/prometheus/
+    restart: always
+
+  grafana:
+    image: grafana/grafana
+    user: "104"
+    depends_on:
+      - prometheus
+    network_mode: host
+    volumes:
+      - ./grafana/provisioning/:/etc/grafana/provisioning
+      - ./grafana/dashboards/:/etc/grafana/provisioning/dashboard-definitions
+    restart: always

.maintain/monitoring/grafana/dashboards/README.md

@@ -0,0 +1,9 @@
+# Preloaded Dashboards for Forest
+
+## Dashboards
+
+- `forest`: The forest dashboard keeps track of process, syncing, and execution metrics
+
+## Updating
+
+To update any dashboard, make changes to the dashboard in the Grafana web application, export the dashboard, and replace the dashboard JSON definition in this directory.