zulip/zulip

Contribute Zulip's production database/memcached/etc. performance logging framework to Django Upstream

Open

#974 ouverte le 7 juin 2016

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Python (19 672 stars) (7 339 forks)batch import
area: dependencieshelp wanted

Description

The accounting that we do in via monkey-patching in zerver/lib/db.py and zerver/lib/cache.py (and the corresponding logging in zerver/middleware.py) is really nice, and would be a great feature to contribute back to Django upstream, since a lot of other projects would likely find it useful as well (probably the most common Django performance issue is to accidentally do database queries in a loop, and this makes it really easy to debug those in production).

I talked to a Django core team member at PyCon, and he suggested the next step for this feature is probably to do a writeup of the feature and email it out to the Django mailing lists. I will probably find time to do this eventually, but if anyone's interested in helping get this feature into Django mainline, let me know and I'd be happy to help make this happen!

Guide contributeur

Stack technique
pythondjangosql
Domaine
backendperformanceobservabilitydatabase
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
4
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
over 1 week
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Understanding of Django ORMExperience with performance profilingFamiliarity with Django internalsAbility to write a design document
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
20
Direction de recherche
The next step is to write a detailed design document about the performance logging framework and email it to the Django mailing list for discussion. The relevant code is in zerver/lib/db.py and zerver/lib/cache.py in the Zulip repository. The feature involves monkey patching Django's database and cache layers to log queries and operations, and then exposing that via middleware for performance debugging in production.