Optic Django Middleware

This module is a plugin for Django using optic-sdk to capture and format HTTP data to send to Optic. We have a list of middleware available for some frameworks, if we are missing the framework join our community and suggest the next framework or develop it with us.

Requirements

The module requires @useoptic/cli to be installed, instructions on installing it are available https://www.useoptic.com/docs/.

Install

pip install optic-django-unittest

Usage

The plugin is used along with Optic Django Middleware to customise optic logging behaviour based on unittest test result hooks to add features like

1. Send successful test http inteaction only
2. Send interactions in bulk

Configuration

Environment variables can also be used to set the values

• ENABLE: boolean (defaults to FALSE) Programmatically control if capturing data and sending it to Optic
• UPLOAD_URL: string (defaults to os.environ['OPTIC_LOGGING_URL']) The URL to Optics capture URL, if left blank it will expect OPTIC_LOGGING_URL environment variable set by the Optic CLI
• CONSOLE: boolean (defaults to FALSE) Send to stdout/console for debugging
• framework: string (defaults to '') Additional information to inform Optic of where it is capturing information
• LOG: boolean (defaults to FALSE) Send to log file
• LOG_PATH: boolean (defaults to ./optic.log) Log file path
• LOCAL: boolean (defaults to TRUE) Send to optic cli

Example

# settings.py
import os
from tempfile import mkdtemp
tempdir = mkdtemp('optic_django')
OPTIC = {
    # ...optic-django-middleware settings
    'INTERACTION_MANAGER': "optic_django_unittest.manager.HttpInteractionManager"
}

INSTALLED_APPS += [
    'optic_django_middleware',
]

To start capturing data from the SDK, run your application with

api exec "python manage.py runserver"

License

This software is licensed under the MIT license.