[TUTO] Monitorer sa Freebox Revolution

[uzurka]

Hello !
Pour revenir la dessus :

Citation

J'ai arrêté d'utiliser ce dashboard lorsque je suis passé à la pop (c'était trop contraignant de refaire l'autorisation sur la box à chaque maj)

Je confirme que de mon côté et avec mon image également, l'autorisation saute régulièrement. Je n'avais pas fait le rapprochement avec les MAJs, mais c'est pas incohérent que ce sois lié. Cependant, la ré-autorisation avec mon image sera sans doute plus simple, puisqu'il suffira de supprimer l'app dans FreeboxOS, supprimer le token présent et redémarrer le conteneur. Je verrai pour simplifier davantage le process avec une option dans l'entrypoint quand j'aurais le temps.

 

Pour ce qui est de l'export des stats wifi, c'est surement dû à un changement dans l'API de FreeboxOS. Un coup de main de @bruno78 sur ce sujet serais le bienvenu 🙂

[avlc]

  

Le 12/5/2023 à 10:40 AM, Dynaloo a dit :

Bonjour,

@bruno78 @Jeff777

Déjà, en premier, je tiens à remercier tous les participants qui ont contribués au développement de l'API pour le monitoring de la Freebox sur "Grafana". J'espère que ce sujet n'est pas abandonné et toujours suivi...

Je suis sur une Freebox POP (Freebox v8(r1))

J'ai tout installé sur un Serveur Proxmox avec les options :  freebox_061.py -SPHDIWXYZ,

Tous les métriques remontes bien sur Grafana.

 - Sauf pour les métriques concernant le Wifi qui ne remonte pas !!!  ☹️

   (j'ai bien mon wifi qui est activé en 2,5G & 5G sur ma box avec des équipements connectés en wifi).

Si quelqu'un peut m'aider, merci d'avance.

 

Bonjour @Dynaloo, @Jeff777, @Bruno78

Ayant de mon côté fait le "petit" saut Revolution vers Ultra, j'ai également vu les remontées des informations WiFi perdues (trafic et équipements).

Dans le script, j'ai pu voir à la ligne 1176 que l'API est forcée sur la v8 et que ça ne posait aucun soucis avec ma Freebox Revolution :

ENDPOINT="http://"+args.Endpoint+"/api/v8/"

Pour connaitre la dernière version API de votre Freebox, dans l'interface Web, cliquer sur le bouton "f" puis "Développer".
Ensuite, dérouler l'arborescence : "Developer API Documentation" > "General Information" > "Api Changes".
On voit que le dernier changement de version est le passage de la v11.2 à la v12 (enfin sur mon Ultra, cela peut peut-être différer sur la Delta ou la Pop).

J'ai donc changé la ligne en question pour mettre '/api/v12/' et toutes les informations WiFi sont revenues comme avec la Révolution.

A voir si cela vous aide.

Modifié le 24 juillet 2024 par avlc

[Dynaloo]

bonjour, @uzurka

Ayant du refaire mon container "freebox", je voulais utiliser votre image, malheureusement "https://git.uzurka.fr/Uzurka/freebox-exporter-telegraf" est indisponible !!!

Slts.

 

[Lelolo]

@DynalooNon, je viens de tester

[Dynaloo]

Le 15/08/2024 à 10:25 AM, Lelolo a dit :

@DynalooNon, je viens de tester

Merci, en effet, "git" a refonctionné vers 9h00

Slts.

[uzurka]

Le 16/08/2024 à 2:06 PM, Dynaloo a dit :

Merci, en effet, "git" a refonctionné vers 9h00

Slts.

En effet. Pour des raisons économiques et écologiques, mon gouffre de serveur est éteint entre 1h et 8h (en moyenne)

en revanche, l’image docker est sur docker hub ;)

[Macorou]

Bonjour j'ai un petit problème. quand je lance le freebox_060.py j'ai ça

"root@telegraf:/usr/local/Py# python3 freebox_061.py -r

Doing registration
Don't forget to accept auth on the Freebox panel !

root@telegraf:/usr/local/Py# python3 freebox_061.py -s
Status: auth already done
root@telegraf:/usr/local/Py#

J'accepte bien l'auth sur ma box. Mais sur mon panel je reste en auth en cours ... 

Donc le reste ne peut pas suivre .. 
Pouvez vous m'aider svp ? 

Merci d'avance

[avlc]

Le 20/09/2024 à 9:31 PM, Macorou a dit :

Bonjour j'ai un petit problème. quand je lance le freebox_060.py j'ai ça

"root@telegraf:/usr/local/Py# python3 freebox_061.py -r

Doing registration
Don't forget to accept auth on the Freebox panel !

root@telegraf:/usr/local/Py# python3 freebox_061.py -s
Status: auth already done
root@telegraf:/usr/local/Py#

J'accepte bien l'auth sur ma box. Mais sur mon panel je reste en auth en cours ... 

Donc le reste ne peut pas suivre .. 
Pouvez vous m'aider svp ? 

Merci d'avance

Il faut supprimer le fichier

/usr/local/lib/python3.11/dist-packages/freebox_api/app_auth

avant de relancer une demande de connexion (la version de Python pouvant changer).

De même, si c'est fait avec un autre utilisateur que root, le fichier app_auth peut se trouver ici :

/home/<<USER>>/.local/lib/python3.11/site-packages/freebox_api/app_auth

 

Modifié le 26 décembre 2024 par avlc

[avlc]

Bonsoir à tous,

Étant passé à la Freebox Ultra en juillet, j'en ai profité pour faire une version 0.70 du script avec plusieurs modifications :

• une option -M pour superviser les VMs c'est très sommaire car l'API est encore en cours de développement. (Ultra seulement)
•  une option -V pour le monitoring du client VPN de la Freebox. Là encore l'API est en cours de développement. A voir si la même chose pour le serveur VPN serait utile...
• par défaut l'ajout des paramètres FTTH : puissance d'émission et de réception ainsi que l'état du lien

Belle soirée,

AuVeLiCo

 

freebox_070.py

Modifié le 26 décembre 2024 par avlc
Correction d'une coquille dans le fichier attaché

[Ogme]

Bonjour,

Si ça peut intéresser du monde, j'ai mis en publique le fork de SexyGraph / Freebox Monitoring que je maintiens de mon coté depuis pas mal de temps.
Dispo sur mon repo : https://github.com/Daryes/freebox-monitoring

Preneur de tout retour, ici ou via un ticket sur le repo.

Les éléments qui peuvent coincer immédiatement :

• La version de bruno78310 utilisée ici a aussi divergée avec le temps, tout comme la mienne.
  Donc autant le script principal se remplace par simple copier/coller, autant les métriques générées autres que les principales vont varier sur les noms et mode de présentation.
• Pas de dockerfile fourni pour l'instant.

Pour le reste :

• principe d'origine conservé, un simple remplacement du script suffit.
  Le fichier credential est réutilisable tel que, utiliser le parametre "--api-endpoint-detect-force" pour un ancien fichier credential. Son emplacement est d'ailleurs paramétrable.
• détection automatique de la version de l'API, et connexion en https.
  Le certificat CA special de Free (répertoire ssl/ ) est utilisé pour valider l'accès SSL à la box, mais est aussi désactivable.
• les éléments numérotés tels que n° de port de switchs, sondes, ..., sont présentés via l'usage de tags dans les métriques.
  Ceci simplifie et automatise la gestion lorsque le nombre est variable, mais a pour impact de devoir reprendre certains panneaux des dashboards
• les métriques suivantes peuvent être collectées : systeme, switch, wifi, LTE, lan, journal d'appels, disques internes, ...
• Se reporter à l'aide intégrée pour la liste complète des possibilités.

Attention : certaines métriques n'ont pas été totalement testées, faute de matériel de mon coté.
Le mode --debug permet d'afficher les informations brutes de l'API pour aider à corriger.

 

Concernant l'usage, toujours le même principe :

# aide
./freebox_monitor.py --help

# enregistrement et status
./freebox_monitor.py --register
./freebox_monitor.py --register-status

# commande de collecte (exemple)
./freebox_monitor.py --status-sys --status-switch --status-lan-browser

 

Point particulier pour une installation existante, ou pour utiliser la dernière version de l'API :

# forcer la détection de la version de l'API
./freebox_monitor.py --api-endpoint-detect-force --status...

La version est mise en cache dans le fichier credential, évitant l'impact des changements majeurs, mais bloque l'accès aux nouveautés. Utiliser ce paramètre pour toujours appeler la dernière version de l'API proposée par la box.

Nb : c'est peut être dépendant du modèle de box, mais pour la mini4k, je n'ai pas eu à réenregistrer le script depuis des années, alors que l'API a évoluée, et le script aussi.

 

[Nicolas354]

Bonjour,
Je viens d'utiliser votre tuto (qui est très clair et complet) et je voulais tout d'abord vous remercier pour ça.
J'ai juste une petite question serait il possible de partager votre Dashboard Grafana (le JSON) si cela est possible ? (via le gitlab de se projet ?)

Merci d'avance !