Innovate anywhere, anytime withruncode.io Your cloud-based dev studio.
MongoDB

How do I Profile Django Application Using Django Web Profiler

2022-07-21

When working with a large scale applications which includes many modules, we need to focus on the performance to give more user statisfaction, sustainability. To improve the performance, we need to analyze the application in various cases for ex: examine all urls with their response time and status codes, no of database queries with time, no of cache hits for a particural url.

In that case, django-web-profiler will be very helpful for your application. It'll records the application urls with data such as response time, status code, database queries, time taken to execute those queries, no of cache hits.

A django profiling tool which logs, stores debug toolbar statistics and also a set of URL’s statistics using a management command. It logs request values such as device, ip address, user cpu time, system cpu time, No of queries, sql time, no of cache calls, missing, setting data cache calls for a particular url.

It also provides a basic UI, which will differentiate development url statistics, production level statistics which generates using a management command.

How to setup for a django application?

Install django-web-packer using the following command:

pip install django-web-profiler
          (or)
  git clone git://github.com/micropyramid/django-web-profiler.git
  cd django-web-profiler
  python setup.py install

Add app name in settings.py:

INSTALLED_APPS = [
   '..................',
   'compressor',
   'debug_toolbar',
   'django_web_profiler',
   '..................'
]

Add ‘django_web_profiler.middleware.DebugLoggingMiddleware’ to your project middlewares:

MIDDLEWARE = [
‘..................’, 
‘django_web_profiler.middleware.DebugLoggingMiddleware’,
‘..................’
]

Disable ‘debug_toolbar.middleware.DebugToolbarMiddleware’ if you’ve already using it.
Make sure that ‘debug-toolbar’ has enabled for your application. After installing debug toolbar, add the following details to settings.py:

INTERNAL_IPS = (‘127.0.0.1’,)

After installing/cloning, add the following details in settings file about urls, logger names:

URLS = ['http://stage.testsite.com/', 'http://stage.testsite.com/testing/']

Add the following logger to your existing loggers and create a folder called ‘logs’ where all profiler log files are stored:

'request-logging': {

        'level': 'DEBUG',

        'handlers': ['console', 'file_log'],

        'propagate': False,

    },

Here file_log is a handler which contains a path where log files are stored.

Sample Application

Sample Application

Install application requirements using the following command:

pip install -r requirements.txt

Load the application load using the following command:

python sandbox/manage.py loaddata sandbox/fixtures/users.json

Using the following command, we can generate url statistics in production environment i.e debug=False:

python sandbox/manage.py logging_urls

We are always looking to help you customize the whole or part of the code as you like.

Visit our Django Development page Here

We welcome your feedback and support, raise github ticket if you want to report a bug. Need new features? Contact us here

Source Code is available in Micropyramid Repository(https://github.com/MicroPyramid/django-web-profiler).