Integration Guide - Python (Django) SDK

Django middleware to log incoming REST API calls to Moesif’s error analysis platform.

Source Code on GitHub

Package on PyPI

This SDK uses the Requests library and will work for Python 2.7 — 3.5.

How to install

pip install moesifdjango

How to use

In your settings.py file in your Django project directory, please add moesifdjango.middleware.moesif_middleware to the MIDDLEWARE array.

Because of middleware execution order, it is best to add moesifdjango middleware below SessionMiddleware and AuthenticationMiddleware, because they add useful session data that enables deeper error analysis. On the other hand, if you have other middleware that modified response before going out, you may choose to place Moesif middleware above the middleware modifying response. This allows Moesif to see the modifications to the response data and see closer to what is going over the wire.

Changes in Django 1.10

Django middleware style and setup was refactored in version 1.10. You need need to import the correct version of Moesif middleware depending on your Django version. Most users on Django 1.10 or greater will use moesifdjango.middleware.moesif_middleware. However, if you’re using Django 1.9 or older, you need to follow the old style for importing middleware and use moesifdjango.middleware_pre19.MoesifMiddlewarePre19 instead.

You can find your current Django version via python -c "import django; print(django.get_version())"

Django 1.10 or newer

Add the middleware to your application:

MIDDLEWARE = [
    ...
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'moesifdjango.middleware.moesif_middleware'
    ...
]

Django 1.9 or older

Add the middleware to your application:

MIDDLEWARE_CLASSES = [
    ...
    'moesifdjango.middleware_pre19.MoesifMiddlewarePre19',
    ...
    # other middlewares
]

Also, add MOESIF_MIDDLEWARE to your settings.py file,


MOESIF_MIDDLEWARE = {
    'APPLICATION_ID': 'Your Application ID Found in Settings on Moesif',
    ...
    # other options see below.
}

You can find your Application Id from Moesif Dashboard -> Top Right Menu -> App Setup

Configuration options

APPLICATION_ID

(required), string, is obtained via your Moesif Account, this is required.

SKIP

(optional) (request, response) => boolean, a function that takes a request and a response, and returns true if you want to skip this particular event.

IDENTIFY_USER

(optional) (request, response) => string, a function that takes a request and a response, and returns a string that is the user id used by your system. While Moesif identify users automatically, and this middleware try to use the standard Django request.user.username, if your set up is very different from the standard implementations, it would be helpful to provide this function.

GET_SESSION_TOKEN

(optional) (request, response) => string, a function that takes a request and a response, and returns a string that is the session token for this event. Again, Moesif tries to get the session token automatically, but if you setup is very different from standard, this function will be very help for tying events together, and help you replay the events.

GET_METADATA

(optional) (request, response) => dictionary, getMetadata is a function that returns an object that allows you to add custom metadata that will be associated with the event. The metadata must be a dictionary that can be converted to JSON. For example, you may want to save a VM instance_id, a trace_id, or a tenant_id with the request.

MASK_EVENT_MODEL

(optional) (EventModel) => EventModel, a function that takes an EventModel and returns an EventModel with desired data removed. Use this if you prefer to write your own mask function than use the string based filter options: REQUEST_BODY_MASKS, REQUEST_HEADER_MASKS, RESPONSE_BODY_MASKS, & RESPONSE_HEADER_MASKS. The return value must be a valid EventModel required by Moesif data ingestion API. For details regarding EventModel please see the Moesif Python API Documentation.

REQUEST_HEADER_MASKS

(deprecated), string[], is a list of strings for headers that you want to hide from Moesif. Will be removed in future version. Replaced by the function based ‘MASK_EVENT_MODEL’ for additional flexibility.

REQUEST_BODY_MASKS

(deprecated), string[], is a list of key values in the body that you want to hide from Moesif. All key values in the body will be recursively removed before sending to Moesif. Will be removed in future version. Replaced by the function based ‘MASK_EVENT_MODEL’ for additional flexibility.

RESPONSE_HEADER_MASKS

(deprecated), string[], performs the same function for response headers. Will be removed in future version. Replaced by the function based ‘MASK_EVENT_MODEL’ for additional flexibility.

RESPONSE_BODY_MASKS

(deprecated), string[], performs the same task for response body. Will be removed in future version. Replaced by the function based ‘MASK_EVENT_MODEL’ for additional flexibility.

Example:

def identifyUser(req, res):
    # if your setup do not use the standard request.user.username
    # return the user id here
    return "user_id_1"

def should_skip(req, res):
    if "healthprobe" in req.path:
        return True
    else:
        return False

def get_token(req, res):
    # if your setup do not use the standard Django method for
    # setting session tokens. do it here.
    return "token"

def mask_event(eventmodel):
    # do something to remove sensitive fields
    # be sure not to remove any required fields.
    return eventmodel

def get_metadata(req, res):
    return {
        'foo': '12345',
        'bar': '23456',
    }


MOESIF_MIDDLEWARE = {
    'APPLICATION_ID': 'Your application id',
    'LOCAL_DEBUG': False,
    'IDENTIFY_USER': identifyUser,
    'GET_SESSION_TOKEN': get_token,
    'SKIP': should_skip,
    'MASK_EVENT_MODEL': mask_event,
    'GET_METADATA': get_metadata,
}

Example

An example Moesif integration based on quick start tutorials of Django and Django Rest Framework: Moesif Django Example

Other integrations

To view more more documentation on integration options, please visit the Integration Options Documentation.

Leave a Comment