Django-UCSVLog

Django integration with python-ucsvlog, allows you easy to write and easy to parse tree-like logs from Django.

Requirements

• Django
• python-ucsvlog

Installation

• Install django-ucsvlog:

  *IN WORK*
  

Minimal Configuration

• Add 2 Middleware classes 'djucsvlog.middleware.LogRequestInfo' should be the first and 'djucsvlog.middleware.LogViewInfo' at the end of Middleware's list. So your Middlewere's settings can looks like this:

  MIDDLEWARE_CLASSES = (
      'djucsvlog.middleware.LogRequestInfo', ##ADD (at the top of list)
      'django.middleware.common.CommonMiddleware',
      'django.contrib.sessions.middleware.SessionMiddleware',
      'django.middleware.csrf.CsrfViewMiddleware',
      'django.contrib.auth.middleware.AuthenticationMiddleware',
      'django.contrib.messages.middleware.MessageMiddleware',
      'djucsvlog.middleware.LogViewInfo', ##ADD (at the bottom of list)
      # Uncomment the next line for simple clickjacking protection:
      # 'django.middleware.clickjacking.XFrameOptionsMiddleware',
  )
  

• Add djucsvlog to INSTALLED_APPS in settings.py:

  INSTALLED_APPS = (
      # other apps
      "djucsvlog",
  )
  

• Add path to log file of your project

  UCSVLOG_FILE_VERSION = 'v3' #is just helps you to split different log's file versions
  UCSVLOG_FILE = '/var/log/django/my_project/{year}-{month}-{day}-'+UCSVLOG_FILE_VERSION+'.ucsv'
              # auto-rendering name of file. It mease in 19th april of 2033 log will be written into
              # /var/log/django/my_project/2033-4-19-v3.ucsv
  

• You can use UCSVLOG_PRINT for debug mode to see in console what will be written.

  UCSVLOG_PRINT = True

• You can install logging handler to store in ucsvlogs all logging calls:

  LOGGING = {
      'version': 1,
      'disable_existing_loggers': False,
      'filters': {
          'require_debug_false': {
              '()': 'django.utils.log.RequireDebugFalse'
          }
      },
      'handlers': {
          'mail_admins': {
              'level': 'ERROR',
              'filters': ['require_debug_false'],
              'class': 'django.utils.log.AdminEmailHandler'
          },
          'ucsvlog': {
              'class': 'djucsvlog.logging.handlers.UCSVLogHandler', #custome ucsvlog handler
          }
      },
      'loggers': {
          'django.request': {
              'handlers': ['mail_admins', 'ucsvlog'],
              'level': 'ERROR',
              'propagate': True,
          },
          '': {
              'handlers': ['ucsvlog'],
              'propagate': True,
              'level': 'DEBUG'
          },
      }
  }
  

Usage

About how to use python-ucsvlog or logging in your code you can read in their own documentation..

The main difference now, is that you can use list in calling logging functions for example:

logger.info(['SectionName', 'History'])

You can also use global ucsvlog object:

from djucsvlog import glog
glog('Something happens')
glog.err('Something important')
glog.a_log('USER_INFO', ['ID', 5678])
glog('Name', 'Alexander')
glog('LName', 'Lyabah')
glog.c_log('USER_INFO')

Middleware logs

Every user's request is saved in logs. In the following settings you can configure which exact info you want to save.

UCSVLOG_REQUEST_FIELDS -these are the fields of request which will store data in logs. These fields will store date in the first middleware ( LogRequestInfo ) until the other middlewares will be called. In these fields we can save all request information, such as user's ip, browser version, GET or POST data etc.

Default value is ['http_host', 'browser_uuid', 'remote_addr', 'path', 'get', 'post', 'files', 'http_user_agent','http_referer', 'http_accept_language']

All posible functions to store in UCSVLOG_REQUEST_FILEDS you can find at djucsvlog/fields/request.py

Some not so obvious fields

• browser_uuid - simple ID which is stored in cookies to identify different browsers in logs
• save_files - save all submited files in folder UCSVLOG_REQ_SAVE_FILES_FOLDER
• remote_addr - user's IP address that is received from request.META['REMOTE_ADDR']. But if it doesn't exist then a key stored in UCSVLOG_REQ_REMOTE_ADDR_ANONYMOUSE will be used.

UCSVLOG_VIEW_OPEN_FIELDS - these fields are stored in the last middleware ( LogViewInfo ), right before view will be called. In these fields we can save all info collected after all middlewares will be called

Default value is ['userid'].

All posible functions to store in UCSVLOG_VIEW_OPEN_FIELDS you can find at djucsvlog/fields/view_open.py

UCSVLOG_RESPONSE_FIELDS in these fields we can log all response info.

Default value is ['status','ctype','content'].

Some not so obvious fields

• ctype - content type of response
• content - full content response. It will be saved in case the content type of this response will be one of UCSVLOG_RESPONSE_CONTENT_LOG_TYPES ( Default value is ['text/json','text/xml','application/json','application/xml'] )

All posible functions to store in UCSVLOG_RESPONSE_FIELDS you can find at djucsvlog/fields/response.py

UCSVLOG_EXCEPTION_FIELDS, UCSVLOG_EXCEPTION_STACK_FIELDS and UCSVLOG_EXCEPTION_CLOSE are used for storing all exception information

UCSVLOG_LOG_BASE - list of fields which will be stored for every log record. It is an information about the place of log's function calling. These fields are used only by python-ucsvlog

Default value is ['stacksize','filename','lineno','fname'].

Writting your own fields

Insted of passing string name of predefined function you can pass a link to your own function or a string name for importing this function ( like in TEMPLATE_CONTEXT_PROCESSORS )

But in functions for different fields diferent arguments are passed.

• UCSVLOG_REQUEST_FIELDS - request
• UCSVLOG_RESPONSE_FIELDS - request, response
• UCSVLOG_VIEW_OPEN_FIELDS - request

Other configuration settings

List of all possible settings you can find in the file djucsvlog/settings.py

Line:

get('PRINT',False)

It means that this setting can be overriden in your settings.py file by UCSVLOG_PRINT setting.

Other packages

• django-ucsvlog-analytics helps you to parse and analyse log files, generated by django-ucsvlog