Ajout de l'exporteur de métriques pour prometheus

LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2023 Libretic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,37 +1,75 @@
 # Role : docker_jitsimeet
 
-## Services fournis
+Installation de jitsimeet sur un serveur docker_host
-
-- main.yml : Installation de jitsimeet sur un serveur docker_host
 
 ## Variables
 
 Fournir les variables suivantes. Par exemple :
 
 ```yaml
+# Le fqdn pour accéder à jitsimeet
 docker_jitsimeet_fqdn: jitsimeet.example.com
+# Version de l'image jitsimeet
 docker_jitsimeet_version: stable-7648-4
+# L'emplacement dans lequel se trouvent les volumes de donnees docker pour le service
 docker_jitsimeet_data_dir: /data1
+# Le nom de service souhaité : conditionne le nommage des dossiers et le routage par traefik
 docker_jitsimeet_service_id: jitsimeet
-
+# Mdp de jicofo ; générer avec `openssl rand -hex 16`
 docker_jitsimeet_jicofo_auth_password: "coller_ici_jicofo_auth_password"
+# Mdp de jvb ; générer avec `openssl rand -hex 16`
 docker_jitsimeet_jvb_auth_password: "coller_ici_jvb_auth_password"
+# Adresse du serveur docker sur lequel écoute le service jvb
 docker_jitsimeet_jvb_host_address: 10.11.12.13
+```
 
+## Notes de réunion
+
+Pour utiliser un serveur etherpad comme support de notes collectives à la réunion, ajouter les variables suivantes :
+
+```yaml
+# Active l'utilisation d'un serveur etherpad
+docker_jitsimeet_etherpad_enabled: true
+# Adresse du serveur sur lequel partager un document par réunion
 docker_jitsimeet_etherpad_public_url: https://pad.libretic.fr
 ```
 
-| Option                                  | Valeur par défaut | Description                                                                                  |
+## Serveur TURN
-|-----------------------------------------|-------------------|----------------------------------------------------------------------------------------------|
+
-| docker_jitsimeet_fqdn                   |                   | Le fqdn pour accéder à jitsimeet                                                             |
+Pour utiliser un serveur turn, ajouter les variables suivantes :
-| docker_jitsimeet_version                |                   | Version de l'image jitsimeet                                                                 |
+
-| docker_jitsimeet_data_dir               |                   | L'emplacement dans lequel se trouvent les volumes de donnees docker pour le service          |
+```yaml
-| docker_jitsimeet_service_id             |                   | Le nom de service souhaité : conditionne le nommage des dossiers et le routage par traefik   |
+# Active l'utilisation d'un serveur turn
-| docker_jitsimeet_jicofo_auth_password   |                   | Mdp de jicofo ; générer avec `openssl rand -hex 16`                                          |
+docker_jitsimeet_turnserver_enabled: true
-| docker_jitsimeet_jvb_auth_password      |                   | Mdp de jvb ; générer avec `openssl rand -hex 16`                                             |
+# Adresse du serveur turn à utiliser
-| docker_jitsimeet_jvb_host_address       |                   | Adresse du serveur docker sur lequel écoute le service jvb                                   |
+docker_jitsimeet_turnserver_fqdn: turn.example.com
-| docker_jitsimeet_etherpad_public_url    |                   | Si précisé, indique à Jitsi un serveur sur lequel partager un document par réunion           |
+# Secret partagé avec le serveur turn
-| docker_jitsimeet_turnserver_fqdn        |                   | Si précisé, indique à Jitsi un serveur turn à utiliser                                       |
+docker_jitsimeet_turnserver_credentials: mdp_du_turnserver
-| docker_jitsimeet_turnserver_credentials |                   | Si docker_jitsimeet_turnserver_fqdn précisé, un secret partagé avec le serveur turn          |
+# Port de connexion au serveur turn
-| docker_jitsimeet_turnserver_port        |                   | Si docker_jitsimeet_turnserver_fqdn précisé, le port de connexion au serveur turn à utiliser |
+docker_jitsimeet_turnserver_port: 1234
-| docker_jitsimeet_turnserver_transport   |                   | Si docker_jitsimeet_turnserver_fqdn précisé, le transport à utiliser (tcp ou udp)            |
+# Transport à utiliser (tcp ou udp)
+docker_jitsimeet_turnserver_transport: tcp
+```
+
+## Métriques 
+
+Pour activer l'export de métriques par jvb, fournir les variables suivantes :
+
+```yaml
+docker_jitsimeet_exporter_enabled: true
+docker_jitsimeet_exporter_port: 9888
+```
+
+Jvb peut alors servir les metriques en json sur l'adresse http://jvb:8080/colibri/stats.
+
+Une fois les métriques activées, leur collecte peut se faire par prometheus par scrutation de l'adresse du serveur sur le port indiqué.
+
+Exemple de job prometheus :
+```yaml
+- job_name: 'jitsi'
+  static_configs:
+    - targets:
+      - adresse_hote_docker:9888
+```
+
+Un exemple de tableau de bord grafana utilisable avec les métriques collectées sur prometheus : https://github.com/systemli/prometheus-jitsi-meet-exporter/tree/main/dashboards

defaults/main.yml

@@ -0,0 +1,4 @@
+docker_jitsimeet_etherpad_enabled: false
+docker_jitsimeet_turnserver_enabled: false
+docker_jitsimeet_exporter_enabled: false
+docker_jitsimeet_exporter_port: "9888"

templates/docker-compose.yml

@@ -13,7 +13,7 @@ services:
     environment:
       - PUBLIC_URL=https://{{ docker_jitsimeet_fqdn }}
       - JICOFO_AUTH_PASSWORD={{ docker_jitsimeet_jicofo_auth_password }}
-{% if docker_jitsimeet_etherpad_public_url is defined %}
+{% if docker_jitsimeet_etherpad_enabled %}
       - ETHERPAD_PUBLIC_URL={{ docker_jitsimeet_etherpad_public_url }}
 {% endif %}
     labels:
@@ -41,7 +41,7 @@ services:
       - PUBLIC_URL=https://{{ docker_jitsimeet_fqdn }}
       - JICOFO_AUTH_PASSWORD={{ docker_jitsimeet_jicofo_auth_password }}
       - JVB_AUTH_PASSWORD={{ docker_jitsimeet_jvb_auth_password }}
-{% if docker_jitsimeet_turnserver_fqdn is defined %}
+{% if docker_jitsimeet_turnserver_enabled %}
       - TURN_CREDENTIALS={{ docker_jitsimeet_turnserver_credentials }}
       - TURN_HOST={{ docker_jitsimeet_turnserver_fqdn }}
       - TURN_PORT={{ docker_jitsimeet_turnserver_port }}
@@ -71,19 +71,39 @@ services:
     restart: always
     ports:
       - '10000:10000/udp'
-#      - '127.0.0.1:8080:8080'
     volumes:
       - {{ docker_jitsimeet_data_dir }}/{{ docker_jitsimeet_service_id }}/jvb:/config
     environment:
       - PUBLIC_URL=https://{{ docker_jitsimeet_fqdn }}
       - DOCKER_HOST_ADDRESS={{ docker_jitsimeet_jvb_host_address }}
       - JVB_AUTH_PASSWORD={{ docker_jitsimeet_jvb_auth_password }}
+{% if docker_jitsimeet_exporter_enabled %}
+      # metriques
+      - COLIBRI_REST_ENABLED=true
+      - JVB_ENABLE_APIS=rest,colibri
+      - JVB_TCP_API_PORT=8080
+      - JVB_TCP_MAPPED_API_PORT=8080
+{% endif %}
     depends_on:
       - prosody
     networks:
       - jitsimeet
       - jitsivideo
 
+{% if docker_jitsimeet_exporter_enabled %}
+  exporter:
+    image: systemli/prometheus-jitsi-meet-exporter:latest
+    restart: always
+    command: -videobridge-url http://jvb:8080/colibri/stats
+    ports:
+      - {{ docker_jitsimeet_exporter_port }}:9888    
+    depends_on:
+      - jvb
+    networks:
+      - jitsivideo
+      - traefik
+
+{% endif %}
 networks:
   traefik:
     external: true