fastapi-radar 0.1.6__tar.gz → 0.1.8__tar.gz

{fastapi_radar-0.1.6/fastapi_radar.egg-info → fastapi_radar-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-radar
-Version: 0.1.6
+Version: 0.1.8
 Summary: A debugging dashboard for FastAPI applications with real-time monitoring
 Home-page: https://github.com/doganarif/fastapi-radar
 Author: Arif Dogan
@@ -13,7 +13,6 @@ Keywords: fastapi,debugging,monitoring,dashboard,development-tools
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 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
@@ -24,19 +23,21 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: fastapi>=0.68.0
-Requires-Dist: sqlalchemy>=1.4.0
-Requires-Dist: pydantic>=1.8.0
-Requires-Dist: starlette>=0.14.2
+Requires-Dist: fastapi
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: pydantic
+Requires-Dist: starlette
+Requires-Dist: duckdb==1.1.3
+Requires-Dist: duckdb-engine==0.17.0
 Provides-Extra: dev
-Requires-Dist: pytest>=7.0.0; extra == "dev"
-Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
-Requires-Dist: uvicorn[standard]>=0.15.0; extra == "dev"
-Requires-Dist: black>=22.0.0; extra == "dev"
-Requires-Dist: isort>=5.10.0; extra == "dev"
-Requires-Dist: flake8>=4.0.0; extra == "dev"
-Requires-Dist: mypy>=0.950; extra == "dev"
-Requires-Dist: httpx>=0.28.1; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: uvicorn[standard]; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: httpx; extra == "dev"
 Dynamic: author
 Dynamic: home-page
 Dynamic: license-file
@@ -138,9 +139,30 @@ radar = Radar(
     capture_sql_bindings=True,   # Capture SQL query parameters
     exclude_paths=["/health"],   # Paths to exclude from monitoring
     theme="auto",                # Dashboard theme: "light", "dark", or "auto"
+    db_path="/path/to/db",       # Custom path for radar.duckdb file (default: current directory)
 )
 ```
 
+### Custom Database Location
+
+By default, FastAPI Radar stores its monitoring data in a `radar.duckdb` file in your current working directory. You can customize this location using the `db_path` parameter:
+
+```python
+# Store in a specific directory
+radar = Radar(app, db_path="/var/data/monitoring")
+# Creates: /var/data/monitoring/radar.duckdb
+
+# Store with a specific filename
+radar = Radar(app, db_path="/var/data/my_app_monitoring.duckdb")
+# Creates: /var/data/my_app_monitoring.duckdb
+
+# Use a relative path
+radar = Radar(app, db_path="./data")
+# Creates: ./data/radar.duckdb
+```
+
+If the specified path cannot be created, FastAPI Radar will fallback to using the current directory with a warning.
+
 ## What Gets Captured?
 
 - ✅ HTTP requests and responses

{fastapi_radar-0.1.6 → fastapi_radar-0.1.8}/README.md

@@ -94,9 +94,30 @@ radar = Radar(
     capture_sql_bindings=True,   # Capture SQL query parameters
     exclude_paths=["/health"],   # Paths to exclude from monitoring
     theme="auto",                # Dashboard theme: "light", "dark", or "auto"
+    db_path="/path/to/db",       # Custom path for radar.duckdb file (default: current directory)
 )
 ```
 
+### Custom Database Location
+
+By default, FastAPI Radar stores its monitoring data in a `radar.duckdb` file in your current working directory. You can customize this location using the `db_path` parameter:
+
+```python
+# Store in a specific directory
+radar = Radar(app, db_path="/var/data/monitoring")
+# Creates: /var/data/monitoring/radar.duckdb
+
+# Store with a specific filename
+radar = Radar(app, db_path="/var/data/my_app_monitoring.duckdb")
+# Creates: /var/data/my_app_monitoring.duckdb
+
+# Use a relative path
+radar = Radar(app, db_path="./data")
+# Creates: ./data/radar.duckdb
+```
+
+If the specified path cannot be created, FastAPI Radar will fallback to using the current directory with a warning.
+
 ## What Gets Captured?
 
 - ✅ HTTP requests and responses

{fastapi_radar-0.1.6 → fastapi_radar-0.1.8}/fastapi_radar/__init__.py

@@ -2,5 +2,5 @@
 
 from .radar import Radar
 
-__version__ = "0.1.6"
+__version__ = "0.1.8"
 __all__ = ["Radar"]

{fastapi_radar-0.1.6 → fastapi_radar-0.1.8}/fastapi_radar/api.py

@@ -1,13 +1,15 @@
 """API endpoints for FastAPI Radar dashboard."""
 
-from typing import Optional, List, Dict, Any
 from datetime import datetime, timedelta
-from fastapi import APIRouter, Query, Depends, HTTPException
-from sqlalchemy.orm import Session
-from sqlalchemy import desc
+from typing import Any, Dict, List, Optional, Union
+
+from fastapi import APIRouter, Depends, HTTPException, Query
 from pydantic import BaseModel
+from sqlalchemy import desc
+from sqlalchemy.orm import Session
 
-from .models import CapturedRequest, CapturedQuery, CapturedException
+from .models import CapturedRequest, CapturedQuery, CapturedException, Trace, Span
+from .tracing import TracingManager
 
 
 def round_float(value: Optional[float], decimals: int = 2) -> Optional[float]:
@@ -52,7 +54,7 @@ class QueryDetail(BaseModel):
     id: int
     request_id: str
     sql: str
-    parameters: Optional[Dict[str, Any]]
+    parameters: Union[Dict[str, str], List[str], None]
     duration_ms: Optional[float]
     rows_affected: Optional[int]
     connection_name: Optional[str]
@@ -78,6 +80,46 @@ class DashboardStats(BaseModel):
     requests_per_minute: float
 
 
+class TraceSummary(BaseModel):
+    trace_id: str
+    service_name: Optional[str]
+    operation_name: Optional[str]
+    start_time: datetime
+    end_time: Optional[datetime]
+    duration_ms: Optional[float]
+    span_count: int
+    status: str
+    created_at: datetime
+
+
+class WaterfallSpan(BaseModel):
+    span_id: str
+    parent_span_id: Optional[str]
+    operation_name: str
+    service_name: Optional[str]
+    start_time: Optional[str]  # ISO 8601 string
+    end_time: Optional[str]  # ISO 8601 string
+    duration_ms: Optional[float]
+    status: str
+    tags: Optional[Dict[str, Any]]
+    depth: int
+    offset_ms: float  # Offset from trace start in ms
+
+
+class TraceDetail(BaseModel):
+    trace_id: str
+    service_name: Optional[str]
+    operation_name: Optional[str]
+    start_time: datetime
+    end_time: Optional[datetime]
+    duration_ms: Optional[float]
+    span_count: int
+    status: str
+    tags: Optional[Dict[str, Any]]
+    created_at: datetime
+    spans: List[WaterfallSpan]
+
+
 def create_api_router(get_session_context) -> APIRouter:
     router = APIRouter(prefix="/__radar/api", tags=["radar"])
 
@@ -98,7 +140,6 @@ def create_api_router(get_session_context) -> APIRouter:
         query = session.query(CapturedRequest)
 
         if status_code:
-            # Handle status code ranges (e.g., 200 for 2xx, 400 for 4xx)
             if status_code in [200, 300, 400, 500]:
                 # Filter by status code range
                 lower_bound = status_code
@@ -328,4 +369,126 @@ def create_api_router(get_session_context) -> APIRouter:
         session.commit()
         return {"message": "Data cleared successfully"}
 
+    # Tracing-related API endpoints
+
+    @router.get("/traces", response_model=List[TraceSummary])
+    async def get_traces(
+        limit: int = Query(100, ge=1, le=1000),
+        offset: int = Query(0, ge=0),
+        status: Optional[str] = Query(None),
+        service_name: Optional[str] = Query(None),
+        min_duration_ms: Optional[float] = Query(None),
+        hours: int = Query(24, ge=1, le=720),
+        session: Session = Depends(get_db),
+    ):
+        """List traces."""
+        since = datetime.utcnow() - timedelta(hours=hours)
+        query = session.query(Trace).filter(Trace.created_at >= since)
+
+        if status:
+            query = query.filter(Trace.status == status)
+        if service_name:
+            query = query.filter(Trace.service_name == service_name)
+        if min_duration_ms:
+            query = query.filter(Trace.duration_ms >= min_duration_ms)
+
+        traces = (
+            query.order_by(desc(Trace.start_time)).offset(offset).limit(limit).all()
+        )
+
+        return [
+            TraceSummary(
+                trace_id=t.trace_id,
+                service_name=t.service_name,
+                operation_name=t.operation_name,
+                start_time=t.start_time,
+                end_time=t.end_time,
+                duration_ms=round_float(t.duration_ms),
+                span_count=t.span_count,
+                status=t.status,
+                created_at=t.created_at,
+            )
+            for t in traces
+        ]
+
+    @router.get("/traces/{trace_id}", response_model=TraceDetail)
+    async def get_trace_detail(
+        trace_id: str,
+        session: Session = Depends(get_db),
+    ):
+        """Get trace details."""
+        trace = session.query(Trace).filter(Trace.trace_id == trace_id).first()
+        if not trace:
+            raise HTTPException(status_code=404, detail="Trace not found")
+
+        # Fetch waterfall data
+        tracing_manager = TracingManager(lambda: get_session_context())
+        waterfall_spans = tracing_manager.get_waterfall_data(trace_id)
+
+        return TraceDetail(
+            trace_id=trace.trace_id,
+            service_name=trace.service_name,
+            operation_name=trace.operation_name,
+            start_time=trace.start_time,
+            end_time=trace.end_time,
+            duration_ms=round_float(trace.duration_ms),
+            span_count=trace.span_count,
+            status=trace.status,
+            tags=trace.tags,
+            created_at=trace.created_at,
+            spans=[WaterfallSpan(**span) for span in waterfall_spans],
+        )
+
+    @router.get("/traces/{trace_id}/waterfall")
+    async def get_trace_waterfall(
+        trace_id: str,
+        session: Session = Depends(get_db),
+    ):
+        """Get optimized waterfall data for a trace."""
+        # Ensure the trace exists
+        trace = session.query(Trace).filter(Trace.trace_id == trace_id).first()
+        if not trace:
+            raise HTTPException(status_code=404, detail="Trace not found")
+
+        tracing_manager = TracingManager(lambda: get_session_context())
+        waterfall_data = tracing_manager.get_waterfall_data(trace_id)
+
+        return {
+            "trace_id": trace_id,
+            "spans": waterfall_data,
+            "trace_info": {
+                "service_name": trace.service_name,
+                "operation_name": trace.operation_name,
+                "total_duration_ms": trace.duration_ms,
+                "span_count": trace.span_count,
+                "status": trace.status,
+            },
+        }
+
+    @router.get("/spans/{span_id}")
+    async def get_span_detail(
+        span_id: str,
+        session: Session = Depends(get_db),
+    ):
+        """Get span details."""
+        span = session.query(Span).filter(Span.span_id == span_id).first()
+        if not span:
+            raise HTTPException(status_code=404, detail="Span not found")
+
+        return {
+            "span_id": span.span_id,
+            "trace_id": span.trace_id,
+            "parent_span_id": span.parent_span_id,
+            "operation_name": span.operation_name,
+            "service_name": span.service_name,
+            "span_kind": span.span_kind,
+            "start_time": span.start_time.isoformat() if span.start_time else None,
+            "end_time": span.end_time.isoformat() if span.end_time else None,
+            "duration_ms": span.duration_ms,
+            "status": span.status,
+            "tags": span.tags,
+            "logs": span.logs,
+            "created_at": span.created_at.isoformat(),
+        }
+
     return router

{fastapi_radar-0.1.6 → fastapi_radar-0.1.8}/fastapi_radar/capture.py

@@ -1,13 +1,15 @@
 """SQLAlchemy query capture for FastAPI Radar."""
 
 import time
-from typing import Any, Optional, Callable
+from typing import Any, Callable, Dict, List, Union
+
 from sqlalchemy import event
 from sqlalchemy.engine import Engine
 
 from .middleware import request_context
 from .models import CapturedQuery
 from .utils import format_sql
+from .tracing import get_current_trace_context
 
 
 class QueryCapture:
@@ -23,12 +25,10 @@ class QueryCapture:
         self._query_start_times = {}
 
     def register(self, engine: Engine) -> None:
-        """Register SQLAlchemy event listeners."""
         event.listen(engine, "before_cursor_execute", self._before_cursor_execute)
         event.listen(engine, "after_cursor_execute", self._after_cursor_execute)
 
     def unregister(self, engine: Engine) -> None:
-        """Unregister SQLAlchemy event listeners."""
         event.remove(engine, "before_cursor_execute", self._before_cursor_execute)
         event.remove(engine, "after_cursor_execute", self._after_cursor_execute)
 
@@ -45,7 +45,23 @@ class QueryCapture:
         if not request_id:
             return
 
-        self._query_start_times[id(context)] = time.time()
+        context_id = id(context)
+        self._query_start_times[context_id] = time.time()
+
+        trace_ctx = get_current_trace_context()
+        if trace_ctx:
+            formatted_sql = format_sql(statement)
+            operation_type = self._get_operation_type(statement)
+            span_id = trace_ctx.create_span(
+                operation_name=f"DB {operation_type}",
+                span_kind="client",
+                tags={
+                    "db.statement": formatted_sql[:500],  # limit SQL length
+                    "db.operation_type": operation_type,
+                    "component": "database",
+                },
+            )
+            setattr(context, "_radar_span_id", span_id)
 
     def _after_cursor_execute(
         self,
@@ -66,7 +82,23 @@ class QueryCapture:
 
         duration_ms = round((time.time() - start_time) * 1000, 2)
 
-        # Skip radar's own queries
+        trace_ctx = get_current_trace_context()
+        if trace_ctx and hasattr(context, "_radar_span_id"):
+            span_id = getattr(context, "_radar_span_id")
+            additional_tags = {
+                "db.duration_ms": duration_ms,
+                "db.rows_affected": (
+                    cursor.rowcount if hasattr(cursor, "rowcount") else None
+                ),
+            }
+
+            status = "ok"
+            if duration_ms >= self.slow_query_threshold:
+                status = "slow"
+                additional_tags["db.slow_query"] = True
+
+            trace_ctx.finish_span(span_id, status=status, tags=additional_tags)
+
         if "radar_" in statement:
             return
 
@@ -90,15 +122,40 @@ class QueryCapture:
                 session.add(captured_query)
                 session.commit()
         except Exception:
-            pass  # Silently ignore storage errors
-
-    def _serialize_parameters(self, parameters: Any) -> Optional[list]:
+            pass
+
+    def _get_operation_type(self, statement: str) -> str:
+        if not statement:
+            return "unknown"
+
+        statement = statement.strip().upper()
+
+        if statement.startswith("SELECT"):
+            return "SELECT"
+        elif statement.startswith("INSERT"):
+            return "INSERT"
+        elif statement.startswith("UPDATE"):
+            return "UPDATE"
+        elif statement.startswith("DELETE"):
+            return "DELETE"
+        elif statement.startswith("CREATE"):
+            return "CREATE"
+        elif statement.startswith("DROP"):
+            return "DROP"
+        elif statement.startswith("ALTER"):
+            return "ALTER"
+        else:
+            return "OTHER"
+
+    def _serialize_parameters(
+        self, parameters: Any
+    ) -> Union[Dict[str, str], List[str], None]:
         """Serialize query parameters for storage."""
         if not parameters:
             return None
 
         if isinstance(parameters, (list, tuple)):
-            return [str(p) for p in parameters[:100]]  # Limit to 100 params
+            return [str(p) for p in parameters[:100]]
         elif isinstance(parameters, dict):
             return {k: str(v) for k, v in list(parameters.items())[:100]}