Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bruth/django-tracking2
django-tracking2 tracks the length of time visitors and registered users spend on your site. Although this will work for websites, this is more applicable to web _applications_ with registered users. This does not replace (nor intend) to replace client-side analytics which is great for understanding aggregate flow of page views.
https://github.com/bruth/django-tracking2
django tracking visitor
Last synced: 9 days ago
JSON representation
django-tracking2 tracks the length of time visitors and registered users spend on your site. Although this will work for websites, this is more applicable to web _applications_ with registered users. This does not replace (nor intend) to replace client-side analytics which is great for understanding aggregate flow of page views.
- Host: GitHub
- URL: https://github.com/bruth/django-tracking2
- Owner: bruth
- License: bsd-2-clause
- Created: 2012-01-17T23:34:12.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2022-11-29T15:51:48.000Z (almost 2 years ago)
- Last Synced: 2024-04-25T14:43:52.408Z (7 months ago)
- Topics: django, tracking, visitor
- Language: Python
- Homepage:
- Size: 176 KB
- Stars: 202
- Watchers: 13
- Forks: 67
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
Overview
========
[](https://travis-ci.org/bruth/django-tracking2)
[](https://pypi.python.org/pypi/django-tracking2)
django-tracking2 tracks the length of time visitors and registered users
spend on your site. Although this will work for websites, this is more
applicable to web _applications_ with registered users. This does
not replace (nor intend) to replace client-side analytics which is
great for understanding aggregate flow of page views.
**Note: This is not a new version of [django-tracking]. These apps
have very different approaches and, ultimately, goals of tracking users.
This app is about keeping a history of visitor sessions, rather than the
current state of the visitor.**
[django-tracking]: https://github.com/codekoala/django-tracking
Requirements
============
* Django's [session framework][1] installed
[1]: https://docs.djangoproject.com/en/3.2/topics/http/sessions/
Download
========
```bash
pip install django-tracking2
```
Setup
=====
Add `tracking` to your project's `INSTALLED_APPS` setting:
```python
INSTALLED_APPS = (
...
'tracking',
...
)
```
The `tracking` app should follow the app with your user model
Add `tracking.middleware.VisitorTrackingMiddleware` to your project's
`MIDDLEWARE_CLASSES` before the `SessionMiddleware`:
```python
MIDDLEWARE_CLASSES = (
...
'tracking.middleware.VisitorTrackingMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
...
)
```
Settings
--------
`TRACK_AJAX_REQUESTS` - If True, AJAX requests will be tracked. Default
is False
`TRACK_ANONYMOUS_USERS` - If False, anonymous users will not be tracked.
Default is True
`TRACK_SUPERUSERS` - If False, users with the superuser flag set to True will
not be tracked. Default is True.
`TRACK_PAGEVIEWS` - If True, individual pageviews will be tracked.
`TRACK_IGNORE_URLS` - A list of regular expressions that will be matched
against the `request.path_info` (`request.path` is stored, but not matched
against). If they are matched, the visitor (and pageview) record will not
be saved. Default includes 'favicon.ico' and 'robots.txt'. Note, static and
media are not included since they should be served up statically Django's
static serve view or via a lightweight server in production. Read more
[here](https://docs.djangoproject.com/en/dev/howto/static-files/#serving-other-directories)
`TRACK_IGNORE_STATUS_CODES` - A list of HttpResponse status codes that will be ignored.
If the HttpResponse object has a `status_code` in this blacklist, the pageview record
will not be saved. For example,
```python
TRACK_IGNORE_STATUS_CODES = [400, 404, 403, 405, 410, 500]
```
`TRACK_REFERER` - If True, referring site for all pageviews will be tracked. Default is False
`TRACK_QUERY_STRING` - If True, query string for all pageviews will be tracked. Default is False
Views
-----
To view aggregate data about all visitors and per-registered user stats,
do the following:
Include `tracking.urls` in your `urls.py`:
```python
urlpatterns = [
...
re_path(r'^tracking/', include('tracking.urls')),
...
]
```
These urls are protected by a custom Django permission `tracking.visitor_log`.
Thus only superusers and users granted this permission can view these pages.
Available URLs
--------------
* `/` - overview of all visitor activity, includes a time picker for
filtering.
Templates
---------
* `tracking/dashboard.html` - for the dashboard page
* `tracking/snippets/stats.html` - standalone content for the dashboard page
(simplifies overriding templates)