setu-trafficmonitor 2.0.0__py3-none-any.whl

setu_trafficmonitor-2.0.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 FarmSetu Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

setu_trafficmonitor-2.0.0.dist-info/METADATA

@@ -0,0 +1,401 @@
+Metadata-Version: 2.1
+Name: setu-trafficmonitor
+Version: 2.0.0
+Summary: A comprehensive Django app for logging HTTP requests with analytics dashboard
+Home-page: https://github.com/farmsetu/django-trafficmonitor
+Author: FarmSetu Team
+Author-email: FarmSetu Team <tech@farmsetu.com>
+License: MIT
+Project-URL: Homepage, https://github.com/farmsetu/django-trafficmonitor
+Project-URL: Documentation, https://github.com/farmsetu/django-trafficmonitor/blob/master/README.md
+Project-URL: Repository, https://github.com/farmsetu/django-trafficmonitor
+Project-URL: Bug Tracker, https://github.com/farmsetu/django-trafficmonitor/issues
+Project-URL: Changelog, https://github.com/farmsetu/django-trafficmonitor/blob/master/CHANGELOG.md
+Keywords: django,request,logging,analytics,monitoring,middleware,dashboard,traffic,http
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django <6.0,>=3.2
+Requires-Dist: celery >=5.0.0
+Requires-Dist: djangorestframework >=3.12.0
+Requires-Dist: redis >=4.0.0
+Provides-Extra: dev
+Requires-Dist: black >=23.0 ; extra == 'dev'
+Requires-Dist: flake8 >=6.0 ; extra == 'dev'
+Requires-Dist: isort >=5.12 ; extra == 'dev'
+Requires-Dist: mypy >=1.0 ; extra == 'dev'
+Requires-Dist: pytest-cov >=4.0 ; extra == 'dev'
+Requires-Dist: pytest-django >=4.5 ; extra == 'dev'
+Requires-Dist: pytest >=7.0 ; extra == 'dev'
+Provides-Extra: production
+Requires-Dist: django-redis >=5.0.0 ; extra == 'production'
+Requires-Dist: gunicorn >=20.0.0 ; extra == 'production'
+Requires-Dist: psycopg2-binary >=2.9.0 ; extra == 'production'
+Requires-Dist: sentry-sdk >=1.0.0 ; extra == 'production'
+
+# Setu TrafficMonitor
+
+A comprehensive Django application for logging HTTP requests with a beautiful analytics dashboard. Monitor your API traffic, analyze performance metrics, and gain insights into your application's usage patterns.
+
+![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)
+![Python](https://img.shields.io/badge/python-3.8%2B-blue.svg)
+![Django](https://img.shields.io/badge/django-3.2%2B-green.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+
+## Features
+
+### Request Logging
+- **Comprehensive Logging**: Captures all HTTP requests with detailed information
+- **Performance Metrics**: Track response times and database query counts
+- **User Tracking**: Associate requests with authenticated users
+- **IP Address Tracking**: Monitor requests by IP address with X-Forwarded-For support
+- **Request/Response Bodies**: Store request and response payloads (with size limits)
+- **Exception Tracking**: Automatic logging of exceptions with full tracebacks
+- **Configurable Exclusions**: Exclude specific paths (static files, health checks, etc.)
+
+### Analytics Dashboard
+- **Real-time Visualizations**: Interactive charts powered by Chart.js
+- **Time-based Analysis**: View metrics by today, last 7 days, last 30 days, or custom ranges
+- **Status Code Distribution**: Track success rates and error patterns
+- **HTTP Method Breakdown**: Analyze request types (GET, POST, PUT, DELETE, etc.)
+- **Endpoint Performance**: Identify slowest endpoints and optimization opportunities
+- **Hourly Heatmap**: Discover traffic patterns throughout the day
+- **Top IPs & Users**: Monitor most active clients and users
+- **Error Trending**: Track 4xx and 5xx errors over time
+- **Advanced Filtering**: Filter by method, status code, path, and user
+
+### REST API Endpoints
+- **Analytics Overview API**: Get comprehensive analytics data in JSON format
+- **Chart-specific APIs**: Fetch individual chart data for custom integrations
+- **Admin-only Access**: Secure endpoints with Django permissions
+
+## Installation
+
+### Using pip
+
+```bash
+pip install <path-to-your-private-setu-trafficmonitor-package>
+```
+
+### From source
+
+```bash
+git clone <internal-repo-url>
+cd setu-trafficmonitor
+pip install -e .
+```
+
+## Quick Start
+
+### 1. Add to Installed Apps
+
+Add `trafficmonitor` to your `INSTALLED_APPS` in `settings.py`:
+
+```python
+INSTALLED_APPS = [
+    # ... other apps
+    'rest_framework',  # Required dependency
+    'trafficmonitor',
+]
+```
+
+### 2. Add Middleware
+
+Add the middleware to your `MIDDLEWARE` setting (preferably near the top):
+
+```python
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'trafficmonitor.middleware.RequestLoggingMiddleware',  # Add here
+    # ... other middleware
+]
+```
+
+### 3. Configure URLs
+
+Include the TrafficMonitor URLs in your project's `urls.py`:
+
+```python
+from django.urls import path, include
+
+urlpatterns = [
+    # ... your other URLs
+    path('', include('trafficmonitor.analytics.urls')),
+]
+```
+
+### 4. Run Migrations
+
+```bash
+python manage.py migrate trafficmonitor
+```
+
+### 5. Access the Dashboard
+
+Start your development server and navigate to:
+- **Dashboard**: `http://localhost:8000/analytics/dashboard/`
+- **API Overview**: `http://localhost:8000/api/analytics/overview/`
+
+**Note**: Dashboard access is restricted to staff users. Make sure you have a staff user:
+
+```bash
+python manage.py createsuperuser
+```
+
+## Configuration
+
+### Middleware Settings
+
+You can customize the middleware behavior by subclassing and overriding:
+
+```python
+from trafficmonitor.middleware import RequestLoggingMiddleware
+
+class CustomRequestLoggingMiddleware(RequestLoggingMiddleware):
+    # Maximum body size to log (in characters)
+    MAX_BODY_LENGTH = 20000
+
+    # Paths to exclude from logging
+    EXCLUDED_PATHS = [
+        '/admin/jsi18n/',
+        '/static/',
+        '/media/',
+        '/__debug__/',
+        '/favicon.ico',
+        '/health/',  # Add custom paths
+    ]
+```
+
+Then use your custom middleware in `settings.py`:
+
+```python
+MIDDLEWARE = [
+    # ...
+    'myapp.middleware.CustomRequestLoggingMiddleware',
+    # ...
+]
+```
+
+### Database Optimization
+
+For high-traffic applications, consider:
+
+1. **Database Indexing**: The package includes optimized indexes for common queries
+2. **Partitioning**: Consider partitioning the `request_log` table by date
+3. **Archiving**: Implement a cleanup strategy for old logs:
+
+```python
+from django.utils import timezone
+from datetime import timedelta
+from trafficmonitor.models import RequestLog
+
+# Delete logs older than 90 days
+cutoff_date = timezone.now() - timedelta(days=90)
+RequestLog.objects.filter(timestamp__lt=cutoff_date).delete()
+```
+
+4. **Read Replicas**: Route analytics queries to read replicas if available
+
+## Usage Examples
+
+### Accessing Analytics Data Programmatically
+
+```python
+from trafficmonitor.analytics.views import AnalyticsQueryHelper
+from django.utils import timezone
+from datetime import timedelta
+
+# Get date range
+end_date = timezone.now()
+start_date = end_date - timedelta(days=7)
+
+# Get total requests
+total = AnalyticsQueryHelper.get_total_requests(start_date, end_date)
+
+# Get top endpoints
+top_endpoints = AnalyticsQueryHelper.get_top_endpoints(
+    start_date, end_date, limit=10
+)
+
+# Get slowest endpoints
+slow_endpoints = AnalyticsQueryHelper.get_slowest_endpoints(
+    start_date, end_date, limit=10
+)
+
+# Get comprehensive analytics
+analytics = AnalyticsQueryHelper.get_comprehensive_analytics(
+    start_date, end_date
+)
+```
+
+### Filtering Analytics
+
+```python
+# Filter by HTTP method
+get_requests = AnalyticsQueryHelper.get_total_requests(
+    start_date, end_date, method='GET'
+)
+
+# Filter by status code range
+errors = AnalyticsQueryHelper.get_total_requests(
+    start_date, end_date, status_code_range=(400, 599)
+)
+
+# Filter by path
+api_requests = AnalyticsQueryHelper.get_total_requests(
+    start_date, end_date, path_contains='/api/'
+)
+
+# Filter by user
+user_requests = AnalyticsQueryHelper.get_total_requests(
+    start_date, end_date, user_id=user.id
+)
+```
+
+### Custom Celery Task for Log Cleanup
+
+```python
+from celery import shared_task
+from django.utils import timezone
+from datetime import timedelta
+from trafficmonitor.models import RequestLog
+
+@shared_task
+def cleanup_old_request_logs():
+    """Delete request logs older than 90 days"""
+    cutoff_date = timezone.now() - timedelta(days=90)
+    deleted_count, _ = RequestLog.objects.filter(
+        timestamp__lt=cutoff_date
+    ).delete()
+    return f"Deleted {deleted_count} old request logs"
+```
+
+## API Reference
+
+### REST API Endpoints
+
+#### Analytics Overview
+```
+GET /api/analytics/overview/
+```
+
+Query Parameters:
+- `range`: `today`, `yesterday`, `last_7_days`, `last_30_days`, `custom`
+- `start_date`: ISO format date (YYYY-MM-DD) for custom range
+- `end_date`: ISO format date (YYYY-MM-DD) for custom range
+- `method`: Filter by HTTP method (GET, POST, etc.)
+- `status`: Filter by status code
+- `path`: Filter by path contains
+- `user`: Filter by user ID
+
+#### Chart Data
+```
+GET /api/analytics/chart/<chart_type>/
+```
+
+Chart Types:
+- `time-series`: Requests over time
+- `status-codes`: Status code distribution
+- `methods`: HTTP methods breakdown
+- `endpoints`: Top endpoints
+- `performance`: Slowest endpoints
+- `heatmap`: Hourly request heatmap
+- `errors`: Error trend over time
+
+## Database Schema
+
+### RequestLog Model
+
+| Field | Type | Description |
+|-------|------|-------------|
+| id | UUID | Primary key |
+| method | CharField | HTTP method (GET, POST, etc.) |
+| path | CharField | Request path/URL |
+| full_url | TextField | Complete URL with query params |
+| status_code | IntegerField | HTTP response status code |
+| user | ForeignKey | Authenticated user (nullable) |
+| ip_address | GenericIPAddressField | Client IP address |
+| user_agent | TextField | User agent string |
+| request_headers | JSONField | Request headers (sensitive ones excluded) |
+| request_body | TextField | Request body (truncated) |
+| response_body | TextField | Response body (truncated) |
+| response_time_ms | FloatField | Response time in milliseconds |
+| query_count | IntegerField | Database queries executed |
+| exception | TextField | Exception traceback if failed |
+| content_length | IntegerField | Response size in bytes |
+| timestamp | DateTimeField | Request timestamp |
+
+## Performance Considerations
+
+- **Indexes**: The package includes optimized database indexes for common queries
+- **Query Optimization**: Analytics queries use `select_related()` and `annotate()` for efficiency
+- **Async Logging**: Consider implementing asynchronous logging for high-traffic applications
+- **Body Truncation**: Request/response bodies are automatically truncated to prevent database bloat
+- **Excluded Paths**: Static files and health checks are excluded by default
+
+## Security
+
+- **Sensitive Headers**: Authorization headers and cookies are automatically excluded from logging
+- **Admin Access**: Dashboard and API endpoints require staff/admin permissions
+- **User Authentication**: Built-in Django authentication and authorization
+- **CSRF Protection**: Standard Django CSRF protection applies
+
+## Contributing
+
+Contributions are welcome! Please follow these steps:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Versioning
+
+This project uses [Semantic Versioning](https://semver.org/):
+- **MAJOR** version for incompatible API changes
+- **MINOR** version for backwards-compatible functionality additions
+- **PATCH** version for backwards-compatible bug fixes
+
+See [CHANGELOG.md](CHANGELOG.md) for version history.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+- **Issues**: [GitHub Issues](https://github.com/farmsetu/django-trafficmonitor/issues)
+- **Documentation**: [GitHub Wiki](https://github.com/farmsetu/django-trafficmonitor/wiki)
+
+## Credits
+
+Developed by [FarmSetu Team](https://farmsetu.com)
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a detailed version history.

setu_trafficmonitor-2.0.0.dist-info/RECORD

@@ -0,0 +1,42 @@
+trafficmonitor/__init__.py,sha256=R33H15TOYxh3ql2Jo9ow4Xo_DoW48cs31ZyN9oN2qxE,277
+trafficmonitor/admin.py,sha256=yZDeH2jdA0X1RU6TTkYly-3DE7HG3X23d5-rGbxyzcw,6459
+trafficmonitor/apps.py,sha256=pyeGnn-R9mU0jKZGd0FErJWZbURtpt0RO4q87HEsO9A,197
+trafficmonitor/circuit_breaker.py,sha256=zSV8vcBQrQ6_xLb04yFKuo2qtvkogvuD4p2YFY5OIFs,1911
+trafficmonitor/conf.py,sha256=lJfutySfKzhRpuBYN5c_UGqg0EogQ9GhWBZkS6WlNJQ,6164
+trafficmonitor/dashboard_security.py,sha256=6_UAhXWKru3B165Dtgj96VOYQZG1J1Mf1lVYrm-GKWU,4106
+trafficmonitor/db_utils.py,sha256=cS99U-vQqNhphxkuqH4KZq84xbs8vCRGGq45yBRSRkU,1240
+trafficmonitor/exceptions.py,sha256=ZyPjQTpWXNAmtct8xJyFFsaitQBVffVlLx90P-KjzmM,2917
+trafficmonitor/health.py,sha256=oM1rbbbKvkw2PryPTh8bRZ1ODj-1SyRWlv52DnoyWD4,2341
+trafficmonitor/load_test.py,sha256=H8dkDY3w6w8TJ2izyNtUW2Qmk8bLP05Tl7CgLpH3xzA,15078
+trafficmonitor/load_test_api.py,sha256=U1pRK8Gr-zlyP2UUNj6Z0yQx9XbVa0JywIfyYWsWJQc,11344
+trafficmonitor/middleware.py,sha256=3QlN7jM8bdnSnBBiRWhxjdhmX9GzKMxwCXQ4Or6Z7xI,14827
+trafficmonitor/models.py,sha256=pBMuyIM9vJJzDqWaJUavgP2Djp6-I7YVFba4rNjkjWE,7192
+trafficmonitor/monitoring.py,sha256=NOJ_NUQZ-RDwhOVhhJ1CWx2FhdvfJXc0BkqqzKkCjoQ,3396
+trafficmonitor/permissions.py,sha256=uXLHGCcnhhvAbEAUe2IAMDI3sjIIPbNk-Jogv1diA64,2242
+trafficmonitor/security.py,sha256=EgM7LQwM1iuAzsE4ooPwgkq9fSy5Yh_bzFFgnDwz-Vs,6238
+trafficmonitor/settings_production.py,sha256=7LNPqdx76hxxo7L6LjHaQ-lKpwgJ1cmkblPE6WeiSkQ,2842
+trafficmonitor/tasks.py,sha256=IUDymluosGPB_qnxqRc92Zldviu2CWDogl_qe0szvug,4070
+trafficmonitor/tests.py,sha256=dFKVE2esGrt-Hx8V_NROK2lR9Nh3DOKQAQzMzGnUkPo,8807
+trafficmonitor/views.py,sha256=xc1IQHrsij7j33TUbo-_oewy3vs03pw_etpBWaMYJl0,63
+trafficmonitor/websocket_consumers.py,sha256=tvrbt0QffAcv3ec8wTU56WBWLiNhGgF8DsVR6YwAYx0,4322
+trafficmonitor/analytics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+trafficmonitor/analytics/enhanced_queries.py,sha256=1NLHQ42o_-xZ45XMxvsnrad_YmxWcPuJWmgxM2dStdE,11768
+trafficmonitor/analytics/serializers.py,sha256=cAge57F9328OSC0woUZ39vNH4mQMpZolSfcfgl04pXQ,6966
+trafficmonitor/analytics/tests.py,sha256=lNIG1u6NN_sDy9VecJJ9wkPNLfNO1sNHWYJzyiS5Ofk,25463
+trafficmonitor/analytics/urls.py,sha256=5f-WBeyU5dc_oifhRevFckYvTD7avb1ddUteUOYv_B8,514
+trafficmonitor/analytics/views.py,sha256=QSxyFzGSiNK2sP8Ra7BrmvwRud-qFbEhkSY4KNzgloM,24311
+trafficmonitor/management/__init__.py,sha256=1qi5wv2KVLIKoGVzItrB78D8xrbf3ruwO3_kGZ7bLh4,30
+trafficmonitor/management/commands/__init__.py,sha256=1pri3qN5PLFIRSwxLkZJ7Bc4W4UyiKBZCcJjqy1IUr0,22
+trafficmonitor/management/commands/cleanup_request_logs.py,sha256=EvcNlipAz8uwaPCFbsr3n4iwyVrfTCR1wGeGCu8MGMQ,2480
+trafficmonitor/migrations/0001_initial.py,sha256=y4bUcm5SHhtN5Ema4u10KZjjAjwz4DXuOTMq2qjETqg,5411
+trafficmonitor/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+trafficmonitor/static/analytics/css/dashboard.css,sha256=_H1mlAc9wH3-xlja1HGYw9HKYZtijH7abkPM7qc7A4s,1911
+trafficmonitor/static/analytics/js/dashboard-production.js,sha256=aRGgAEB7SGcZ5wBVj9G4FKwUl-t6GxxsdFDayDRw-6o,10542
+trafficmonitor/static/analytics/js/dashboard-v2.js,sha256=hZO1mUmdZK3YfCYLVX5ToaeWBfN_zPEE_T6e08fMEQM,21880
+trafficmonitor/static/analytics/js/dashboard.js,sha256=t-VfdUi8f2Bil6mIAeI-YmyBg0mMyAt5PigjQ7-I5Eo,20022
+trafficmonitor/templates/analytics/dashboard.html,sha256=O1vZR3oE7_19PSyrQ-GqehGWIDb7FTCcT22x60iYHio,24159
+setu_trafficmonitor-2.0.0.dist-info/LICENSE,sha256=UfMLKswUDNhVdUu-ul480Q3ei7XGfX_9uuAxK7OdWU4,1070
+setu_trafficmonitor-2.0.0.dist-info/METADATA,sha256=nzFDdITkS_2k5SjXqvbjmTabUmPqxE-YDUkIdkTntUA,12979
+setu_trafficmonitor-2.0.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+setu_trafficmonitor-2.0.0.dist-info/top_level.txt,sha256=81-5rK9eQL1OP2I-aXy5Nd7fw7gHRKYsOfPMN2tVpVE,15
+setu_trafficmonitor-2.0.0.dist-info/RECORD,,

setu_trafficmonitor-2.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.42.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

setu_trafficmonitor-2.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+trafficmonitor

trafficmonitor/__init__.py

@@ -0,0 +1,11 @@
+"""
+Django TrafficMonitor
+A comprehensive Django app for logging HTTP requests with analytics dashboard
+"""
+
+__version__ = '1.1.0'
+__author__ = 'FarmSetu Team'
+__email__ = 'tech@farmsetu.com'
+__license__ = 'MIT'
+
+default_app_config = 'trafficmonitor.apps.TrafficmonitorConfig'