chore(monitoring): docker compose configuration for Grafana & Prometh…

…eus (paradigmxyz#1391)

etc/README.md

@@ -7,4 +7,18 @@ The files in this directory may undergo a lot of changes while reth is unstable,
 ### Overview
 
 - [**Prometheus**](./prometheus/prometheus.yml): An example Prometheus configuration.
-- [**Grafana**](./grafana/): Example Grafana dashboards.
+- [**Grafana**](./grafana/): Example Grafana dashboards & data sources.
+
+### Docker Compose
+
+To run Grafana dashboard with example dashboard and pre-configured Prometheus data source pointing at
+the locally running Reth instance with metrics exposed on `localhost:9000`:
+```sh
+docker compose -p reth -f ./etc/docker-monitoring.yml up
+```
+
+After that, Grafana will be exposed on `localhost:3000` and accessible via default credentials:
+```
+username: admin
+password: admin
+```

etc/docker-monitoring.yml

@@ -0,0 +1,39 @@
+version: '3'
+
+services:
+  prometheus:
+    image: prom/prometheus
+    ports:
+      - 9090:9090
+    volumes:
+      - ./prometheus/:/etc/prometheus/
+      - prometheus_data:/prometheus
+    command:
+      - --config.file=/etc/prometheus/prometheus.yml
+      - --storage.tsdb.path=/prometheus
+    extra_hosts:
+      - "host.docker.internal:host-gateway" # https://stackoverflow.com/a/43541732/5204678
+
+  grafana:
+    image: grafana/grafana
+    ports:
+      - 3000:3000
+    environment:
+      PROMETHEUS_URL: http://prometheus:9090
+    # 1. Copy dashboards from temp directory to prevent modifying original host files
+    # 2. Replace Prometheus datasource placeholder with the actual name
+    # 3. Run Grafana
+    entrypoint: >
+      sh -c "cp -r /etc/grafana/provisioning_temp/dashboards/. /etc/grafana/provisioning/dashboards &&
+             find /etc/grafana/provisioning/dashboards/ -name '*.json' -exec sed -i 's/$${DS_PROMETHEUS}/Prometheus/g' {} \+ &&
+             /run.sh"
+    volumes:
+      - grafana_data:/var/lib/grafana
+      - ./grafana/datasources:/etc/grafana/provisioning/datasources
+      - ./grafana/dashboards:/etc/grafana/provisioning_temp/dashboards
+    depends_on:
+      - prometheus
+
+volumes:
+  prometheus_data:
+  grafana_data:

etc/grafana/dashboards/dashboard.yml

@@ -0,0 +1,7 @@
+apiVersion: 1
+
+providers:
+  - name: 'Folder'
+    allowUiUpdates: true
+    options:
+      path: /etc/grafana/provisioning/dashboards

etc/grafana/datasources/prometheus.yml

@@ -0,0 +1,8 @@
+apiVersion: 1
+
+datasources:
+  - name: Prometheus
+    type: prometheus
+    access: proxy
+    url: $PROMETHEUS_URL
+    editable: true

etc/prometheus/prometheus.yml

@@ -3,5 +3,4 @@ scrape_configs:
     metrics_path: "/"
     scrape_interval: 5s
     static_configs:
-      - targets: ['localhost:9000']
-
+      - targets: ['localhost:9000', 'host.docker.internal:9000']