-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Telling people that they can't depend on this to be complete yet...
- Loading branch information
Alex Lovell-Troy
committed
Jul 24, 2013
1 parent
3454af4
commit 5580e54
Showing
1 changed file
with
10 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,18 @@ | ||
django-telemetry | ||
================ | ||
|
||
An event-based reporting system for django -- With queryset graphs! | ||
|
||
There are many external analytics packages that can tell you about your users in aggregate. We like [Google Analytics](http://google.com/analytics) for that. To store information about requests along with the users who made them, we like django-telemetry. | ||
|
||
### Async operation with celery | ||
### Not fit for human consumption. | ||
This is a collection of event/reporting code that I've used in various places over the years. It seems useful enough to share, but I haven't added docs or examples yet. | ||
|
||
If you are running a celery task queue, recording of the views in the database can be separated from the actual request. | ||
|
||
### Middleware vs Decorator vs Mixin | ||
## Event Features | ||
* Event reporting in middleware, decorators, and tasks | ||
* Request recording using middleware, decorators, view Mixins. | ||
* Organizing requests by user, referer, and browser signature where provided | ||
* Optional async recording/reporting using celery | ||
|
||
Depending on your performance needs, telemetry can be recorded at different points in the request/response cycle. Middleware plays nicely with most kinds of caching and is easiest to set up. You probably want that. | ||
## Reporting Features | ||
* Logs in the database with management commands to clear old logs | ||
* Generic queryset graphs (using [flot](http://flotcharts.org) to track _any_ queryset with a date field | ||
|
||
If you really want to exert more control, the Mixin and Decorator are provided |