File size: 16,344 Bytes
fa1140b 643959b fa1140b | 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 | """HTTP 请求/响应访问日志:脱敏 header/body + 耗时 + usage 提取。
中间件记录客户端 → 网关 的 headers/body,以及 网关 → 客户端 的 status/body、
elapsed_ms、从响应中解析的 token usage(若有)。敏感字段脱敏,body 截断。
"""
from __future__ import annotations
import json
import logging
import re
import time
import uuid
from typing import Any
from starlette.middleware.base import BaseHTTPMiddleware
from starlette.requests import Request
from starlette.responses import Response, StreamingResponse
logger = logging.getLogger(__name__)
# 敏感 header 名(小写)
_SENSITIVE_HEADERS = frozenset({
"authorization",
"cookie",
"set-cookie",
"x-api-key",
"x-auth-key",
"proxy-authorization",
"x-xsrf-token",
"x-csrf-token",
})
# body 里常见敏感字段
_SENSITIVE_BODY_KEYS = frozenset({
"password", "password_confirmation", "token", "access_token",
"refresh_token", "api_key", "authorization", "cookie", "secret",
"client_secret",
})
_DEFAULT_MAX_BODY = 4000
_MAX_HEADER_VAL = 200
_SSE_DATA_RE = re.compile(r"^data:\s*(.+)$", re.MULTILINE)
def _max_body(settings: Any | None) -> int:
if settings is None:
return _DEFAULT_MAX_BODY
return int(getattr(settings, "log_max_body_chars", None) or _DEFAULT_MAX_BODY)
def redact_headers(headers: Any) -> dict[str, str]:
"""复制 headers 并脱敏敏感值。"""
out: dict[str, str] = {}
try:
items = headers.items()
except Exception: # noqa: BLE001
return out
for k, v in items:
key = str(k)
val = str(v)
if key.lower() in _SENSITIVE_HEADERS:
out[key] = _mask(val)
else:
out[key] = val if len(val) <= _MAX_HEADER_VAL else val[: _MAX_HEADER_VAL - 1] + "…"
return out
def _mask(val: str) -> str:
if not val:
return ""
if val.lower().startswith("bearer ") and len(val) > 14:
return f"Bearer {val[7:11]}…{val[-4:]}"
if len(val) <= 8:
return "***"
return f"{val[:4]}…{val[-4:]}(len={len(val)})"
def redact_body_obj(obj: Any) -> Any:
"""递归脱敏 dict 中的敏感键;字符串过长截断。"""
if isinstance(obj, dict):
out: dict[str, Any] = {}
for k, v in obj.items():
if str(k).lower() in _SENSITIVE_BODY_KEYS:
out[k] = _mask(str(v)) if v is not None else v
else:
out[k] = redact_body_obj(v)
return out
if isinstance(obj, list):
if len(obj) > 20:
head = [redact_body_obj(x) for x in obj[:10]]
tail = [redact_body_obj(x) for x in obj[-5:]]
return head + [f"…({len(obj) - 15} more items)…"] + tail
return [redact_body_obj(x) for x in obj]
if isinstance(obj, str):
if obj.startswith("data:") and len(obj) > 80:
return obj[:40] + f"…(data_url len={len(obj)})"
if len(obj) > 500:
return obj[:500] + f"…(len={len(obj)})"
return obj
return obj
def format_body_for_log(
raw: bytes | str | None,
*,
content_type: str = "",
max_chars: int = _DEFAULT_MAX_BODY,
) -> str:
"""把 body 转成可打日志的短字符串(JSON 美化 + 脱敏 + 截断)。"""
if raw is None:
return ""
if isinstance(raw, bytes):
if not raw:
return ""
try:
text = raw.decode("utf-8")
except UnicodeDecodeError:
return f"<binary {len(raw)} bytes>"
else:
text = raw
ct = (content_type or "").lower()
# multipart(表单上传,如 /admin/accounts/upload 的账号文件):file part 里是完整
# 账号 JSON(含 privy token 等凭据),整段按原始文本记录会明文泄露 → 一律不记正文,
# 只记边界与大小(日志留痕用,敏感内容零落盘)。
if ct.startswith("multipart/"):
boundary = ""
if "boundary=" in ct:
boundary = ct.split("boundary=", 1)[1].split(";", 1)[0].strip().strip('"')
return (f"<multipart form-data{', boundary=' + boundary if boundary else ''} "
f"{(len(raw) if isinstance(raw, bytes) else len(text))} bytes; "
f"file contents not logged>")
if "json" in ct or text.lstrip().startswith(("{", "[")):
try:
obj = json.loads(text)
redacted = redact_body_obj(obj)
s = json.dumps(redacted, ensure_ascii=False, indent=2)
if len(s) > max_chars:
return s[:max_chars] + f"…(truncated, total_chars={len(s)})"
return s
except json.JSONDecodeError:
pass
# SSE:逐条 data 行尝试 JSON 脱敏后拼接(仍截断总长)
if "text/event-stream" in ct or text.lstrip().startswith("data:"):
parts: list[str] = []
for m in _SSE_DATA_RE.finditer(text):
payload = m.group(1).strip()
if payload == "[DONE]":
parts.append("data: [DONE]")
continue
try:
obj = json.loads(payload)
parts.append(
"data: " + json.dumps(redact_body_obj(obj), ensure_ascii=False)
)
except json.JSONDecodeError:
if len(payload) > 200:
parts.append(f"data: {payload[:200]}…(len={len(payload)})")
else:
parts.append(f"data: {payload}")
s = "\n".join(parts) if parts else text
if len(s) > max_chars:
return s[:max_chars] + f"…(truncated, total_chars={len(s)})"
return s
if len(text) > max_chars:
return text[:max_chars] + f"…(truncated, total_chars={len(text)})"
return text
def format_headers_for_log(headers: Any) -> str:
return json.dumps(redact_headers(headers), ensure_ascii=False)
def extract_usage_from_body(raw: bytes | str | None, *, content_type: str = "") -> dict[str, Any] | None:
"""从 OpenAI/Anthropic JSON 或 SSE 响应中尽量提取 usage 对象。"""
if raw is None:
return None
if isinstance(raw, bytes):
if not raw:
return None
try:
text = raw.decode("utf-8")
except UnicodeDecodeError:
return None
else:
text = raw
if not text.strip():
return None
def _from_obj(obj: Any) -> dict[str, Any] | None:
if not isinstance(obj, dict):
return None
usage = obj.get("usage")
if isinstance(usage, dict) and usage:
return usage
# Anthropic message 顶层即 usage
if any(k in obj for k in ("input_tokens", "output_tokens", "prompt_tokens")):
keys = (
"input_tokens", "output_tokens", "prompt_tokens", "completion_tokens",
"total_tokens", "thinking_tokens", "cache_creation_input_tokens",
"cache_read_input_tokens",
)
found = {k: obj[k] for k in keys if k in obj}
return found or None
return None
ct = (content_type or "").lower()
if "json" in ct or text.lstrip().startswith(("{", "[")):
try:
return _from_obj(json.loads(text))
except json.JSONDecodeError:
pass
# SSE:从后往前找带 usage 的 data 帧
last_usage: dict[str, Any] | None = None
for m in _SSE_DATA_RE.finditer(text):
payload = m.group(1).strip()
if payload == "[DONE]":
continue
try:
u = _from_obj(json.loads(payload))
if u:
last_usage = u
except json.JSONDecodeError:
continue
return last_usage
def _model_from_request_body(raw: bytes | None) -> str:
"""从请求 body JSON 里取 model 字段(用量按模型分组用;失败返回空串)。"""
if not raw:
return ""
try:
obj = json.loads(raw)
if isinstance(obj, dict):
return str(obj.get("model") or "")
except (json.JSONDecodeError, ValueError, UnicodeDecodeError):
pass
return ""
def _record_usage(usage: dict[str, Any] | None, path: str, model: str) -> None:
"""把提取到的 usage 写入用量存储(旁路,异常静默,绝不影响响应)。"""
if not usage:
return
try:
from app import usage_store
usage_store.record(usage, path=path, model=model)
except Exception: # noqa: BLE001
pass
def _settings_from_request(request: Request) -> Any | None:
return getattr(request.app.state, "settings", None)
class RequestResponseLogMiddleware(BaseHTTPMiddleware):
"""记录请求 header/body、响应 body、耗时、usage;跳过 ``/healthz``。"""
async def dispatch(self, request: Request, call_next: Any) -> Response:
if request.url.path in ("/healthz", "/favicon.ico", "/admin/logs"):
# /admin/logs 是日志页自引用:记录它会刷屏(每 5s 一条大 body)
return await call_next(request)
settings = _settings_from_request(request)
max_chars = _max_body(settings)
log_req_body = True if settings is None else bool(
getattr(settings, "log_request_body", True)
)
log_resp_body = True if settings is None else bool(
getattr(settings, "log_response_body", True)
)
req_id = request.headers.get("x-request-id") or uuid.uuid4().hex[:10]
request.state.req_id = req_id
t0 = time.perf_counter()
body_bytes = await request.body()
req_model = _model_from_request_body(body_bytes)
req_path = request.url.path
async def receive() -> dict[str, Any]:
return {"type": "http.request", "body": body_bytes, "more_body": False}
request = Request(request.scope, receive)
client = request.client.host if request.client else "?"
logger.info(
"[%s] >>> %s %s client=%s",
req_id, request.method, request.url.path, client,
)
logger.info(
"[%s] >>> request headers: %s",
req_id, format_headers_for_log(request.headers),
)
if log_req_body:
if body_bytes:
logger.info(
"[%s] >>> request body (%d bytes):\n%s",
req_id, len(body_bytes),
format_body_for_log(
body_bytes,
content_type=request.headers.get("content-type", ""),
max_chars=max_chars,
),
)
else:
logger.info("[%s] >>> request body: (empty)", req_id)
try:
response = await call_next(request)
except Exception:
logger.exception(
"[%s] !!! unhandled error elapsed_ms=%.1f",
req_id, (time.perf_counter() - t0) * 1000,
)
raise
media_type = response.media_type or response.headers.get("content-type", "") or ""
# 2026-08-08 实测:旧实现把 body_iterator 全读完再 Response(content=整包) 返回,
# SSE 流被中间件缓冲 → 客户端等上游全部结束后才一次性收到所有 chunk。
# 表现:cherry「等好一会才开始逐字」、思考 delta 突发成几十个空「已深度思考」泡。
# 修复:text/event-stream **边收边转**,日志在流结束后再打(不挡首字节)。
is_sse = "text/event-stream" in media_type
headers = dict(response.headers)
headers.pop("content-length", None)
headers["x-request-id"] = req_id
if is_sse:
headers.setdefault("Cache-Control", "no-cache")
headers.setdefault("X-Accel-Buffering", "no")
headers.setdefault("Connection", "keep-alive")
if is_sse:
body_iter = response.body_iterator
async def _stream_and_log():
chunks: list[bytes] = []
try:
async for chunk in body_iter:
data = chunk.encode("utf-8") if isinstance(chunk, str) else chunk
chunks.append(data)
yield data
finally:
aclose = getattr(body_iter, "aclose", None)
if callable(aclose):
try:
await aclose()
except Exception: # noqa: BLE001
pass
resp_body = b"".join(chunks)
elapsed_ms = (time.perf_counter() - t0) * 1000
usage = extract_usage_from_body(resp_body, content_type=media_type)
_record_usage(usage, req_path, req_model)
logger.info(
"[%s] <<< response status=%s elapsed_ms=%.1f body_bytes=%d usage=%s",
req_id,
response.status_code,
elapsed_ms,
len(resp_body),
json.dumps(usage, ensure_ascii=False) if usage else "null",
)
logger.info(
"[%s] <<< response headers: %s",
req_id, format_headers_for_log(headers),
)
if log_resp_body:
if resp_body:
logger.info(
"[%s] <<< response body (%d bytes):\n%s",
req_id, len(resp_body),
format_body_for_log(
resp_body, content_type=media_type,
max_chars=max_chars,
),
)
else:
logger.info("[%s] <<< response body: (empty)", req_id)
return StreamingResponse(
_stream_and_log(),
status_code=response.status_code,
headers=headers,
media_type=response.media_type,
background=response.background,
)
# 非流式:仍聚合 body 记 usage(JSON 响应体积小,缓冲无感)
resp_chunks: list[bytes] = []
body_iter = response.body_iterator
try:
async for chunk in body_iter:
if isinstance(chunk, str):
resp_chunks.append(chunk.encode("utf-8"))
else:
resp_chunks.append(chunk)
finally:
aclose = getattr(body_iter, "aclose", None)
if callable(aclose):
await aclose()
resp_body = b"".join(resp_chunks)
elapsed_ms = (time.perf_counter() - t0) * 1000
usage = extract_usage_from_body(resp_body, content_type=media_type)
_record_usage(usage, req_path, req_model)
logger.info(
"[%s] <<< response status=%s elapsed_ms=%.1f body_bytes=%d usage=%s",
req_id,
response.status_code,
elapsed_ms,
len(resp_body),
json.dumps(usage, ensure_ascii=False) if usage else "null",
)
logger.info(
"[%s] <<< response headers: %s",
req_id, format_headers_for_log(response.headers),
)
if log_resp_body:
if resp_body:
logger.info(
"[%s] <<< response body (%d bytes):\n%s",
req_id, len(resp_body),
format_body_for_log(
resp_body, content_type=media_type, max_chars=max_chars,
),
)
else:
logger.info("[%s] <<< response body: (empty)", req_id)
return Response(
content=resp_body,
status_code=response.status_code,
headers=headers,
media_type=response.media_type,
background=response.background,
)
def strip_auth_from_headers_dict(headers: dict[str, str]) -> dict[str, str]:
"""上游请求用:拷贝并脱敏。"""
return redact_headers(headers)
|