django-api-profiler 0.1.0__tar.gz

django_api_profiler-0.1.0/.env

@@ -0,0 +1,6 @@
+SECRET_KEY='django-insecure-8*)!%iue3qqv2q@90o1-qy^##r=zh%1ps63&01aogcpkw%vz2#'
+DB_NAME=profiler_db
+DB_USER=ahmed
+DB_PASSWORD=programming
+DB_HOST=localhost
+DB_PORT=5432

django_api_profiler-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

django_api_profiler-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

django_api_profiler-0.1.0/Dockerfile

@@ -0,0 +1,21 @@
+FROM python:3.12-slim
+
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+
+WORKDIR /src
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    libpq-dev \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN pip install uv
+
+COPY pyproject.toml uv.lock .python-version ./
+RUN uv sync --frozen
+
+COPY . .
+
+EXPOSE 8000
+
+CMD ["uv", "run", "python", "manage.py", "runserver", "0.0.0.0:8000"]

django_api_profiler-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ahmed
+
+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.

django_api_profiler-0.1.0/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: django-api-profiler
+Version: 0.1.0
+Summary: Lightweight API profiling and endpoint analytics for Django
+Author: Ahmed
+License: MIT
+License-File: LICENSE
+Keywords: analytics,django,monitoring,performance,profiling
+Classifier: Framework :: Django
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: django>=4.2
+Provides-Extra: async
+Requires-Dist: celery>=5.6.3; extra == 'async'
+Requires-Dist: redis>=7.4.0; extra == 'async'
+Provides-Extra: beat
+Requires-Dist: django-celery-beat>=2.9.0; extra == 'beat'
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary>=2.9.12; extra == 'postgres'
+Description-Content-Type: text/markdown
+
+# Django API Profiler
+
+Lightweight API profiling and endpoint analytics for Django.
+
+## Features
+
+- Request latency tracking
+- Endpoint summaries
+- p95 response metrics
+- Error rate monitoring
+- Slow request detection
+- N+1 query detection
+- Django admin integration
+- Optional async ingestion with Celery
+
+---
+
+## Installation
+
+```bash
+pip install django-api-profiler
+```
+
+---
+
+## Quickstart
+
+Add the app:
+
+```python
+INSTALLED_APPS = [
+    ...
+    "django_api_profiler",
+]
+```
+
+Add the middleware:
+
+```python
+MIDDLEWARE = [
+    ...
+    "django_api_profiler.middleware.ApiProfilerMiddleware",
+]
+```
+
+Run migrations:
+
+```bash
+python manage.py migrate
+```
+
+---
+
+## Configuration
+
+```python
+PROFILER = {
+    "ASYNC": False,
+    "SLOW_REQUEST_THRESHOLD_MS": 1000,
+    "AGGREGATION_WINDOW_MINUTES": 60,
+}
+```
+
+---
+
+## Admin Dashboard
+
+The package provides Django admin integration for:
+- endpoint summaries
+- latency metrics
+- error tracking
+- regression detection
+
+---
+
+## Optional Async Support
+
+Install async dependencies:
+
+```bash
+pip install django-api-profiler[async]
+```
+
+Then enable:
+
+```python
+PROFILER = {
+    "ASYNC": True,
+}
+```
+
+---
+
+## License
+
+MIT

django_api_profiler-0.1.0/README.md

@@ -0,0 +1,96 @@
+# Django API Profiler
+
+Lightweight API profiling and endpoint analytics for Django.
+
+## Features
+
+- Request latency tracking
+- Endpoint summaries
+- p95 response metrics
+- Error rate monitoring
+- Slow request detection
+- N+1 query detection
+- Django admin integration
+- Optional async ingestion with Celery
+
+---
+
+## Installation
+
+```bash
+pip install django-api-profiler
+```
+
+---
+
+## Quickstart
+
+Add the app:
+
+```python
+INSTALLED_APPS = [
+    ...
+    "django_api_profiler",
+]
+```
+
+Add the middleware:
+
+```python
+MIDDLEWARE = [
+    ...
+    "django_api_profiler.middleware.ApiProfilerMiddleware",
+]
+```
+
+Run migrations:
+
+```bash
+python manage.py migrate
+```
+
+---
+
+## Configuration
+
+```python
+PROFILER = {
+    "ASYNC": False,
+    "SLOW_REQUEST_THRESHOLD_MS": 1000,
+    "AGGREGATION_WINDOW_MINUTES": 60,
+}
+```
+
+---
+
+## Admin Dashboard
+
+The package provides Django admin integration for:
+- endpoint summaries
+- latency metrics
+- error tracking
+- regression detection
+
+---
+
+## Optional Async Support
+
+Install async dependencies:
+
+```bash
+pip install django-api-profiler[async]
+```
+
+Then enable:
+
+```python
+PROFILER = {
+    "ASYNC": True,
+}
+```
+
+---
+
+## License
+
+MIT

django_api_profiler-0.1.0/config/__init__.py

@@ -0,0 +1,3 @@
+from .celery import app as celery_app
+
+__all__ = ('celery_app',)

django_api_profiler-0.1.0/config/asgi.py

@@ -0,0 +1,7 @@
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings')
+
+application = get_asgi_application()

django_api_profiler-0.1.0/config/celery.py

@@ -0,0 +1,10 @@
+import os
+from celery import Celery
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings')
+
+app = Celery('config')
+
+app.config_from_object('django.conf:settings', namespace='CELERY')
+
+app.autodiscover_tasks()

django_api_profiler-0.1.0/config/settings.py

@@ -0,0 +1,114 @@
+from pathlib import Path
+from dotenv import load_dotenv
+from celery.schedules import crontab
+import os
+
+load_dotenv()
+
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+SECRET_KEY = os.getenv("SECRET_KEY")
+
+
+DEBUG = True
+
+ALLOWED_HOSTS = ['*']
+
+
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'django_celery_beat',
+    'profiler',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'profiler.middleware.ApiProfilerMiddleware',
+]
+
+ROOT_URLCONF = 'config.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'config.wsgi.application'
+
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': os.environ.get('DB_NAME'),
+        'USER': os.environ.get('DB_USER'),
+        'PASSWORD': os.environ.get('DB_PASSWORD'),
+        'HOST': os.environ.get('DB_HOST', 'localhost'),
+        'PORT': os.environ.get('DB_PORT', '5432'),
+    }
+}
+
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+STATIC_URL = 'static/'
+
+CELERY_BROKER_URL = os.environ.get('CELERY_BROKER_URL', 'redis://localhost:6379/0')
+CELERY_RESULT_BACKEND = os.environ.get('CELERY_RESULT_BACKEND', 'redis://localhost:6379/0')
+CELERY_TIMEZONE = 'UTC'
+
+CELERY_BEAT_SCHEDULER = 'django_celery_beat.schedulers:DatabaseScheduler'
+
+
+
+CELERY_BEAT_SCHEDULE = {
+    'compute-endpoint-summaries': {
+        'task': 'profiler.tasks.run_aggregation',
+        'schedule': crontab(minute=0),  
+    },
+}

django_api_profiler-0.1.0/config/urls.py

@@ -0,0 +1,6 @@
+from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+]

django_api_profiler-0.1.0/config/wsgi.py

@@ -0,0 +1,7 @@
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings')
+
+application = get_wsgi_application()

django_api_profiler-0.1.0/docker-compose.yml

@@ -0,0 +1,71 @@
+services:
+
+  db:
+    image: postgres:16-alpine
+    environment:
+      POSTGRES_DB: ${DB_NAME}
+      POSTGRES_USER: ${DB_USER}
+      POSTGRES_PASSWORD: ${DB_PASSWORD}
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U ${DB_USER}"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
+  redis:
+    image: redis:7-alpine
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
+  web:
+    build: .
+    image: django-api-profiler:latest  
+    restart: unless-stopped
+    command: >
+      sh -c "/src/.venv/bin/python manage.py migrate &&
+             /src/.venv/bin/gunicorn config.wsgi:application --bind 0.0.0.0:8000 --workers 3"
+    volumes:
+      - .:/src
+    ports:
+      - "8000:8000"
+    env_file:
+      - .env
+    depends_on:
+      db:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+
+  celery:
+    image: django-api-profiler:latest  
+    command: uv run celery -A config worker --loglevel=info
+    volumes:
+      - .:/src
+    env_file:
+      - .env
+    depends_on:
+      db:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+
+  celery_beat:
+    image: django-api-profiler:latest
+    command: uv run celery -A config beat --loglevel=info --scheduler django_celery_beat.schedulers:DatabaseScheduler
+    volumes:
+      - .:/src
+    env_file:
+      - .env
+    depends_on:
+      db:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+
+volumes:
+  postgres_data:

django_api_profiler-0.1.0/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

django_api_profiler-0.1.0/profiler/admin.py

@@ -0,0 +1,80 @@
+from django.contrib import admin
+from django.utils.html import format_html
+from .models import RequestMetric , EndpointSummary
+
+
+@admin.register(RequestMetric)
+class RequestMetricAdmin(admin.ModelAdmin):
+    list_display = (
+        "path",
+        "method",
+        "status_code",
+        "colored_response_time",
+        "query_count",
+        "total_query_time_ms",
+        "exception_type",
+        "exception_message",
+        "created_at",
+    )
+
+    list_filter = (
+        "method",
+        "status_code",
+        "created_at"
+    )
+
+    readonly_fields = list_display
+
+    ordering = ("-created_at",)
+
+    def colored_response_time(self, obj):
+
+        if obj.response_time_ms > 1000:
+            color = "red"
+
+        elif obj.response_time_ms > 500:
+            color = "orange"
+
+        else:
+            color = "lightgreen"
+
+        formatted_time = f"{obj.response_time_ms:.2f} ms"
+
+        return format_html(
+            '<span style="color: {}; font-weight: bold;">{}</span>',
+            color,
+            formatted_time
+        )
+    
+
+@admin.register(EndpointSummary)
+class EndpointSummaryAdmin(admin.ModelAdmin):
+
+    list_display = (
+        "route",
+        "window_start",
+        "total_requests",
+        "avg_response_ms",
+        "p95_response_ms",
+        "error_count",
+        "slow_count",
+    )
+
+    list_filter = (
+        "window_start",
+        "computed_at",
+    )
+
+    search_fields = ("route",)
+
+    ordering = ("-window_start",)
+
+    readonly_fields = [field.name for field in EndpointSummary._meta.fields]
+
+    date_hierarchy = "window_start"
+
+    def has_add_permission(self, request):
+        return False
+
+    def has_delete_permission(self, request, obj=None):
+        return False

django_api_profiler-0.1.0/profiler/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class ProfilerConfig(AppConfig):
+    name = 'profiler'

django_api_profiler-0.1.0/profiler/conf.py

@@ -0,0 +1,31 @@
+from django.conf import settings
+
+_DEFAULTS = {
+    "ASYNC": False,
+    "SLOW_REQUEST_THRESHOLD_MS": 1000,
+    "AGGREGATION_WINDOW_MINUTES": 60,
+    "IGNORED_PATHS": ["/admin", "/static", "/favicon.ico"],
+    "N_PLUS_ONE_THRESHOLD": 3,
+    "SLOW_QUERY_THRESHOLD_MS": 100,
+    "REGRESSION_RESPONSE_TIME_FACTOR": 2.0,
+    "REGRESSION_ERROR_RATE_DELTA": 0.1,
+}
+
+
+class ProfilerSettings:
+
+    def __init__(self):
+        self._user_settings = getattr(settings, "PROFILER", {})
+
+    def __getattr__(self, name):
+        if name not in _DEFAULTS:
+            raise AttributeError(f"Invalid profiler setting: '{name}'")
+        
+        default = _DEFAULTS[name]
+        user_value = self._user_settings.get(name, default)
+
+        return user_value
+    
+
+
+profiler_settings = ProfilerSettings()

django_api_profiler-0.1.0/profiler/db_wrapper.py

@@ -0,0 +1,33 @@
+from django.db.backends.utils import CursorWrapper
+import threading
+
+_local = threading.local()
+
+def reset_query_log():
+    _local.queries = []
+
+def get_query_log():
+    return list(getattr(_local, "queries", []))
+
+class ProfilingCursorWrapper(CursorWrapper):
+    def execute(self, sql, params=None):
+        import time
+        start = time.perf_counter()
+        try:
+            return super().execute(sql, params)
+        finally:
+            duration = (time.perf_counter() - start) * 1000
+            if not hasattr(_local, "queries"):
+                _local.queries = []
+            _local.queries.append({"sql": sql, "time_ms": duration})
+
+    def executemany(self, sql, param_list):
+        import time
+        start = time.perf_counter()
+        try:
+            return super().executemany(sql, param_list)
+        finally:
+            duration = (time.perf_counter() - start) * 1000
+            if not hasattr(_local, "queries"):
+                _local.queries = []
+            _local.queries.append({"sql": sql, "time_ms": duration})