Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koslib/django-traffic
Django middleware that helps visualize your app's traffic in Kibana
https://github.com/koslib/django-traffic
django django-middleware elasticsearch kibana
Last synced: 20 days ago
JSON representation
Django middleware that helps visualize your app's traffic in Kibana
- Host: GitHub
- URL: https://github.com/koslib/django-traffic
- Owner: koslib
- License: mit
- Created: 2016-10-29T10:50:48.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-26T20:00:14.000Z (almost 2 years ago)
- Last Synced: 2024-05-19T07:28:56.110Z (6 months ago)
- Topics: django, django-middleware, elasticsearch, kibana
- Language: Python
- Size: 23.4 KB
- Stars: 57
- Watchers: 6
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- starred-awesome - django-traffic - Django middleware that helps visualize your app's traffic in Kibana (Python)
README
# django-traffic
A Django middleware that helps visualize your app's traffic in Kibana
In a nutshell, by using this middleware you need no more effort to stream your app's traffic in your
ElasticSearch host(s) and use Kibana for visualizations around it.
Request information transmitted to ElasticSearch:
- `timestamp` | type: `date`
- `location` | type: `geo_point`
- `method` | type: `string`
- `body` | type: `string`
- `path` | type: `string`
- `path_info` | type: `string`
- `scheme` | type: `string`
- `encoding` | type: `string`
- `encoding_type` | type: `string`, supported only in `Django 1.10` and later
- `ip` | type: `ip`
Geolocation is achieved by using `django.contrib.gis.geoip2.GeoIP2` wrapper, included in Django 1.9 and latter.
# Quick Start
**1. Install using pip:**
```
pip install django-traffic
```
To install the latest version directly from GitHub:
```
pip install git+https://github.com/koslibpro/django-traffic
```
**2. Include "django-traffic" in your INSTALLED_APPS:**
```
INSTALLED_APPS = [
...
'django_traffic',
]
```
**3. Include "ESTrafficInfoMiddleware" to your MIDDLEWARE_CLASSES:**
```
MIDDLEWARE_CLASSES = (
...
'django_traffic.middleware.ESTrafficInfoMiddleware',
)
```
The middleware is created in a way that supports both `MIDDLEWARE_CLASSES` on Django older versions and `MIDDLEWARE` in latest Django versions.
# Configuration
There are some variables required in your `settings.py` file to function normally.
- `TRAFFIC_INDEX_NAME`: this is the name of the index that will be used in ElasticSearch.
If you leave this empty or do not define it, the default index name will be applied: `django-traffic`.
- `ES_CLIENT`: if you already have an ElasticSearch() client instance ready in your app, we'll use this one be default.
- `ES_HOST`: this is required only if you don't have an `ES_CLIENT` defined. Here the lib expects to find a hostname
(including the port) of your ElasticSearch instance.
- `GEO_DB_PATH`: if you don't have `GEOIP_PATH` already defined, you need to define the path where django can find your
geolocation database.
- `LOG_WITHOUT_LOCATION`: (default `False`) log data even when `ip` cannot be translated to `location`
After you deploy your project or locally run your django server, requests and traffic to your web app will be sent to
the ElasticSearch hosts defined. Practically you are ready to create a Kibana map-tile visualization and start watching
where traffic is flooding you in.
# Contributing - Error Reporting
This lib was made with my own needs in mind, so it's uncommon to fit everyone's project out there.
For Error Reporting, open an issue in Github and I will try to take care of it as soon as possible.
If you are able to contribute to this lib and make it better, feel free to fork it and adjust it to your use-case.