Intégration domotique Cloudflare Tunnel Monitor, gratuite et open source

Surveillez vos tunnels Cloudflare : état, connexions, alertes et scènes.

• Publiée par prohand
• Appareils
• Version 0.0.1
• Nécessite Gladys >=5.1.0
• ★ 0

Voir sur GitHubToutes les intégrations

Cette intégration surveille vos tunnels Cloudflare (cloudflared) depuis Gladys : chaque tunnel est-il en ligne, combien de connexions tient-il, et le cloudflared qui tourne chez vous est-il toujours connecté ? Chaque tunnel devient un appareil Gladys, un changement d'état peut lancer une scène, et un widget de tableau de bord montre tout d'un coup d'œil.

Elle ne fait que lire : elle ne crée, ne modifie et ne supprime jamais de tunnel.

Deux sources, utilisez-en une ou les deux

Source	Ce qu'il faut	Ce que vous obtenez
Cloud	Un jeton d'API Cloudflare et votre ID de compte	Tous les tunnels du compte, avec l'état calculé par Cloudflare
Local	L'adresse metrics d'un cloudflared sur le réseau	L'état de ce connecteur — il répond même quand Internet est coupé

Le mieux est d'utiliser les deux : le cloud voit tous les tunnels, le connecteur local répond encore quand c'est le lien Internet qui est tombé.

Cloud : créer le jeton d'API

1. Ouvrez le tableau de bord Cloudflare, puis Mon profil → Jetons d'API (https://dash.cloudflare.com/profile/api-tokens).
2. Créer un jeton → Jeton personnalisé → Commencer.
3. Donnez-lui un nom (ex. Gladys) et ajoutez une seule permission : Compte → Cloudflare Tunnel → Lecture.
4. Dans Ressources du compte, incluez le compte qui porte vos tunnels.
5. Continuer vers le résumé → Créer le jeton, puis copiez le jeton. Cloudflare ne l'affiche qu'une fois.

Le jeton est en lecture seule : même s'il fuitait, personne ne pourrait modifier un tunnel avec.

Cloud : trouver l'ID de compte

Dans le tableau de bord Cloudflare, ouvrez votre compte : l'ID de compte est affiché sur la page Vue d'ensemble (colonne de droite), ou dans le menu du compte → Copier l'ID de compte. Il fait 32 caractères : des chiffres et des lettres de a à f.

Local : exposer les métriques de cloudflared

cloudflared a un petit serveur de métriques. Par défaut il n'écoute que sur la machine elle-même, sur un port au hasard : donnez-lui une adresse fixe que Gladys peut joindre.

• En ligne de commande : ajoutez --metrics 0.0.0.0:2000, par exemple cloudflared tunnel --metrics 0.0.0.0:2000 run --token <jeton du tunnel>.
• Dans config.yml : ajoutez la ligne metrics: 0.0.0.0:2000.
• Avec Docker : même option dans la commande, et publiez le port (-p 2000:2000).

Vérifiez depuis une autre machine : curl http://<hôte cloudflared>:2000/ready doit répondre quelque chose comme {"status":200,"readyConnections":4,"connectorId":"…"}.

Le serveur de métriques ne montre aucun secret, mais gardez-le sur votre réseau local : n'ouvrez pas ce port sur Internet.

Configuration

Champ	Rôle
Jeton d'API Cloudflare	Le jeton créé plus haut. Laissez vide pour n'utiliser que les connecteurs locaux.
ID de compte Cloudflare	L'ID de 32 caractères trouvé plus haut.
Connecteurs cloudflared locaux	Adresses metrics, séparées par des virgules : http://192.168.1.10:2000, http://nas.lan:2000.
Intervalle de vérification (s)	Secondes entre deux vérifications, de 30 à 3600 (60 par défaut).

Le réglage Préférer la connexion locale, affiché par Gladys sous le formulaire, choisit la source montrée pour un tunnel qui a les deux (voir plus bas).

Cliquez ensuite sur Tester la connexion : la réponse dit, pour chaque source, ce qui a répondu et ce qu'il faut corriger.

Appareils

Les appareils apparaissent dans l'onglet Découverte de l'intégration : ajoutez ceux que vous voulez suivre.

Un appareil par tunnel (cloud)

Fonctionnalité	Valeurs
Status	healthy, degraded, down ou inactive
Online	1 quand le tunnel fait passer du trafic (sain ou dégradé), 0 sinon
Active connections	Nombre de connexions vers le réseau de Cloudflare

Ce que veulent dire les états, selon Cloudflare :

• healthy (sain) : le tunnel fonctionne normalement ;
• degraded (dégradé) : il fait encore passer du trafic, mais il manque des connexions ou des connecteurs ;
• down (hors ligne) : plus aucune connexion, le tunnel ne peut plus faire passer de trafic ;
• inactive (inactif) : le tunnel n'a jamais été lancé.

Renommer un tunnel chez Cloudflare garde son appareil Gladys : l'appareil est lié à l'ID du tunnel, pas à son nom.

Un appareil par connecteur local

Fonctionnalité	Valeurs
Ready	1 quand le connecteur tient au moins une connexion
Ready connections	Nombre de connexions qu'il tient (4 par défaut)

Le badge de chaque appareil

• local : l'état vient d'un cloudflared de votre réseau ;
• cloud : il vient de l'API Cloudflare ;
• injoignable : aucune source ne répond pour cet appareil.

Quand un connecteur local sert un tunnel de votre compte, l'intégration les relie toute seule (grâce à l'ID de connecteur donné par Cloudflare). Ensuite, avec Préférer la connexion locale activé, le tunnel montre la vue locale ; désactivé, la vue Cloudflare. Si la source préférée tombe, l'autre prend le relais et le badge prend un point orange avec la raison.

Scènes

Déclencheurs

• Un tunnel Cloudflare change d'état — filtre sur le tunnel et sur le nouvel état. Variables : nom du tunnel, nouvel état, état précédent, connexions actives. Exemple : « quand le tunnel home passe Hors ligne, envoie-moi un message ».
• Un connecteur cloudflared local change d'état — filtre sur le connecteur et sur Prêt, Non prêt, Injoignable.
• L'API Cloudflare ne répond plus — déclenché une fois quand l'API commence à échouer (jeton refusé, compte inconnu, pas d'Internet…), pas à chaque vérification.

Chaque déclencheur part une fois par changement. Le dernier état connu est gardé sur disque : un changement qui arrive pendant un redémarrage de Gladys est quand même vu.

Actions

• Vérifier les tunnels Cloudflare maintenant — lance une vérification tout de suite. Donne : nombre de tunnels, tunnels sains, tunnels en anomalie, et « tous les tunnels sains » (oui/non), à tester dans les actions suivantes.
• Lire l'état d'un tunnel — donne le nom, l'état, en ligne (oui/non) et les connexions actives d'un tunnel ou d'un connecteur local, d'après la dernière vérification.

Widget de tableau de bord

Ajoutez le widget Tunnels Cloudflare à un tableau de bord. Il montre :

• le nombre de tunnels sains, et de tunnels en anomalie ;
• le nombre de connecteurs locaux prêts (si vous en avez) ;
• une ligne par tunnel (les anomalies d'abord) et par connecteur, avec son état et ses connexions ;
• un bouton Vérifier.

En cas de problème

Message	Que faire
Cloudflare refuse le jeton d'API	Vérifiez le jeton, et sa permission Compte → Cloudflare Tunnel → Lecture.
Cloudflare ne connaît pas cet ID de compte	Recopiez l'ID de compte ; vérifiez que le jeton inclut ce compte.
L'API Cloudflare est injoignable	Vérifiez que Gladys a accès à Internet (DNS, pare-feu).
Un connecteur affiche pas de réponse	Vérifiez --metrics 0.0.0.0:<port> sur cloudflared, le port, et curl http://hôte:port/ready.
Un connecteur répond mais ne tient aucune connexion	cloudflared tourne mais ne joint pas Cloudflare : regardez ses propres logs.

Vie privée

Le jeton est stocké dans Gladys et envoyé uniquement à api.cloudflare.com, en HTTPS. Il n'est jamais écrit dans les logs. Les connecteurs locaux sont lus sur votre réseau, sans aucun jeton.

Paramètres de configuration

Voici les paramètres demandés par Cloudflare Tunnel Monitor dans son écran de configuration dans Gladys.

Paramètre	Type	Obligatoire	Description
Pour commencer	section	Non	Deux sources, utilisez-en une ou les deux. Cloud : un jeton d'API Cloudflare avec la permission Compte › Cloudflare Tunnel › Lecture, et votre ID de compte — chaque tunnel du compte devient un appareil. Local : l'adresse metrics d'un connecteur cloudflared de votre réseau (lancé avec --metrics 0.0.0.0:2000) — elle répond même quand le lien Internet est coupé.
Jeton d'API Cloudflare	secret	Non	Jeton en lecture seule : Compte › Cloudflare Tunnel › Lecture. Laissez vide pour n'utiliser que les connecteurs locaux.
ID de compte Cloudflare	string	Non	32 caractères hexadécimaux, affichés sur la page Vue d'ensemble du tableau de bord Cloudflare.
Connecteurs cloudflared locaux	string	Non	Adresses metrics de vos instances cloudflared, séparées par des virgules. Laissez vide pour n'utiliser que l'API Cloudflare.
Intervalle de vérification (s)	number	Non	Secondes entre deux vérifications de tous les tunnels et connecteurs (30 à 3600).

Comment installer Cloudflare Tunnel Monitor dans Gladys

1. Dans Gladys, ouvrez Intégrations : Cloudflare Tunnel Monitor apparaît dans le catalogue, aux côtés des intégrations natives, avec un badge communautaire.
2. Cliquez sur Installer. Gladys télécharge l'image Docker (ghcr.io/prohand/gladys-cloudflaretunnelmonitor:0.0.1), la démarre dans un bac à sable isolé du cœur, et génère l'interface de l'intégration (appareils, découverte et configuration).
3. Ouvrez l'écran Configuration de l'intégration, remplissez les paramètres, puis enregistrez.
4. Vous pouvez aussi l'installer directement depuis l'URL de son dépôt : https://github.com/prohand/gladys-cloudflaretunnelmonitor.

Cloudflare Tunnel Monitor nécessite Gladys >=5.1.0. Le catalogue dans Gladys se rafraîchit toutes les heures : une nouvelle version est donc disponible au plus tard une heure après sa sortie.

Vous n'utilisez pas encore Gladys ? C'est gratuit et open source : suivez le guide d'installation pour démarrer.

À propos des intégrations externes

Cloudflare Tunnel Monitor est une intégration externe : une intégration communautaire empaquetée dans un conteneur Docker et publiée sur GitHub, que Gladys installe en un clic et exécute dans un bac à sable isolé de son cœur. Elle est publiée et maintenue par prohand, et non par l'équipe cœur de Gladys.

• Parcourir toutes les intégrations, natives et communautaires
• Créer et publier votre propre intégration externe
• Code source sur GitHub — source de cette documentation

Inscrivez-vous à la newsletter Gladys Assistant

Quelques emails par mois sur les nouveautés et l'actualité du projet. Envoyés par Pierre-Gilles Leymarie, le fondateur du projet. Désinscription possible à tout moment 🙂