Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

fix(observability): persist final HTTP retrieval result counts (#5294)

Lusen Donge49d6c4852c7
diff --git a/openviking/metrics/datasources/http.py b/openviking/metrics/datasources/http.py
index 8b3fcccbc..1cbcccaf5 100644
--- a/openviking/metrics/datasources/http.py
+++ b/openviking/metrics/datasources/http.py
@@ -37,6 +37,7 @@ class HttpRequestLifecycleDataSource(EventMetricDataSource):
request_id: str | None = None,
user_id: str | None = None,
url_path: str | None = None,
+ result_count: int | None = None,
error_code: str | None = None,
error_message: str | None = None,
error_details: dict[str, Any] | None = None,
@@ -60,6 +61,8 @@ class HttpRequestLifecycleDataSource(EventMetricDataSource):
payload["user_id"] = str(user_id)
if url_path is not None:
payload["url_path"] = str(url_path)
+ if result_count is not None:
+ payload["result_count"] = max(int(result_count), 0)
if error_code is not None:
payload["error_code"] = str(error_code)
if error_message is not None:
diff --git a/openviking/observability/http_observability_middleware.py b/openviking/observability/http_observability_middleware.py
index d2ca05659..2176d35ee 100644
--- a/openviking/observability/http_observability_middleware.py
+++ b/openviking/observability/http_observability_middleware.py
@@ -693,6 +693,7 @@ def apply_http_metrics_finalize(
request_id=root_attrs.request_id,
user_id=root_attrs.user_id,
url_path=root_attrs.url_path,
+ result_count=getattr(request.state, "retrieval_result_count", None),
error_code=captured_error.code if include_error and captured_error else None,
error_message=captured_error.message if include_error and captured_error else None,
error_details=captured_error.details if include_error and captured_error else None,
diff --git a/openviking/observability/usage_audit/README.md b/openviking/observability/usage_audit/README.md
index 68294dca8..1e3f754f1 100644
--- a/openviking/observability/usage_audit/README.md
+++ b/openviking/observability/usage_audit/README.md
@@ -120,6 +120,15 @@ store backend,而不是让多个实例各写各的本地 SQLite。
`2xx` 和 `3xx` 记为 `success`,`4xx/5xx` 记为 `error`。Dashboard 今日检索只展示成功请求数。
+`usage_retrieval_hourly.result_count` 累加成功 HTTP 响应中的最终结果条数:列表模式使用
+`total`,`search` 的 context 模式使用 `entries` 长度。失败请求只增加请求数。
+该值随 `http.request` 写入,不累加内部 `retrieval.completed` 的结果数;一次 HTTP 请求
+可能触发多个内部检索并去重、截断,因此不能直接与进程启动以来的 retrieval observer
+计数对齐。现有统计范围仍为上表两个端点,不包含 MCP 或已弃用的 `/recall`。
+
+结果总数不是零结果请求数,仅凭 `request_count` 和 `result_count` 无法还原零结果率。
+修复前已有桶中的结果数仍为历史零值,不会回填。
+
### 上下文提交热力图
来自成功的公开写请求:
diff --git a/openviking/observability/usage_audit/projection.py b/openviking/observability/usage_audit/projection.py
index c0c719fba..45cbb10da 100644
--- a/openviking/observability/usage_audit/projection.py
+++ b/openviking/observability/usage_audit/projection.py
@@ -260,7 +260,8 @@ def _project_http_request(
status,
)
prev_count, prev_results = retrieval_rows[retrieval_key]
- retrieval_rows[retrieval_key] = (prev_count + 1, prev_results)
+ result_count = max(safe_int(payload.get("result_count")), 0) if status == "success" else 0
+ retrieval_rows[retrieval_key] = (prev_count + 1, prev_results + result_count)
context_operation = context_write_operation_for_http(method, route, status_code)
if context_operation:
diff --git a/openviking/server/routers/search.py b/openviking/server/routers/search.py
index be8783846..660740a7d 100644
--- a/openviking/server/routers/search.py
+++ b/openviking/server/routers/search.py
@@ -6,7 +6,7 @@ import asyncio
import math
from typing import Any, Dict, List, Literal, Optional, Sequence, Union
-from fastapi import APIRouter, Depends
+from fastapi import APIRouter, Depends, Request
from fastapi import Response as FastAPIResponse
from pydantic import BaseModel, ConfigDict, Field, model_validator
@@ -347,6 +347,7 @@ class GlobRequest(BaseModel):
@router.post("/find")
async def find(
request: FindRequest,
+ http_request: Request,
_ctx: RequestContext = Depends(get_request_context),
):
"""Semantic search without session context."""
@@ -382,6 +383,7 @@ async def find(
if request.read_content:
result = await _inline_read_content(result, service=service, ctx=_ctx)
result = _sanitize_floats(result)
+ http_request.state.retrieval_result_count = result.get("total", 0)
return Response(
status="ok",
result=result,
@@ -406,6 +408,7 @@ async def _search_context(
service: Any,
ctx: RequestContext,
request: SearchRequest,
+ http_request: Request,
effective_filter: Optional[Dict[str, Any]],
actual_limit: int,
):
@@ -438,6 +441,7 @@ async def _search_context(
ignored = _context_ignored_fields(request)
if ignored:
result.stats["ignored"] = ignored
+ http_request.state.retrieval_result_count = len(result.entries)
return Response(
status="ok",
result=_sanitize_floats(result.to_dict()),
@@ -448,6 +452,7 @@ async def _search_context(
@router.post("/search")
async def search(
request: SearchRequest,
+ http_request: Request,
_ctx: RequestContext = Depends(get_request_context),
):
"""Semantic search with optional session context."""
@@ -466,6 +471,7 @@ async def search(
service=service,
ctx=_ctx,
request=request,
+ http_request=http_request,
effective_filter=effective_filter,
actual_limit=actual_limit,
)
@@ -501,6 +507,7 @@ async def search(
if request.read_content:
result = await _inline_read_content(result, service=service, ctx=_ctx)
result = _sanitize_floats(result)
+ http_request.state.retrieval_result_count = result.get("total", 0)
return Response(
status="ok",
result=result,
diff --git a/tests/observability/test_usage_audit_runtime.py b/tests/observability/test_usage_audit_runtime.py
index 451473d26..e6b24c250 100644
--- a/tests/observability/test_usage_audit_runtime.py
+++ b/tests/observability/test_usage_audit_runtime.py
@@ -3,16 +3,28 @@
from __future__ import annotations
+import asyncio
+import sqlite3
from types import SimpleNamespace
+import httpx
import pytest
+from fastapi import FastAPI, HTTPException
from openviking.observability.events import _GLOBAL_EVENT_BUS, try_publish_event
+from openviking.observability.http_observability_middleware import HTTPObservabilityMiddleware
from openviking.observability.usage_audit import (
init_usage_audit_from_server_config,
shutdown_usage_audit,
)
+from openviking.retrieve.context_assembler.models import AssembledEntry, AssembleResult
+from openviking.server.auth import get_request_context
from openviking.server.config import ObservabilityConfig, ServerConfig, UsageAuditConfig
+from openviking.server.identity import RequestContext, Role
+from openviking.server.request_id import RequestIdMiddleware
+from openviking.server.routers import search as search_router
+from openviking_cli.retrieve import ContextType, FindResult, MatchedContext
+from openviking_cli.session.user_id import UserIdentifier
@pytest.mark.asyncio
@@ -65,3 +77,96 @@ async def test_usage_audit_runtime_subscribes_to_shared_event_bus(tmp_path):
assert audit["items"][0]["error_code"] is None
assert audit["items"][0]["error_message"] is None
assert audit["items"][0]["error_details"] is None
+
+
+ "operation,mode", [("find", "list"), ("search", "list"), ("search", "context")]
+)
+async def test_search_http_results_persist_without_counting_internal_queries(
+ tmp_path, monkeypatch, operation, mode
+):
+ async def retrieve(query):
+ await asyncio.sleep(0)
+ # Internal candidates must not inflate the final HTTP result count.
+ try_publish_event("retrieval.completed", {"result_count": 99})
+ # A worker batch may finish before the corresponding HTTP request.
+ assert runtime is not None
+ await runtime.worker.flush()
+ if query == "error":
+ raise HTTPException(status_code=503, detail="retrieval unavailable")
+ return (
+ []
+ if query == "empty"
+ else [
+ MatchedContext(uri=f"viking://resources/{i}.md", context_type=ContextType.RESOURCE)
+ for i in range(3)
+ ]
+ )
+
+ async def find_or_search(query, **kwargs):
+ return FindResult(memories=[], resources=await retrieve(query), skills=[])
+
+ async def assemble(*, params, **kwargs):
+ hits = await retrieve(params.query)
+ return AssembleResult(
+ entries=[
+ AssembledEntry(uri=hit.uri, category="resources", score=0.8, detail="abstract")
+ for hit in hits
+ ]
+ )
+
+ service = SimpleNamespace(search=SimpleNamespace(find=find_or_search, search=find_or_search))
+ monkeypatch.setattr(search_router, "get_service", lambda: service)
+ monkeypatch.setattr(search_router, "assemble_context", assemble)
+ app = FastAPI()
+ app.include_router(search_router.router)
+ app.add_middleware(HTTPObservabilityMiddleware)
+ app.add_middleware(RequestIdMiddleware)
+ app.dependency_overrides[get_request_context] = lambda: RequestContext(
+ user=UserIdentifier.the_default_user(), role=Role(Role.ROOT)
+ )
+ db_path = tmp_path / "usage.sqlite3"
+ runtime = await init_usage_audit_from_server_config(
+ ServerConfig.model_validate(
+ {"observability": {"usage_audit": {"sqlite_path": str(db_path)}}}
+ ),
+ app=app,
+ service=service,
+ )
+ assert runtime is not None
+ try:
+ async with httpx.AsyncClient(
+ transport=httpx.ASGITransport(app=app), base_url="http://test"
+ ) as client:
+ responses = await asyncio.gather(
+ *[
+ client.post(
+ f"/api/v1/search/{operation}",
+ json={"query": query, **({"mode": mode} if operation == "search" else {})},
+ headers={"X-Request-ID": "shared-client-id"},
+ )
+ for query in ("full", "empty", "error")
+ ]
+ )
+ await runtime.worker.flush()
+ repeated = await client.post(
+ f"/api/v1/search/{operation}",
+ json={"query": "full", **({"mode": mode} if operation == "search" else {})},
+ headers={"X-Request-ID": "shared-client-id"},
+ )
+ assert repeated.status_code == 200
+ assert [response.status_code for response in responses] == [200, 200, 503]
+ result = responses[0].json()["result"]
+ assert (len(result["entries"]) if mode == "context" else result["total"]) == 3
+ await runtime.worker.flush()
+ finally:
+ await shutdown_usage_audit(app=app)
+
+ # Read the persisted public projection after shutdown, not just its event payload.
+ with sqlite3.connect(db_path) as connection:
+ rows = connection.execute(
+ "SELECT operation, status, SUM(request_count), SUM(result_count) "
+ "FROM usage_retrieval_hourly GROUP BY operation, status ORDER BY status"
+ ).fetchall()
+ assert rows == [(operation, "error", 1, 0), (operation, "success", 3, 6)]