django-traffic-monitor 1.6

a Django application that eases to monitor server traffic.

django-traffic-monitor is a Django application that eases to monitor server traffic.

Quick start

1. install with pip:

   pip install django-traffic-monitor django-crontab

2. Add “traffic_monitor” and “django-crontab” to your INSTALLED_APPS setting like this:

   INSTALLED_APPS = [
       ...
       'django_crontab',
       'traffic_monitor',
   ]

3. Include the traffic_monitor URLconf in your project urls.py like this:

   urlpatterns += [
       url(r'^traffic/', include('traffic_monitor.urls')),
   ]

4. Run python manage.py migrate to create the traffic_monitor models.

5. Find out your server’s network interface names using Linux command like ifconfig then set the name or names you wish to monitor in your project setting.:

   TRAFFIC_MONITOR_INTERFACE_NAMES = 'docker0,p2p1,eth0'

6. Email setting required for Django. If sending email in your project is currently working, no need to change it.:

   EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
   EMAIL_HOST = 'smtp.gmail.com',
   EMAIL_PORT = 587
   EMAIL_USE_TLS = True
   EMAIL_HOST_USER = '[e-mail]',
   EMAIL_HOST_PASSWORD = 'your_password,
   DEFAULT_FROM_EMAIL = '[e-mail]'

7. (Optional) Set more configurations if you want to change from default.:

   # Permission to use: superuser, staff, member, all
   TRAFFIC_MONITOR_PERMISSION = 'staff'
   
   # Template for traffic monitoring page
   TRAFFIC_MONITOR_TEMPLATE = 'traffic_monitor/show_traffic.html'
   
   # Alarm will be sent if daily traffic exceeds
   TRAFFIC_MONITOR_DAILY_ALARM_BYTES = 100 * 1024 * 1024 * 1024
   
   # Alarm will be sent if monthly traffic exceeds
   TRAFFIC_MONITOR_MONTHLY_ALARM_BYTES = 800 * 1024 * 1024 * 1024
   
   # Alarm From Email
   TRAFFIC_MONITOR_EMAIL_FROM = DEFAULT_FROM_EMAIL
   
   # Alarm Email To (comma seperated list, can be more than one)
   TRAFFIC_MONITOR_EMAIL_TO = [DEFAULT_FROM_EMAIL]
   
   # Set False if you do not want to get email
   TRAFFIC_MONITOR_ALARM_SEND_EMAIL = True
   
   # Subject of email
   TRAFFIC_MONITOR_ALARM_EMAIL_SUBJECT = 'Traffic limit alert'
   
   # If traffic limit exceeds, the next alarm will be sent only if the traffic exceeds threshold from previous alarm
   TRAFFIC_MONITOR_ALARM_BYTES_THRESHOLD = 10 * 1024 * 1024 * 1024

8. Add cronjob in your settings.py to collect traffic automatically. (i.e. run every 5 minutes):

   CRONJOBS = [
       ('*/5 * * * *', 'traffic_monitor.tools.read_bytes', '>> /var/log/cronjob.log'),
   ]

9. Run following command to add CRONJOBS to your system crontab:

   python manage.py crontab add