Home

A simple but hopefully, useful, tool for monitoring your network. Logs and present statistics, while also notifying you of the status of chosen hosts.

Project Status: Work In Progress

Getting Started

---

Step 1 - Dependencies

Install Python dependencies

python -m pip install -r requirements.txt

---

Step 2 - Create Config File

Copy the example-config.yaml to config.yaml.

cp example-config.yaml config.yaml

---

Step 3 - Edit Config File

The config.yaml is used to tell tested.live what IP network address and subnet you are using.

You can specify what hosts you would like to monitor by setting an ip and a useful name for each host.

Optionally you can specify an email address and SMTP server for notifications.

Example

---
flags:
  notification_download_speed: True

hosts:
  - host:
    name: Example Host A
    ip: 192.168.0.2
  - host:
    name: Example Host B
    ip: 192.168.0.3
  - host:
    name: Example Host C
    ip: 192.168.0.4
  - host:
    name: Example Host D
    ip: 192.168.0.5

email:
  from: example@sender.com
  to:
      - email: example@recipient.com
      - email: example@recipient2.com
  smtp:
      provider: smtp.gmail.com
      port: 587
      user: example@gsender.com
      password: examplePassword
...   

---

Step 4 - Run

You are now ready to start monitoring and collecting statistics on your network.

python main.py -i

Example Output

--------------------------------------
Network                   Value
------------------------  ------------
Hosts online (Total)      9
Hosts online (Monitored)  4
% monitored               44.44%
Total possible hosts      254
% possible hosts online   3.54%
IP range                  192.168.0/24
Public IP                 00.00.00.000
--------------------------------------

-----------------
 Monitored Hosts
-----------------
Host      Status
-------  --------
Host A    ONLINE
Host B    OFFLINE
Host C    ONLINE
Host D    ONLINE

---

Acknowledgments

Special thanks to whatdoesthatdo for guidance & assisting in learning new things.