chore: adds dashboard. (#222)

Co-authored-by: Matteo Pace <[email protected]>

README.md

@@ -28,8 +28,10 @@ Targets:
 ```
 
 ### Building requirements
+
 Building the filter requires:
-- [Go](https://go.dev/doc/install) 
+
+- [Go](https://go.dev/doc/install)
 - [TinyGo](https://tinygo.org/getting-started/install/)
 
 Up to date required versions can be found looking at [`minGoVersion` and `tinygoMinorVersion` variables](./magefiles/magefile.go).
@@ -163,10 +165,12 @@ Envoy with the coraza-wasm filter will be reachable at `localhost:8080`.
 The filter is configured with the CRS loaded working in Anomaly Scoring mode. 
 For details and locally tweaking the configuration refer to [@recommended-conf](./wasmplugin/rules/coraza.conf-recommended.conf) and [@crs-setup-conf](./wasmplugin/rules/crs-setup.conf.example).
 
-In order to monitor envoy logs while performing requests you can run:
+In order to individually monitor envoy logs while performing requests, in another terminal you can run:
+
+- Envoy logs: `docker-compose -f ./example/envoy/docker-compose.yml logs -f envoy-logs`.
+- Critical wasm (audit) logs: `docker-compose -f ./example/envoy/docker-compose.yml logs -f wasm-logs`
 
-- Envoy logs: `docker-compose -f ./example/docker-compose.yml logs -f envoy-logs`.
-- Critical wasm (audit) logs: `docker-compose -f ./example/docker-compose.yml logs -f wasm-logs`
+The Envoy example comes also with a Grafana dashboard that can be accessed at `localhost:3000` (admin/admin) in order to monitor the memory consumption.
 
 ### Manual requests
 

e2e/docker-compose.yml

@@ -15,6 +15,10 @@ services:
     command:
       - -c
       - /conf/envoy-config.yaml
+      - --service-cluster # required to export metrics
+      - envoy
+      - --service-node # required to export metrics
+      - envoy
     volumes:
       - ../build:/build
       - .:/conf

example/envoy/docker-compose.yml

@@ -30,13 +30,17 @@ services:
       - --log-format [%Y-%m-%d %T.%f][%t][%l][%n] [%g:%#] %v
       - --log-path
       - /home/envoy/logs/envoy.log
+      - --service-cluster # required to export metrics
+      - envoy
+      - --service-node # required to export metrics
+      - envoy
     volumes:
       - ../../build:/build
       - .:/conf
       - logs:/home/envoy/logs:rw
     ports:
       - 8080:8080
-      - 8082:8082
+      - 8082:8082 # admin port (also for metrics)
 
   envoy-logs:
     depends_on:
@@ -61,5 +65,23 @@ services:
     volumes:
       - logs:/home/envoy/logs:ro
 
+  prometheus:
+    image: prom/prometheus
+    volumes:
+      - ./prometheus.yaml:/etc/prometheus.yaml
+    ports:
+    - "9090:9090"
+    command: "--config.file=/etc/prometheus.yaml"
+
+  grafana:
+    image: grafana/grafana
+    volumes:
+      - ./grafana/grafana.ini:/etc/grafana/grafana.ini
+      - ./grafana/datasource.yaml:/etc/grafana/provisioning/datasources/datasource.yaml
+      - ./grafana/dashboard.yaml:/etc/grafana/provisioning/dashboards/dashboard.yaml
+      - ./grafana/dashboard.json:/etc/grafana/provisioning/dashboards/dashboard.json
+    ports:
+    - "3000:3000"
+
 volumes:
   logs:

example/envoy/envoy-config.yaml

@@ -30,7 +30,7 @@ static_resources:
                   # A custom response header is added for e2e testing purposes. A local response, triggered by an interruption,
                   # has to allow custom added headers like this. See https://github.com/corazawaf/coraza-proxy-wasm/pull/172
                   response_headers_to_add:
-                    - header: 
+                    - header:
                         key: "custom_header"
                         value: "custom_value"
                   virtual_hosts: