Freebox-OS-munin

Freebox Revolution & Freebox 4K's stats monitoring using munin

See below for some screenshots

## Usage

1. This plugin relies on requests:

   pip3 install requests

2. Clone this project on your server:

   git clone https://github.com/chteuchteu/Freebox-OS-munin.git && cd Freebox-OS-munin
   clone_path=$(pwd)

3. Launch authorization script

   ./main.py authorize

4. Update permissions on authorization file

   chmod 0600 ./freebox.json

5. Install the plugins

   Tip: you don't have to symlink each mode. Skip some if you don't need all information

   ln -s "$clone_path"/main.py /etc/munin/plugins/freebox-traffic
   ln -s "$clone_path"/main.py /etc/munin/plugins/freebox-temp
   ln -s "$clone_path"/main.py /etc/munin/plugins/freebox-xdsl
   ln -s "$clone_path"/main.py /etc/munin/plugins/freebox-xdsl-errors
   ln -s "$clone_path"/main.py /etc/munin/plugins/freebox-switch1
   ln -s "$clone_path"/main.py /etc/munin/plugins/freebox-switch2
   ln -s "$clone_path"/main.py /etc/munin/plugins/freebox-switch3
   ln -s "$clone_path"/main.py /etc/munin/plugins/freebox-switch4
   ln -s "$clone_path"/main.py /etc/munin/plugins/freebox-df
   ln -s "$clone_path"/main.py /etc/munin/plugins/freebox-hddspin
   ln -s "$clone_path"/main.py /etc/munin/plugins/freebox-transmission-tasks
   ln -s "$clone_path"/main.py /etc/munin/plugins/freebox-transmission-traffic
   
   service munin-node restart

6. Add plugin configuration to /etc/munin/plugin-conf.d/munin-node

   sudo nano /etc/munin/plugin-conf.d/munin-node

   Insert the following lines at the end

   [freebox*]
   user root

   Tip: You can replace root by the authorization file owner

   Restart munin node service

   sudo service munin-node restart

7. Test it

   munin-run freebox-traffic
   

Graphs

• freebox-traffic
• freebox-xdsl
• freebox-xdsl-errors
• freebox-temp
• freebox-switch1 (1..4)
• freebox-df
• freebox-hddspin
• freebox-transmission-tasks (missing screenshot)
• freebox-transmission-traffic (missing screenshot)

Contribute

Fork this repository, and submit pull requests upon master branch.

Tip: when making changes that affects all plugins, you can tests them all by running ./main.py --mode all. This will execute each plugin in both config & poll modes.