File size: 12,422 Bytes
2d521fd | 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 | """
Usage Tracker for ARF API – quotas, tiers, and audit logging.
Non‑invasive, configurable, thread‑safe, and background‑task ready.
"""
import os
import json
import sqlite3
import threading
import time
from contextlib import contextmanager
from datetime import datetime, timedelta
from typing import Dict, Any, Optional, List
from enum import Enum
from dataclasses import dataclass
from fastapi import BackgroundTasks
# Optional Redis support
try:
import redis
REDIS_AVAILABLE = True
except ImportError:
REDIS_AVAILABLE = False
redis = None
class Tier(str, Enum):
FREE = "free"
PRO = "pro"
PREMIUM = "premium"
ENTERPRISE = "enterprise"
@property
def monthly_evaluation_limit(self) -> Optional[int]:
limits = {
Tier.FREE: 1000,
Tier.PRO: 10_000,
Tier.PREMIUM: 50_000,
Tier.ENTERPRISE: None, # unlimited
}
return limits[self]
@property
def audit_log_retention_days(self) -> int:
retention = {
Tier.FREE: 7,
Tier.PRO: 30,
Tier.PREMIUM: 90,
Tier.ENTERPRISE: 365,
}
return retention[self]
@dataclass
class UsageRecord:
"""Single evaluation usage record."""
api_key: str
tier: Tier
timestamp: float
endpoint: str
request_body: Optional[Dict[str, Any]] = None
response: Optional[Dict[str, Any]] = None
error: Optional[str] = None
processing_ms: Optional[float] = None
class UsageTracker:
"""
Thread‑safe usage tracker with SQLite storage and optional Redis for counters.
"""
def __init__(self, db_path: str = "arf_usage.db", redis_url: Optional[str] = None):
self.db_path = db_path
self._local = threading.local()
self._init_db()
self._redis_client = None
if redis_url and REDIS_AVAILABLE:
self._redis_client = redis.from_url(redis_url)
elif redis_url:
raise ImportError("Redis client not installed. Run: pip install redis")
@contextmanager
def _get_conn(self):
"""Get a thread‑local SQLite connection."""
if not hasattr(self._local, "conn"):
self._local.conn = sqlite3.connect(self.db_path, check_same_thread=False)
self._local.conn.row_factory = sqlite3.Row
yield self._local.conn
def _init_db(self):
with self._get_conn() as conn:
conn.execute("""
CREATE TABLE IF NOT EXISTS api_keys (
key TEXT PRIMARY KEY,
tier TEXT NOT NULL,
created_at REAL NOT NULL,
last_used_at REAL,
is_active INTEGER DEFAULT 1
)
""")
conn.execute("""
CREATE TABLE IF NOT EXISTS usage_log (
id INTEGER PRIMARY KEY AUTOINCREMENT,
api_key TEXT NOT NULL,
tier TEXT NOT NULL,
timestamp REAL NOT NULL,
endpoint TEXT NOT NULL,
request_body TEXT,
response TEXT,
error TEXT,
processing_ms REAL
)
""")
conn.execute("""
CREATE INDEX IF NOT EXISTS idx_api_key_timestamp
ON usage_log (api_key, timestamp)
""")
conn.execute("""
CREATE TABLE IF NOT EXISTS monthly_counts (
api_key TEXT NOT NULL,
year_month TEXT NOT NULL,
count INTEGER DEFAULT 0,
PRIMARY KEY (api_key, year_month)
)
""")
conn.commit()
def _get_month_key(self) -> str:
return datetime.now().strftime("%Y-%m")
def get_or_create_api_key(self, key: str, tier: Tier = Tier.FREE) -> bool:
"""Register a new API key. Returns True if key exists or was created."""
with self._get_conn() as conn:
row = conn.execute("SELECT key FROM api_keys WHERE key = ?", (key,)).fetchone()
if row:
return True
conn.execute(
"INSERT INTO api_keys (key, tier, created_at, is_active) VALUES (?, ?, ?, ?)",
(key, tier.value, time.time(), 1)
)
conn.commit()
return True
def get_tier(self, api_key: str) -> Optional[Tier]:
"""Return the tier for a given API key, or None if key invalid/inactive."""
with self._get_conn() as conn:
row = conn.execute(
"SELECT tier FROM api_keys WHERE key = ? AND is_active = 1",
(api_key,)
).fetchone()
if not row:
return None
return Tier(row["tier"])
def update_api_key_tier(self, api_key: str, new_tier: Tier) -> bool:
"""Update the tier of an existing API key. Returns True if successful."""
with self._get_conn() as conn:
row = conn.execute("SELECT key FROM api_keys WHERE key = ?", (api_key,)).fetchone()
if not row:
return False
conn.execute("UPDATE api_keys SET tier = ? WHERE key = ?", (new_tier.value, api_key))
conn.commit()
return True
def get_remaining_quota(self, api_key: str, tier: Tier) -> Optional[int]:
"""Return remaining evaluations for the month, or None if unlimited."""
limit = tier.monthly_evaluation_limit
if limit is None:
return None
month = self._get_month_key()
if self._redis_client:
redis_key = f"arf:quota:{api_key}:{month}"
count = int(self._redis_client.get(redis_key) or 0)
return max(0, limit - count)
with self._get_conn() as conn:
row = conn.execute(
"SELECT count FROM monthly_counts WHERE api_key = ? AND year_month = ?",
(api_key, month)
).fetchone()
count = row["count"] if row else 0
return max(0, limit - count)
def _increment_quota(self, api_key: str, tier: Tier) -> None:
"""Increment the monthly counter (internal, synchronous)."""
limit = tier.monthly_evaluation_limit
if limit is None:
return
month = self._get_month_key()
if self._redis_client:
redis_key = f"arf:quota:{api_key}:{month}"
self._redis_client.incr(redis_key)
self._redis_client.expire(redis_key, timedelta(days=31))
else:
with self._get_conn() as conn:
conn.execute(
"""INSERT INTO monthly_counts (api_key, year_month, count)
VALUES (?, ?, 1)
ON CONFLICT(api_key, year_month) DO UPDATE SET count = count + 1""",
(api_key, month)
)
conn.commit()
def _insert_audit_log(self, record: UsageRecord) -> None:
"""Insert a single audit log (internal, synchronous)."""
with self._get_conn() as conn:
conn.execute(
"""INSERT INTO usage_log
(api_key, tier, timestamp, endpoint, request_body, response, error, processing_ms)
VALUES (?, ?, ?, ?, ?, ?, ?, ?)""",
(
record.api_key,
record.tier.value,
record.timestamp,
record.endpoint,
json.dumps(record.request_body) if record.request_body else None,
json.dumps(record.response) if record.response else None,
record.error,
record.processing_ms,
)
)
conn.commit()
def increment_usage_sync(self, record: UsageRecord) -> bool:
"""
Synchronously record usage and increment counter.
Returns True if within quota (i.e., counter was incremented), False if quota exceeded.
"""
tier = record.tier
limit = tier.monthly_evaluation_limit
if limit is not None:
remaining = self.get_remaining_quota(record.api_key, tier)
if remaining <= 0:
return False
self._increment_quota(record.api_key, tier)
self._insert_audit_log(record)
return True
async def increment_usage_async(self, record: UsageRecord, background_tasks: BackgroundTasks) -> bool:
"""
Asynchronously record usage using FastAPI BackgroundTasks.
Returns True if quota allows (i.e., will be recorded), False if quota exceeded.
"""
tier = record.tier
limit = tier.monthly_evaluation_limit
if limit is not None:
remaining = self.get_remaining_quota(record.api_key, tier)
if remaining <= 0:
return False
# Schedule the actual write in the background
background_tasks.add_task(self._increment_quota, record.api_key, tier)
background_tasks.add_task(self._insert_audit_log, record)
return True
def get_audit_logs(
self,
api_key: str,
start_date: Optional[datetime] = None,
end_date: Optional[datetime] = None,
limit: int = 100,
) -> List[Dict[str, Any]]:
"""Retrieve audit logs for a given API key."""
query = "SELECT * FROM usage_log WHERE api_key = ?"
params = [api_key]
if start_date:
query += " AND timestamp >= ?"
params.append(start_date.timestamp())
if end_date:
query += " AND timestamp <= ?"
params.append(end_date.timestamp())
query += " ORDER BY timestamp DESC LIMIT ?"
params.append(limit)
with self._get_conn() as conn:
rows = conn.execute(query, params).fetchall()
return [dict(row) for row in rows]
def clean_old_logs(self):
"""Delete logs older than retention period for each tier."""
with self._get_conn() as conn:
for tier in Tier:
retention_days = tier.audit_log_retention_days
if retention_days is None:
continue
cutoff = time.time() - retention_days * 86400
conn.execute(
"DELETE FROM usage_log WHERE tier = ? AND timestamp < ?",
(tier.value, cutoff)
)
conn.commit()
# Global instance
tracker: Optional[UsageTracker] = None
def init_tracker(db_path: str = "arf_usage.db", redis_url: Optional[str] = None):
global tracker
tracker = UsageTracker(db_path, redis_url)
def update_key_tier(api_key: str, new_tier: Tier) -> bool:
"""Globally accessible helper to update API key tier."""
if tracker is None:
return False
return tracker.update_api_key_tier(api_key, new_tier)
# FastAPI dependency to enforce quota
from fastapi import HTTPException, Request
async def enforce_quota(request: Request, api_key: str = None):
"""
Dependency that checks API key and remaining quota.
Use in your endpoint: `quota = Depends(enforce_quota)`
If usage tracking is disabled, returns a default dict (no enforcement).
"""
# If tracker not initialised, allow all requests (fallback)
if tracker is None:
return {"api_key": api_key or "disabled", "tier": Tier.FREE, "remaining": None}
# Extract API key from header or query
if api_key is None:
auth_header = request.headers.get("Authorization")
if auth_header and auth_header.startswith("Bearer "):
api_key = auth_header[7:]
else:
api_key = request.query_params.get("api_key")
if not api_key:
raise HTTPException(status_code=401, detail="Missing API key")
tier = tracker.get_tier(api_key)
if tier is None:
raise HTTPException(status_code=403, detail="Invalid or inactive API key")
remaining = tracker.get_remaining_quota(api_key, tier)
if remaining is not None and remaining <= 0:
raise HTTPException(status_code=429, detail="Monthly evaluation quota exceeded")
# Store in request state for later logging
request.state.api_key = api_key
request.state.tier = tier
return {"api_key": api_key, "tier": tier, "remaining": remaining}
|