pyapimon 0.1.3

Python middleware for API monitoring and analytics

pyapimon

Python middleware for API monitoring and analytics. Integrates directly into your web framework to capture request/response data, store it locally, and provide a rich CLI for exploration and insights.

Install

pip install pyapimon

With LLM-powered insights:

pip install pyapimon[llm]

Quickstart

FastAPI

from fastapi import FastAPI
from pyapimon import FastAPIMiddleware

app = FastAPI()
app.add_middleware(FastAPIMiddleware)

Django

Add to settings.py:

MIDDLEWARE = [
    "pyapimon.middleware.django.DjangoMiddleware",
    # ... other middleware
]

# Optional
PYAPIMON = {
    "db_path": "/tmp/apimon.db",
    "flush_interval": 3,
}

Flask

from flask import Flask
from pyapimon import FlaskMiddleware

app = Flask(__name__)
FlaskMiddleware(app)

CLI Commands

CLI commands now support interactive timeframe selection (e.g., past 24h, 7d, 30d, all-time). If you do not provide the --hours option, pyapimon will prompt you automatically.

pyapimon stats            Route statistics table
pyapimon requests         Recent request list
pyapimon request <id>     Single request detail
pyapimon ui               Interactive TUI dashboard
pyapimon dashboard        Rich terminal dashboard
pyapimon insights         LLM-powered analysis
pyapimon suggestions      Rule-based suggestions
pyapimon graph            ASCII time-series graph
pyapimon export <file>    Export analytics to JSON
pyapimon clear            Clear all captured data
pyapimon doctor           Verify middleware is working
pyapimon version          Show version

Configuration

All options are optional with sane defaults:

Option	Default	Description
db_path	"apimon.db"	SQLite database file path
flush_interval	2.0	Seconds between batch flushes
flush_size	100	Max buffered records before force-flush
record_bodies	True	Capture request/response bodies
body_max_length	10000	Truncate bodies beyond this length
excluded_paths	[]	Paths to skip. Accepts a list ["/health"] or a comma-separated string "/health,/metrics"
excluded_headers	["authorization", "cookie", "set-cookie"]	Headers to redact

Key Features

• Performance Tracking: Measure average response times, max/min, and Request/Second metrics.
• Percentiles & Status Codes: View P50, P90, P95, and P99 latency percentiles alongside HTTP status distributions in the rich dashboard.
• LLM Insights: Pass your analytics to an LLM provider for deep architectural advice.
• Zero Overhead: Utilizes a background thread and queue mechanism to prevent adding latency to your API routes.

Development

git clone https://github.com/Mohammad-Palla/pyapimon.git
cd pyapimon
pip install -e ".[dev]"
pytest

License

MIT