Skip to content

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

4.6 KB
Raw Blame
# Copyright (c) 2026 Beijing Volcano Engine Technology Co., Ltd.
# SPDX-License-Identifier: AGPL-3.0
"""Observer endpoints for OpenViking HTTP Server.

Provides observability API for monitoring component status.
Mirrors SDK's client.observer API:
- /api/v1/observer/queue - Queue status
- /api/v1/observer/vikingdb - VikingDB status
- /api/v1/observer/models - Models status (VLM, Embedding, Rerank)
- /api/v1/observer/system - System overall status
"""

from typing import Literal

from fastapi import APIRouter, Depends, Query

from openviking.server.auth import get_request_context
from openviking.server.dependencies import get_service
from openviking.server.identity import RequestContext
from openviking.server.models import Response
from openviking.service.debug_service import ComponentStatus, SystemStatus

router = APIRouter(prefix="/api/v1/observer", tags=["observer"])


def _component_to_dict(component: ComponentStatus) -> dict:
    """Convert ComponentStatus to dict."""
    return {
        "name": component.name,
        "is_healthy": component.is_healthy,
        "has_errors": component.has_errors,
        "status": component.status,
    }


def _system_to_dict(status: SystemStatus) -> dict:
    """Convert SystemStatus to dict."""
    return {
        "is_healthy": status.is_healthy,
        "errors": status.errors,
        "components": {
            name: _component_to_dict(component) for name, component in status.components.items()
        },
    }


@router.get("/queue")
async def observer_queue(
    _ctx: RequestContext = Depends(get_request_context),
    format: Literal["table", "json"] = Query(
        "table", description="Observer status representation format"
    ),
):
    """Get queue system status."""
    service = get_service()
    component = await service.debug.observer.get_queue_status_async(format=format)
    return Response(status="ok", result=_component_to_dict(component))


@router.get("/vikingdb")
async def observer_vikingdb(
    ctx: RequestContext = Depends(get_request_context),
    format: Literal["table", "json"] = Query(
        "table", description="Observer status representation format"
    ),
):
    """Get VikingDB status."""
    service = get_service()
    component = await service.debug.observer.account_vikingdb(ctx, format=format)
    return Response(status="ok", result=_component_to_dict(component))


@router.get("/models")
async def observer_models(
    ctx: RequestContext = Depends(get_request_context),
    format: Literal["table", "json"] = Query(
        "table", description="Observer status representation format"
    ),
):
    """Get models status (VLM, Embedding, Rerank)."""
    service = get_service()
    component = await service.debug.observer.account_models(ctx, format=format)
    return Response(status="ok", result=_component_to_dict(component))


@router.get("/lock")
async def observer_lock(
    _ctx: RequestContext = Depends(get_request_context),
    format: Literal["table", "json"] = Query(
        "table", description="Observer status representation format"
    ),
):
    """Get lock system status."""
    service = get_service()
    component = await service.debug.observer.get_lock_status_async(format=format)
    return Response(status="ok", result=_component_to_dict(component))


@router.get("/retrieval")
async def observer_retrieval(
    _ctx: RequestContext = Depends(get_request_context),
    format: Literal["table", "json"] = Query(
        "table", description="Observer status representation format"
    ),
):
    """Get retrieval quality metrics."""
    service = get_service()
    component = service.debug.observer.get_retrieval_status(format=format)
    return Response(status="ok", result=_component_to_dict(component))


@router.get("/filesystem")
async def observer_filesystem(
    _ctx: RequestContext = Depends(get_request_context),
    format: Literal["table", "json"] = Query(
        "table", description="Observer status representation format"
    ),
):
    """Get filesystem operation metrics."""
    service = get_service()
    component = await service.debug.observer.get_filesystem_status_async(format=format)
    return Response(status="ok", result=_component_to_dict(component))


@router.get("/system")
async def observer_system(
    ctx: RequestContext = Depends(get_request_context),
    format: Literal["table", "json"] = Query(
        "table", description="Observer status representation format"
    ),
):
    """Get system overall status (includes all components)."""
    service = get_service()
    status = await service.debug.observer.account_system(ctx, format=format)
    return Response(status="ok", result=_system_to_dict(status))