feat: Attached promtheus/grafana services with docker

Author: lla-dane

.gitignore

@@ -196,3 +196,4 @@ _build/
 # Attack simulation test results
 tests/security/attack_simulation/results/
 libp2p-forge
+libp2p-metrics

examples/metrics/coordinator.py

@@ -59,8 +59,6 @@ async def command_executor(self, nursery):
                         await self.host.connect(info)
                         await self.ping_service.ping(info.peer_id, int(parts[2]))
 
-                        # Then the rtts will be fed to the prometheus-metrics
-
                     if cmd == "local":
                         maddr = self.host.get_addrs()[0]
                         print(maddr)

libp2p/metrics/docker-compose.yml

@@ -0,0 +1,18 @@
+services:
+  prometheus:
+    image: prom/prometheus:latest
+    container_name: prometheus
+    volumes:
+      - ./prometheus.yml:/etc/prometheus/prometheus.yml:ro
+    ports:
+      - "${PROMETHEUS_PORT}:9090"
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+
+  grafana:
+    image: grafana/grafana:latest
+    container_name: grafana
+    ports:
+      - "${GRAFANA_PORT}:3000"
+    depends_on:
+      - prometheus

libp2p/metrics/metrics.py

@@ -1,8 +1,22 @@
+import socket
+
 from prometheus_client import start_http_server
 import trio
+
 from libp2p.host.ping import PingEvent
 from libp2p.metrics.ping import PingMetrics
-from libp2p.utils.address_validation import find_free_port
+
+
+def find_available_port(start_port: int = 8000, host: str = "127.0.0.1") -> int:
+    port = start_port
+
+    while True:
+        with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
+            try:
+                sock.bind((host, port))
+                return port
+            except OSError:
+                port += 1
 
 
 class Metrics:
@@ -15,15 +29,26 @@ async def start_prometheus_server(
         self,
         metric_recv_channel: trio.MemoryReceiveChannel,
     ) -> None:
-        
-        free_port = find_free_port()
-        start_http_server(free_port)
-        
-        print(f"Prometheus server started: http://localhost:{free_port}")
+        metrics = find_available_port(8000)
+        prometheus_dashboard = find_available_port(9000)
+        grafana_dashboard = find_available_port(7000)
+
+        start_http_server(metrics)
+
+        print(f"\nPrometheus metrics visible at: http://localhost:{metrics}")
+        print(
+            f"Prometheus dashboard visible at: http://localhost:{prometheus_dashboard}"
+        )
+        print(f"Grafana dashboard visible at: http://localhost:{grafana_dashboard}\n")
+
+        print(
+            "\nStart prometheus and grafana dashboard, for another terminal: \n"
+            f"PROMETHEUS_PORT={prometheus_dashboard} GRAFANA_PORT={grafana_dashboard} docker compose up\n"
+        )
 
         while True:
             event = await metric_recv_channel.receive()
-            
+
             match event:
                 case PingEvent():
-                    self.ping.record(event)
+                    self.ping.record(event)

libp2p/metrics/prometheus.yml

@@ -0,0 +1,8 @@
+global:
+  scrape_interval: 5s
+
+scrape_configs:
+  - job_name: "libp2p-python"
+    static_configs:
+      - targets:
+          - "host.docker.internal:8000"

libp2p/utils/paths.py

@@ -17,6 +17,8 @@
 AUTOTLS_CERT_PATH = Path("libp2p-forge/peer1/autotls-cert.pem")
 AUTOTLS_KEY_PATH = Path("libp2p-forge/peer1/autotls-key.pem")
 
+METRICS_CONFIG_PATH = Path("libp2p-metrics/.config")
+
 
 def get_temp_dir() -> Path:
     """