Django Watchtower
Collect hits metrics from Django.
How it works: numbers taken out from Django are stored in Redis and a collector saves them in some database(s)
Metrics: each hit is saved with fields ip, request time, query time, user_agent, geographical information and more
Install
Install the GeoIp tools:
cd /my/geo/folder
wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gzUnzip and add to settings.py:
GEOIP_PATH = "/my/geo/folder"Install:
pip install django-watchtowerAdd to installed apps:
"django_user_agents",
"mqueue",
"watchtower",Add the middlewares:
MIDDLEWARE_CLASSES = (
'django_user_agents.middleware.UserAgentMiddleware',
'watchtower.middleware.HitsMiddleware',
# ... other middlewares
)Set the Django databases:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
},
'hits': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'hits.sqlite3'),
}
}
DATABASE_ROUTERS = ['watchtower.router.HitsRouter']Add to settings.py:
# required
SITE_SLUG = "mysite"
# set the databases to use
WT_DATABASES = {
# required: at least one database
"default": {
"type": "django",
"hits_db": "hits" # name of a DATABASE in settings
},
# defaults:
WT_REDIS = {
"addr": "localhost:6379",
"db": 0
}Make the migrations:
python3 manage.py migrate watchtower --database=hits
Additional settings
Exclude certain paths from hits recording:
WT_EXCLUDE = ["/path/not/recorded/"]
# default:
# ["/admin/jsi18n/", "/media/"]Note: this will exclude all paths that start with the provided values
Change the default collector save interval:
WT_FREQUENCY = 30Run the collector
python3 manage.py collectNote: it is possible to save the data directly into the database not using Redis and the collector with the setting:
WT_COLLECTOR = FalseDo not use this setting in production: it will not work when DEBUG is False
Collected data
{
"site": "mysite",
"user": "admin",
"request_time": 35,
"status_code": 200,
"doc_size": 3912,
"ip": "127.0.0.1",
"user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:55.0) Gecko/20100101 Firefox/55.0",
"method": "GET",
"view": "AddPostView",
"module": "qcf.views",
"is_superuser": true,
"is_authenticated": true,
"reason_phrase": "OK",
"ua": {
"os_version": "",
"is_pc": true,
"browser_version": "55.0",
"is_mobile": false,
"os": "Ubuntu",
"is_tablet": false,
"is_bot": false,
"device": "Other",
"is_touch": false,
"browser": "Firefox"
},
"geo": {
"latitude": 0,
"postal_code": "",
"country_code": "",
"region": "",
"dma_code": "",
"country_name": "",
"longitude": 0,
"city": ""
},
"is_staff": true,
"referer": "",
"path": "/",
"queries_time": 2,
"num_queries": 1
}
