Django Middleware for optic
Project description
Optic Django Middleware
This module is an Django middleware 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-middlewaree
Usage
The middleware takes a configuration object and captures traffic in the background as long as @useoptic/cli
is installed.
Configuration
Environment variables can also be used to set the values
ENABLE
:boolean
(defaults toFALSE
) Programmatically control if capturing data and sending it to OpticUPLOAD_URL
:string
(defaults toos.environ['OPTIC_LOGGING_URL']
) The URL to Optics capture URL, if left blank it will expectOPTIC_LOGGING_URL
environment variable set by the Optic CLICONSOLE
:boolean
(defaults toFALSE
) Send to stdout/console for debuggingframework
:string
(defaults to '') Additional information to inform Optic of where it is capturing informationLOG
:boolean
(defaults toFALSE
) Send to log fileLOG_PATH
:boolean
(defaults to./optic.log
) Log file pathLOCAL
:boolean
(defaults toTRUE
) Send to optic cliINTERACTION_MANAGER
:string
(defaults tooptic_django_middleware.manager.BasicOpticManager
) Manager module to control the behaviour of capturing and sending interaction
Example
# settings.py
import os
from tempfile import mkdtemp
tempdir = mkdtemp('optic_django')
OPTIC = {
'ENABLE': True,
'LOG_PATH': os.path.join(tempdir, 'optic.log'),
'LOG': True,
'CONSOLE': False,
'LOCAL': False
}
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for optic-django-middleware-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9512955846720888a1cea8f58b54e2bd6187753e5d63b5da1118763d786d978 |
|
MD5 | 4f0d0e74da17d5c270ed6cf138b4e288 |
|
BLAKE2b-256 | 5fe8e6b5b37816c0fdfcfcc82cb757f3ce10d28db7c3a539cfafd2550487df38 |
Hashes for optic_django_middleware-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d1b3b6b2703f51aa99b432cd76b8736ed8ea8803a43e4a0442671741a023f0e |
|
MD5 | 4e4dad356ebd764c741418b47b077a12 |
|
BLAKE2b-256 | 0561ac2866d11384edbd48d84e9ebd8861f635f190922267e592b21949caa929 |