Django Tracking Analyzer
User actions tracking and analytics for Django sites
- Django 2.1 or later.
- Django Countries 5.5 or later.
- Django IPWare 2.1.0 or later.
- Django User Agents 0.4.0 or later.
- GeoIP2 2.9.0 or later.
- MaxMind GeoLite2 country datasets.
Install Django Tracking Analyzer from PyPI by using
pip install django-tracking-analyzer
'tracking_analyzer'entries to Django
Run the migrations to load the
Trackermodel in your database:
python manage.py migrate tracking_analyzer
Install the MaxMind® GeoIP2 datasets. You can do this in two ways:
4.1. By running the provided management command for this:
python manage.py install_geoip_dataset
4.2. Or manually, by following the instructions in GeoIP2 Django documentation.
After following those steps, you should be ready to go.
Explanation - Quickstart
Django Tracking Analyzer is a Django pluggable application which helps you providing usage statistics and visitors data for your Django sites.
DTA does this by recording requests data in those places you want to by saving
Tracker is a Django database model which holds all the
data related to a request, including geolocation via IP address and device or
When some data is collected, the Django admin interface for
implements some interactive widgets to help you visualize better the data.
Now let's see how can you start collecting users data. Imagine the most basic
example: you have a web blog and you want to check the visits to your posts,
having a resume of who accessed the posts, when and from where. In such a Django
site, you might have a view
PostDetailView, where a blog post will be served
by passing its slug in the URL. Something like this:
class PostDetailView(DetailView): model = Post
Okay, so you can track the users who access blog posts by their instances with DTA, just like this:
class PostDetailView(DetailView): model = Post def get_object(self, queryset=None): # Retrieve the blog post just using `get_object` functionality. obj = super(PostDetailView, self).get_object(queryset) # Track the users access to the blog by post! Tracker.objects.create_from_request(self.request, obj) return obj
And you are now on your way to collect users data! Now give it a time (or better access the resource yourself several times) and go check your Django admin in the "Django Tracking Analyzer" - "Trackers" section. Enjoy!
For extensive documentation and usage explanations, you can check Read the Docs.
Django Tracking Analyzer makes use of this technologies and apps, without which it wouldn't be possible:
- Django Countries, by Chris Beaven.
- Django IPWare, by Val Neekman.
- Django User Agents, by Selwin Ong.
- Datamaps, by Marc DiMarco.
- TopoJSON, by Mike Bostock.
- D3 bar chart w/tooltips, original code by Justin Palmer.
- D3 area chart, by Mike Bostock.
- Of course, the D3.js library.
- And MaxMind, the company behind all the geographical datasets that made them publicly available.