File size: 9,099 Bytes
7a87926 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
"""
API middleware for logging, profiling, and error handling.
"""
import functools
import logging
import time
from typing import Callable
from fastapi import HTTPException, Request
from fastapi.responses import JSONResponse
logger = logging.getLogger(__name__)
try:
from .profiler import Profiler, profile_context
HAS_PROFILER = True
except ImportError:
HAS_PROFILER = False
def api_endpoint_logging(
endpoint_name: str,
log_request: bool = True,
log_response: bool = True,
include_profiling: bool = True,
):
"""
Decorator for API endpoints that adds:
- Request/response logging
- Error handling with structured error responses
- Profiling integration
- Timing information
Args:
endpoint_name: Name of the endpoint for logging
log_request: Whether to log request details
log_response: Whether to log response details
include_profiling: Whether to include profiling
"""
def decorator(func: Callable) -> Callable:
@functools.wraps(func)
async def wrapper(*args, **kwargs):
request = kwargs.get("request") or (
args[0] if args and isinstance(args[0], Request) else None
)
# Extract request details
request_id = None
if request:
request_id = (
request.headers.get("X-Request-ID") or f"req_{int(time.time() * 1000)}"
)
client_ip = request.client.host if request.client else "unknown"
method = request.method
path = request.url.path
query_params = dict(request.query_params)
else:
client_ip = "unknown"
method = "UNKNOWN"
path = endpoint_name
query_params = {}
start_time = time.time()
# Log request
if log_request:
logger.info(
f"[{endpoint_name}] Request started",
extra={
"request_id": request_id,
"method": method,
"path": path,
"client_ip": client_ip,
"query_params": query_params,
"endpoint": endpoint_name,
},
)
# Track request with profiler if available
profiler_context = None
if include_profiling and HAS_PROFILER:
profiler = Profiler.get_instance()
if profiler.enabled:
profiler_context = profile_context(
stage="api_endpoint", operation=endpoint_name
)
profiler_context.__enter__()
try:
# Execute the endpoint function
if profiler_context:
with profile_context(stage="api_endpoint", operation=endpoint_name):
result = await func(*args, **kwargs)
else:
result = await func(*args, **kwargs)
duration = time.time() - start_time
# Log successful response
if log_response:
status_code = 200
if hasattr(result, "status_code"):
status_code = result.status_code
elif isinstance(result, dict) and "status_code" in result:
status_code = result["status_code"]
logger.info(
f"[{endpoint_name}] Request completed successfully",
extra={
"request_id": request_id,
"duration_ms": duration * 1000,
"status_code": status_code,
"endpoint": endpoint_name,
},
)
return result
except HTTPException as e:
duration = time.time() - start_time
logger.warning(
f"[{endpoint_name}] HTTP error",
extra={
"request_id": request_id,
"duration_ms": duration * 1000,
"status_code": e.status_code,
"detail": str(e.detail),
"endpoint": endpoint_name,
},
exc_info=True,
)
raise
except ValueError as e:
duration = time.time() - start_time
logger.error(
f"[{endpoint_name}] Validation error",
extra={
"request_id": request_id,
"duration_ms": duration * 1000,
"error": str(e),
"endpoint": endpoint_name,
},
exc_info=True,
)
return JSONResponse(
status_code=400,
content={
"error": "ValidationError",
"message": str(e),
"request_id": request_id,
"endpoint": endpoint_name,
},
)
except FileNotFoundError as e:
duration = time.time() - start_time
logger.error(
f"[{endpoint_name}] File not found",
extra={
"request_id": request_id,
"duration_ms": duration * 1000,
"error": str(e),
"endpoint": endpoint_name,
},
exc_info=True,
)
return JSONResponse(
status_code=404,
content={
"error": "FileNotFoundError",
"message": str(e),
"request_id": request_id,
"endpoint": endpoint_name,
},
)
except PermissionError as e:
duration = time.time() - start_time
logger.error(
f"[{endpoint_name}] Permission error",
extra={
"request_id": request_id,
"duration_ms": duration * 1000,
"error": str(e),
"endpoint": endpoint_name,
},
exc_info=True,
)
return JSONResponse(
status_code=403,
content={
"error": "PermissionError",
"message": str(e),
"request_id": request_id,
"endpoint": endpoint_name,
},
)
except Exception as e:
duration = time.time() - start_time
# Log full exception with traceback
logger.error(
f"[{endpoint_name}] Unexpected error",
extra={
"request_id": request_id,
"duration_ms": duration * 1000,
"error_type": type(e).__name__,
"error": str(e),
"endpoint": endpoint_name,
},
exc_info=True,
)
# Return structured error response
return JSONResponse(
status_code=500,
content={
"error": "InternalServerError",
"message": "An unexpected error occurred",
"error_type": type(e).__name__,
"request_id": request_id,
"endpoint": endpoint_name,
},
)
finally:
if profiler_context:
try:
profiler_context.__exit__(None, None, None)
except Exception:
pass
return wrapper
return decorator
def log_execution_time(func_name: str):
"""Decorator to log execution time of a function."""
def decorator(func: Callable) -> Callable:
@functools.wraps(func)
def wrapper(*args, **kwargs):
start_time = time.time()
try:
result = func(*args, **kwargs)
duration = time.time() - start_time
logger.debug(f"{func_name} executed in {duration:.3f}s")
return result
except Exception as e:
duration = time.time() - start_time
logger.error(f"{func_name} failed after {duration:.3f}s: {e}", exc_info=True)
raise
return wrapper
return decorator
|