Javascript logging for Django.
Project description
Simple Django app for logging Javascript’s console.log logs to Django.
Useful for catching Javascript errors that are not logged by Django natively and would otherwise only be logged to the client’s console.
The app works by posting all logs to an internal API; because of this, it should likely not be run in performance-sensitive production environments.
If you want to implement this package, and require extra functionality please feel free to commit an issue or a PR. Otherwise, this currently does exactly what I need it to do, and I likely won’t change it.
Quick start
Add “js_logger” to your INSTALLED_APPS settings:
INSTALLED_APPS = [ ... 'js_logger', ]Include the packages URLconf in your project urls.py like this:
path('js-logs/', include('js_logger.urls')),Add the required static file to your project by running manage.py collectstatic, or by manually adding the following code to <your-templates-folder>/js-logging/js-logging.html:
<script type="text/javascript"> function readCookie(name) { let nameEQ = name + "="; let ca = document.cookie.split(';'); for (let i = 0; i < ca.length; i++) { let c = ca[i]; while (c.charAt(0) === ' ') c = c.substring(1, c.length); if (c.indexOf(nameEQ) === 0) return c.substring(nameEQ.length, c.length); } return null; } const CSRFToken = readCookie('csrftoken'); function post(type, msg) { /* Sends logs to a backend API, which logs the message to a python logger */ fetch('/js-logs/', { method: 'POST', headers: {'X-CSRFToken': CSRFToken, 'Content-Type': 'application/json'}, body: JSON.stringify({'type': type, 'msg': msg}) } ); } // Event listener for error events for posting errors to the backend window.addEventListener('error', (event) => { post('error', event.message); }); // Patch console.log function to post all other logs to the backend console._overwritten = console.log; console.log = function (log) { post('info', log); console._overwritten(log); } </script>Include the template where ever you wish for logs to be sent in from (perhaps a base or header template):
<head> ... {% include "js-logging/js-logging.html" %} ... </head>Add console.log as a logger in your logging configuration:
'console.log': { 'level': 'INFO', ... },
Note: This package will log all console.log calls in your frontend as INFO logs, and will log javascript errors as ERROR logs.
0.1.0 (20-03-2020)
First public release.
Provides full Django-logging for javascript loggers and errors.
Implements CSRFToken header.
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 django_js_logger-0.1.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6f0e18b3965521040280c3b45af11ee20d872e7100e9437a832bb7ac508407eb |
|
| MD5 | 3f682eedc3f1f7cf8c86583a36a6abc2 |
|
| BLAKE2b-256 | 19d7cd9ab95555150bd66ac512f33ce866cbc64fdd6cc3a1483d6a620fe03a52 |
