feat: add health check and heartbeat endpoint to Docker setup

feat: enhance WebRTC stats collection by logging connection state changes

Dockerfile

@@ -4,10 +4,15 @@ FROM python:3.13.1-slim-bookworm
 COPY requirements.txt /app/requirements.txt
 RUN pip install --no-cache-dir -r /app/requirements.txt
 
+# Install curl
+RUN apt-get update && apt-get install -y curl
+
 # Copy the application
 COPY main.py /app
 COPY utils/ /app/utils
 WORKDIR /app
 
+HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 CMD curl -f http://localhost/heartbeat || exit 1
+
 # Run the application
 CMD ["python", "main.py"]

README.md

@@ -15,7 +15,7 @@ peertube-collector is a project designed to collect and analyze WebRTC statistic
 
 Ports can be opened in the host machine's firewall with:
 ```sh
-ufw allow from 172.30.0.0/16 to any port 4444
+ufw allow from 172.100.0.0/16 to any port 4444
 ```
 
 #### External (OPTIONAL):
@@ -48,7 +48,7 @@ ufw allow 27107/tcp
 
 4. Start the Docker containers:
     ```sh
-    docker compose up
+    docker compose up --abort-on-container-exit
     ```
     or in detached mode:
     ```sh
@@ -97,29 +97,8 @@ peertube-collector/
 └── webrtc-internals-exporter/
 ```
 
----
+# Credits
 
-# Server
-
-The repository contains a `server` directory with a simple MongoDB server (with initializations scripts) and WebUI that serves the WebRTC stats collected by the collector.
-
-Based this awesome example configuration: [MongoDB Docker Compose examples](https://github.com/TGITS/docker-compose-examples/tree/main/mongodb-docker-compose-examples).
-
-## Setup
-
-1. Change to the `server` directory:
-    ```sh
-    cd server
-    ```
-
-2. Create and configure the environment file based on the `.env.example` file:
-    ```sh
-    cp .env.example .env
-    ```
-
-3. Start the Docker containers:
-    ```sh
-    docker compose up
-    ```
-
-The WebUI control panel will be available at [http://localhost:8081](http://localhost:8081).
+- [WebRTC Internals Exporter](https://github.com/vpalmisano/webrtc-internals-exporter)
+  - [WebRTC debugging with Prometheus/Grafana](https://medium.com/@vpalmisano/webrtc-debugging-with-prometheus-grafana-254b6ac71063)
+- [MongoDB Docker Compose examples](https://github.com/TGITS/docker-compose-examples/tree/main/mongodb-docker-compose-examples)

docker-compose.yml

@@ -14,6 +14,7 @@ services:
       interval: 5s
       timeout: 10s
       retries: 5
+    pull_policy: always
     network_mode: host
 
   telegraf:
@@ -30,6 +31,7 @@ services:
       interval: 5s
       timeout: 10s
       retries: 5
+    pull_policy: always
     networks:
       - backend
 
@@ -50,6 +52,7 @@ services:
       - "9092:9092"
     extra_hosts:
       - "host.docker.internal:host-gateway"
+    pull_policy: always
     networks:
       - backend
 
@@ -57,4 +60,4 @@ networks:
   backend:
     ipam:
       config:
-        - subnet: 172.30.0.0/16
+        - subnet: 172.100.0.0/16

main.py

@@ -4,6 +4,7 @@ import time
 import socket
 import logging
 import os
+from yaspin import yaspin
 from functools import partial
 from http.server import HTTPServer
 from utils.PostHandler import Handler
@@ -34,6 +35,7 @@ def interrupt_handler(signum, driver: webdriver.Remote):
     driver.quit()
     raise SystemExit
 
+@yaspin()
 def setupChromeDriver():
     logger.log(logging.INFO, 'Setting up Chrome driver.')
     chrome_options = Options()
@@ -160,6 +162,7 @@ def downloadStats(driver: webdriver.Chrome, peersDict: dict):
 def convert_to_bytes(down, downUnit):
     return float(down) * (1024 ** {'B': 0, 'KB': 1, 'MB': 2, 'GB': 3}[downUnit])
 
+@yaspin()
 def setupStats(driver: webdriver.Remote, url: str):
     logger.log(logging.INFO, 'Setting up stats.')
     actions = ActionChains(driver)
@@ -167,7 +170,13 @@ def setupStats(driver: webdriver.Remote, url: str):
 
     driver.get(url)
 
+    try:
         wait.until(ec.presence_of_element_located((By.CLASS_NAME, 'vjs-big-play-button')))
+    except Exception:
+        logger.error('Timeout while waiting for the big play button to be present.')
+        driver.quit()
+        raise SystemExit(1)
+
     actions.click(driver.find_element(By.CLASS_NAME ,'video-js')).perform()
     wait.until(ec.visibility_of_element_located((By.CLASS_NAME, 'vjs-control-bar')))
     actions.context_click(driver.find_element(By.CLASS_NAME ,'video-js')).perform()
@@ -193,7 +202,6 @@ if __name__ == '__main__':
     
     setupStats(driver, url)
     
-    logger.log(logging.INFO, 'Starting server collector.')
+    logger.info('Starting server collector.')
     httpd = HTTPServer(('', 9092), partial(Handler, downloadStats, driver, logger))
-    logger.info('Server collector started.')
     httpd.serve_forever()

requirements.txt

@@ -1,2 +1,3 @@
 selenium
 beautifulsoup4
+yaspin

server/README.md

@@ -0,0 +1,30 @@
+# Server
+
+The repository contains a `server` directory with a simple MongoDB server (with initializations scripts) and WebUI that serves the WebRTC stats collected by the collector.
+
+It's not mandatory to run and use this service, it's provided just as an example of how to store collected data.
+
+## Setup
+
+1. Change to the `server` directory:
+    ```sh
+    cd server
+    ```
+
+2. Create and configure the environment file based on the `.env.example` file:
+    ```sh
+    cp .env.example .env
+    ```
+
+3. Start the Docker containers:
+    ```sh
+    docker compose up
+    ```
+
+The WebUI control panel will be available at [http://localhost:8081](http://localhost:8081).
+
+# Credits
+
+- [WebRTC Internals Exporter](https://github.com/vpalmisano/webrtc-internals-exporter)
+  - [WebRTC debugging with Prometheus/Grafana](https://medium.com/@vpalmisano/webrtc-debugging-with-prometheus-grafana-254b6ac71063)
+- [MongoDB Docker Compose examples](https://github.com/TGITS/docker-compose-examples/tree/main/mongodb-docker-compose-examples)

utils/PostHandler.py

@@ -24,6 +24,11 @@ class Handler(BaseHTTPRequestHandler):
             self.wfile.write(b'404 Not Found')
             
     def do_GET(self):
+        if self.path == '/heartbeat':
+            self.send_response(200)
+            self.end_headers()
+            self.wfile.write(b'Heartbeat OK')
+        else:
             self.send_response(404)
             self.end_headers()
             self.wfile.write(b'404 Not Found')

webrtc-internals-exporter/override.js

@@ -22,7 +22,7 @@ class WebrtcInternalExporter {
     });
 
     window.postMessage({ event: "webrtc-internal-exporter:ready" });
-    this.collectAllStats();
+    setInterval(() => this.collectAndPostAllStats(), this.updateInterval);
   }
 
   randomId() {
@@ -40,6 +40,9 @@ class WebrtcInternalExporter {
     pc.iceCandidateErrors = [];
     this.peerConnections.set(id, pc);
     pc.addEventListener("connectionstatechange", () => {
+      log(`connectionStateChange: ${pc.connectionState}`);
+      this.collectAndPostAllStats();
+
       if (pc.connectionState === "closed") {
         this.peerConnections.delete(id);
       }
@@ -83,24 +86,27 @@ class WebrtcInternalExporter {
   }
 
   async collectAndPostSingleStat(id) {
-    const stats = await this.collectStats(id, this.collectAndPostSingleStat);
+    const stats = await this.collectStats(id);
     if (Object.keys(stats).length === 0 || !stats) return;
 
     window.postMessage(
       {
         event: "webrtc-internal-exporter:peer-connection-stats",
-        stats
+        stats: [stats]
       },
-      stats
+      [stats]
     );
+
+    log(`Single stat collected:`, [stats]);
   }
 
-  async collectAllStats() {
+  async collectAndPostAllStats() {
     const stats = [];
 
-    for (const [id, pc] of this.peerConnections) {
+    for (const [id] of this.peerConnections) {
       if (this.url && this.enabled) {
-        const pcStats = await this.collectStats(id, pc);
+        const pcStats = await this.collectStats(id);
+        if (Object.keys(pcStats).length === 0 || !pcStats) continue;
         stats.push(pcStats);
       }
     }
@@ -108,28 +114,24 @@ class WebrtcInternalExporter {
     window.postMessage(
       {
         event: "webrtc-internal-exporter:peer-connections-stats",
-        data: JSON.parse(JSON.stringify(stats)),
+        data: stats
       },
+      stats
     );
 
-    log(`Stats collected:`, JSON.parse(JSON.stringify(stats)));
+    log(`Stats collected:`, stats);
     
-    setTimeout(this.collectAllStats.bind(this), this.updateInterval);
     return stats;
   }
 
   /**
    * @param {string} id
-   * @param {RTCPeerConnection} pc
-   * @param {Function} binding
    */
-  async collectStats(id, pc, binding) {
-    var completeStats = {};
-
-    if (!pc) {
-      pc = this.peerConnections.get(id);
+  async collectStats(id) {
+    var pc = this.peerConnections.get(id);
     if (!pc) return;
-    }
+
+    var completeStats = {};
 
     if (this.url && this.enabled) {
       try {
@@ -157,10 +159,6 @@ class WebrtcInternalExporter {
 
     if (pc.connectionState === "closed") {
       this.peerConnections.delete(id);
-    } else {
-      if (binding) {
-        setTimeout(binding.bind(this), this.updateInterval, id);
-      }
     }
 
     return completeStats;