Spaces:
Sleeping
Sleeping
File size: 24,061 Bytes
c4f5f25 | 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 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 | """
API Analytics and Usage Tracking for MediGuard AI.
Comprehensive analytics for API usage, performance, and user behavior.
"""
import asyncio
import json
import logging
import time
import uuid
from collections import defaultdict
from dataclasses import asdict, dataclass
from datetime import datetime, timedelta
from enum import Enum
from typing import Any
import redis.asyncio as redis
from fastapi import Request, Response
from starlette.middleware.base import BaseHTTPMiddleware
logger = logging.getLogger(__name__)
class EventType(Enum):
"""Types of analytics events."""
API_REQUEST = "api_request"
API_RESPONSE = "api_response"
ERROR = "error"
USER_ACTION = "user_action"
SYSTEM_EVENT = "system_event"
@dataclass
class AnalyticsEvent:
"""Analytics event data."""
event_id: str
event_type: EventType
timestamp: datetime
user_id: str | None = None
api_key_id: str | None = None
session_id: str | None = None
request_id: str | None = None
endpoint: str | None = None
method: str | None = None
status_code: int | None = None
response_time_ms: float | None = None
request_size_bytes: int | None = None
response_size_bytes: int | None = None
user_agent: str | None = None
ip_address: str | None = None
metadata: dict[str, Any] | None = None
def to_dict(self) -> dict[str, Any]:
"""Convert to dictionary."""
data = asdict(self)
data['event_type'] = self.event_type.value
data['timestamp'] = self.timestamp.isoformat()
return data
@dataclass
class UsageMetrics:
"""Usage metrics for a time period."""
total_requests: int = 0
successful_requests: int = 0
failed_requests: int = 0
unique_users: int = 0
unique_api_keys: int = 0
average_response_time: float = 0.0
total_bandwidth_bytes: int = 0
top_endpoints: list[dict[str, Any]] = None
errors_by_type: dict[str, int] = None
requests_by_hour: dict[str, int] = None
def __post_init__(self):
if self.top_endpoints is None:
self.top_endpoints = []
if self.errors_by_type is None:
self.errors_by_type = {}
if self.requests_by_hour is None:
self.requests_by_hour = {}
class AnalyticsProvider:
"""Base class for analytics providers."""
async def store_event(self, event: AnalyticsEvent) -> bool:
"""Store an analytics event."""
raise NotImplementedError
async def get_metrics(
self,
start_time: datetime,
end_time: datetime,
filters: dict[str, Any] = None
) -> UsageMetrics:
"""Get usage metrics for a time period."""
raise NotImplementedError
async def get_events(
self,
start_time: datetime,
end_time: datetime,
filters: dict[str, Any] = None,
limit: int = 100
) -> list[AnalyticsEvent]:
"""Get analytics events."""
raise NotImplementedError
class RedisAnalyticsProvider(AnalyticsProvider):
"""Redis-based analytics provider."""
def __init__(self, redis_url: str, key_prefix: str = "analytics:"):
self.redis_url = redis_url
self.key_prefix = key_prefix
self._client: redis.Redis | None = None
async def _get_client(self) -> redis.Redis:
"""Get Redis client."""
if not self._client:
self._client = redis.from_url(self.redis_url)
return self._client
def _make_key(self, *parts: str) -> str:
"""Make Redis key."""
return f"{self.key_prefix}{':'.join(parts)}"
async def store_event(self, event: AnalyticsEvent) -> bool:
"""Store an analytics event."""
try:
client = await self._get_client()
# Store event data
event_key = self._make_key("events", event.event_id)
await client.setex(
event_key,
86400 * 30, # 30 days TTL
json.dumps(event.to_dict())
)
# Update counters
await self._update_counters(client, event)
# Add to time-based indices
await self._add_to_time_indices(client, event)
return True
except Exception as e:
logger.error(f"Failed to store analytics event: {e}")
return False
async def _update_counters(self, client: redis.Redis, event: AnalyticsEvent):
"""Update various counters for the event."""
# Daily counters
date_key = event.timestamp.strftime("%Y-%m-%d")
# Total requests
await client.incr(self._make_key("daily", date_key, "requests"))
# Endpoint counters
if event.endpoint:
await client.incr(self._make_key("daily", date_key, "endpoints", event.endpoint))
# Status code counters
if event.status_code:
await client.incr(self._make_key("daily", date_key, "status", str(event.status_code)))
# User counters
if event.user_id:
await client.sadd(self._make_key("daily", date_key, "users"), event.user_id)
# API key counters
if event.api_key_id:
await client.sadd(self._make_key("daily", date_key, "api_keys"), event.api_key_id)
# Response time tracking
if event.response_time_ms:
await client.lpush(
self._make_key("daily", date_key, "response_times"),
event.response_time_ms
)
await client.ltrim(self._make_key("daily", date_key, "response_times"), 0, 9999)
async def _add_to_time_indices(self, client: redis.Redis, event: AnalyticsEvent):
"""Add event to time-based indices."""
# Hourly index
hour_key = event.timestamp.strftime("%Y-%m-%d:%H")
await client.zadd(
self._make_key("hourly", hour_key),
{event.event_id: event.timestamp.timestamp()}
)
await client.expire(self._make_key("hourly", hour_key), 86400 * 7) # 7 days
async def get_metrics(
self,
start_time: datetime,
end_time: datetime,
filters: dict[str, Any] = None
) -> UsageMetrics:
"""Get usage metrics for a time period."""
client = await self._get_client()
metrics = UsageMetrics()
# Iterate through days in range
current_date = start_time.date()
end_date = end_time.date()
total_response_times = []
endpoint_counts = defaultdict(int)
while current_date <= end_date:
date_key = current_date.strftime("%Y-%m-%d")
# Get daily counters
metrics.total_requests += int(
await client.get(self._make_key("daily", date_key, "requests")) or 0
)
# Get successful requests (2xx status codes)
for status in range(200, 300):
count = int(
await client.get(self._make_key("daily", date_key, "status", str(status))) or 0
)
metrics.successful_requests += count
# Get unique users
users = await client.smembers(self._make_key("daily", date_key, "users"))
metrics.unique_users += len(users)
# Get unique API keys
api_keys = await client.smembers(self._make_key("daily", date_key, "api_keys"))
metrics.unique_api_keys += len(api_keys)
# Get response times
times = await client.lrange(self._make_key("daily", date_key, "response_times"), 0, -1)
total_response_times.extend([float(t) for t in times])
# Get endpoint counts
for endpoint in await client.keys(self._make_key("daily", date_key, "endpoints", "*")):
endpoint_name = endpoint.decode().split(":")[-1]
count = int(await client.get(endpoint) or 0)
endpoint_counts[endpoint_name] += count
current_date += timedelta(days=1)
# Calculate derived metrics
metrics.failed_requests = metrics.total_requests - metrics.successful_requests
if total_response_times:
metrics.average_response_time = sum(total_response_times) / len(total_response_times)
# Top endpoints
metrics.top_endpoints = [
{"endpoint": ep, "requests": count}
for ep, count in sorted(endpoint_counts.items(), key=lambda x: x[1], reverse=True)[:10]
]
return metrics
async def get_events(
self,
start_time: datetime,
end_time: datetime,
filters: dict[str, Any] = None,
limit: int = 100
) -> list[AnalyticsEvent]:
"""Get analytics events."""
client = await self._get_client()
events = []
# Search through hourly indices
current_hour = start_time.replace(minute=0, second=0, microsecond=0)
while current_hour <= end_time and len(events) < limit:
hour_key = current_hour.strftime("%Y-%m-%d:%H")
# Get event IDs from sorted set
event_ids = await client.zrangebyscore(
self._make_key("hourly", hour_key),
start_time.timestamp(),
end_time.timestamp(),
start=0,
num=limit - len(events)
)
# Get event data
for event_id in event_ids:
event_key = self._make_key("events", event_id.decode())
event_data = await client.get(event_key)
if event_data:
event_dict = json.loads(event_data)
event = AnalyticsEvent(
event_id=event_dict["event_id"],
event_type=EventType(event_dict["event_type"]),
timestamp=datetime.fromisoformat(event_dict["timestamp"]),
user_id=event_dict.get("user_id"),
api_key_id=event_dict.get("api_key_id"),
endpoint=event_dict.get("endpoint"),
status_code=event_dict.get("status_code"),
response_time_ms=event_dict.get("response_time_ms")
)
# Apply filters
if self._matches_filters(event, filters):
events.append(event)
current_hour += timedelta(hours=1)
return events
def _matches_filters(self, event: AnalyticsEvent, filters: dict[str, Any]) -> bool:
"""Check if event matches filters."""
if not filters:
return True
if filters.get("user_id") and event.user_id != filters["user_id"]:
return False
if filters.get("api_key_id") and event.api_key_id != filters["api_key_id"]:
return False
if filters.get("endpoint") and event.endpoint != filters["endpoint"]:
return False
if filters.get("status_code") and event.status_code != filters["status_code"]:
return False
return True
class AnalyticsManager:
"""Manages analytics collection and reporting."""
def __init__(self, provider: AnalyticsProvider):
self.provider = provider
self.buffer: list[AnalyticsEvent] = []
self.buffer_size = 100
self.flush_interval = 60 # seconds
self._flush_task: asyncio.Task | None = None
async def track_event(self, event: AnalyticsEvent):
"""Track an analytics event."""
self.buffer.append(event)
if len(self.buffer) >= self.buffer_size:
await self.flush_buffer()
async def track_request(
self,
request: Request,
response: Response = None,
response_time_ms: float = None,
error: Exception = None
):
"""Track an API request."""
# Extract request info
user_id = getattr(request.state, "user_id", None)
api_key_id = getattr(request.state, "api_key_id", None)
session_id = getattr(request.state, "session_id", None)
# Create request event
request_event = AnalyticsEvent(
event_id=str(uuid.uuid4()),
event_type=EventType.API_REQUEST,
timestamp=datetime.utcnow(),
user_id=user_id,
api_key_id=api_key_id,
session_id=session_id,
request_id=getattr(request.state, "request_id", None),
endpoint=request.url.path,
method=request.method,
user_agent=request.headers.get("user-agent"),
ip_address=self._get_client_ip(request),
request_size_bytes=len(await request.body()) if request.method in ["POST", "PUT"] else 0
)
await self.track_event(request_event)
# Create response event if available
if response or error:
response_event = AnalyticsEvent(
event_id=str(uuid.uuid4()),
event_type=EventType.API_RESPONSE if not error else EventType.ERROR,
timestamp=datetime.utcnow(),
user_id=user_id,
api_key_id=api_key_id,
session_id=session_id,
request_id=getattr(request.state, "request_id", None),
endpoint=request.url.path,
method=request.method,
status_code=response.status_code if response else 500,
response_time_ms=response_time_ms,
response_size_bytes=len(response.body) if response else 0,
metadata={"error": str(error)} if error else None
)
await self.track_event(response_event)
async def track_user_action(
self,
action: str,
user_id: str,
metadata: dict[str, Any] = None
):
"""Track a user action."""
event = AnalyticsEvent(
event_id=str(uuid.uuid4()),
event_type=EventType.USER_ACTION,
timestamp=datetime.utcnow(),
user_id=user_id,
metadata={"action": action, **(metadata or {})}
)
await self.track_event(event)
async def get_dashboard_data(
self,
time_range: str = "24h"
) -> dict[str, Any]:
"""Get dashboard analytics data."""
# Parse time range
now = datetime.utcnow()
if time_range == "24h":
start_time = now - timedelta(hours=24)
elif time_range == "7d":
start_time = now - timedelta(days=7)
elif time_range == "30d":
start_time = now - timedelta(days=30)
else:
start_time = now - timedelta(hours=24)
# Get metrics
metrics = await self.provider.get_metrics(start_time, now)
# Get recent events
recent_events = await self.provider.get_events(
start_time,
now,
limit=50
)
# Calculate additional metrics
error_rate = (metrics.failed_requests / metrics.total_requests * 100) if metrics.total_requests > 0 else 0
return {
"time_range": time_range,
"metrics": {
"total_requests": metrics.total_requests,
"successful_requests": metrics.successful_requests,
"failed_requests": metrics.failed_requests,
"error_rate": round(error_rate, 2),
"unique_users": metrics.unique_users,
"unique_api_keys": metrics.unique_api_keys,
"average_response_time": round(metrics.average_response_time, 2),
"total_bandwidth_mb": round(metrics.total_bandwidth_bytes / (1024 * 1024), 2)
},
"top_endpoints": metrics.top_endpoints,
"recent_events": [event.to_dict() for event in recent_events[:10]]
}
async def get_usage_report(
self,
start_date: str,
end_date: str,
group_by: str = "day"
) -> dict[str, Any]:
"""Generate usage report."""
start_time = datetime.fromisoformat(start_date)
end_time = datetime.fromisoformat(end_date)
metrics = await self.provider.get_metrics(start_time, end_time)
# Group data by time period
if group_by == "hour":
# Get hourly breakdown
hourly_data = await self._get_hourly_breakdown(start_time, end_time)
else:
# Get daily breakdown
daily_data = await self._get_daily_breakdown(start_time, end_time)
hourly_data = None
return {
"period": {
"start": start_date,
"end": end_date,
"group_by": group_by
},
"summary": {
"total_requests": metrics.total_requests,
"unique_users": metrics.unique_users,
"average_response_time": metrics.average_response_time,
"success_rate": (metrics.successful_requests / metrics.total_requests * 100) if metrics.total_requests > 0 else 0
},
"breakdown": hourly_data or daily_data,
"top_endpoints": metrics.top_endpoints
}
async def flush_buffer(self):
"""Flush buffered events to provider."""
if not self.buffer:
return
events_to_flush = self.buffer.copy()
self.buffer.clear()
# Store events in parallel
tasks = [self.provider.store_event(event) for event in events_to_flush]
await asyncio.gather(*tasks, return_exceptions=True)
async def start_background_flush(self):
"""Start background flush task."""
if self._flush_task is None:
self._flush_task = asyncio.create_task(self._background_flush_loop())
async def stop_background_flush(self):
"""Stop background flush task."""
if self._flush_task:
self._flush_task.cancel()
try:
await self._flush_task
except asyncio.CancelledError:
pass
self._flush_task = None
async def _background_flush_loop(self):
"""Background loop for flushing events."""
while True:
try:
await asyncio.sleep(self.flush_interval)
await self.flush_buffer()
except asyncio.CancelledError:
break
except Exception as e:
logger.error(f"Analytics flush error: {e}")
def _get_client_ip(self, request: Request) -> str:
"""Get client IP address."""
# Check for forwarded headers
forwarded_for = request.headers.get("X-Forwarded-For")
if forwarded_for:
return forwarded_for.split(",")[0].strip()
real_ip = request.headers.get("X-Real-IP")
if real_ip:
return real_ip
return request.client.host if request.client else "unknown"
async def _get_hourly_breakdown(self, start_time: datetime, end_time: datetime) -> list[dict]:
"""Get hourly usage breakdown."""
# This would be implemented based on provider capabilities
return []
async def _get_daily_breakdown(self, start_time: datetime, end_time: datetime) -> list[dict]:
"""Get daily usage breakdown."""
# This would be implemented based on provider capabilities
return []
class AnalyticsMiddleware(BaseHTTPMiddleware):
"""Middleware to automatically track API requests."""
def __init__(self, app, analytics_manager: AnalyticsManager):
super().__init__(app)
self.analytics_manager = analytics_manager
async def dispatch(self, request: Request, call_next):
"""Track request and response."""
# Generate request ID
request_id = str(uuid.uuid4())
request.state.request_id = request_id
# Track start time
start_time = time.time()
# Process request
response = None
error = None
try:
response = await call_next(request)
except Exception as e:
error = e
# Create error response
from fastapi import HTTPException
if isinstance(e, HTTPException):
response = Response(
content=str(e.detail),
status_code=e.status_code
)
else:
response = Response(
content="Internal Server Error",
status_code=500
)
# Calculate response time
response_time_ms = (time.time() - start_time) * 1000
# Track the request
await self.analytics_manager.track_request(
request=request,
response=response,
response_time_ms=response_time_ms,
error=error
)
return response
# Global analytics manager
_analytics_manager: AnalyticsManager | None = None
async def get_analytics_manager() -> AnalyticsManager:
"""Get or create the global analytics manager."""
global _analytics_manager
if not _analytics_manager:
from src.settings import get_settings
settings = get_settings()
# Create provider
if settings.REDIS_URL:
provider = RedisAnalyticsProvider(settings.REDIS_URL)
else:
# Fallback to in-memory provider for development
provider = MemoryAnalyticsProvider()
_analytics_manager = AnalyticsManager(provider)
await _analytics_manager.start_background_flush()
return _analytics_manager
# Memory provider for development
class MemoryAnalyticsProvider(AnalyticsProvider):
"""In-memory analytics provider for development."""
def __init__(self):
self.events: list[AnalyticsEvent] = []
self.max_events = 10000
async def store_event(self, event: AnalyticsEvent) -> bool:
"""Store event in memory."""
self.events.append(event)
# Limit size
if len(self.events) > self.max_events:
self.events = self.events[-self.max_events:]
return True
async def get_metrics(
self,
start_time: datetime,
end_time: datetime,
filters: dict[str, Any] = None
) -> UsageMetrics:
"""Get metrics from memory."""
events = [
e for e in self.events
if start_time <= e.timestamp <= end_time
and self._matches_filters(e, filters)
]
metrics = UsageMetrics()
metrics.total_requests = len(events)
metrics.successful_requests = len([e for e in events if (e.status_code or 0) < 400])
metrics.failed_requests = metrics.total_requests - metrics.successful_requests
metrics.unique_users = len(set(e.user_id for e in events if e.user_id))
metrics.unique_api_keys = len(set(e.api_key_id for e in events if e.api_key_id))
# Calculate average response time
response_times = [e.response_time_ms for e in events if e.response_time_ms]
if response_times:
metrics.average_response_time = sum(response_times) / len(response_times)
return metrics
async def get_events(
self,
start_time: datetime,
end_time: datetime,
filters: dict[str, Any] = None,
limit: int = 100
) -> list[AnalyticsEvent]:
"""Get events from memory."""
events = [
e for e in self.events
if start_time <= e.timestamp <= end_time
and self._matches_filters(e, filters)
]
return sorted(events, key=lambda x: x.timestamp, reverse=True)[:limit]
def _matches_filters(self, event: AnalyticsEvent, filters: dict[str, Any]) -> bool:
"""Check if event matches filters."""
if not filters:
return True
if filters.get("user_id") and event.user_id != filters["user_id"]:
return False
if filters.get("endpoint") and event.endpoint != filters["endpoint"]:
return False
return True
|