ragflow/api/db/services
0xsatoshi99 697f8138b6 feat: add trace logging for agent completions API (Issue #10081)
Implement comprehensive trace logging system for agent execution that
returns step-by-step execution traces in API responses.

New modules:
- agent/trace/trace_models.py: Data models for trace events, sessions,
  LLM calls, retrievals, and tool calls
- agent/trace/trace_collector.py: Real-time trace event collection with
  subscriber pattern for streaming
- agent/trace/trace_formatter.py: Multiple formatters (streaming, compact,
  detailed) for different output needs
- api/db/services/trace_service.py: Service layer for trace persistence,
  retrieval, and analysis
- api/apps/trace_app.py: REST API endpoints for trace management

Features:
- Real-time trace streaming via SSE
- Multiple trace verbosity levels (minimal, standard, detailed, debug)
- Component execution timing and bottleneck detection
- LLM call tracking with token counts
- Retrieval operation logging with chunk details
- Tool call tracing with arguments and results
- Trace session persistence in Redis
- Analysis and recommendations based on trace data

API Endpoints:
- GET /traces - List trace sessions
- GET /traces/<task_id> - Get trace session
- GET /traces/<task_id>/events - Get filtered events
- GET /traces/<task_id>/summary - Get trace summary
- GET /traces/<task_id>/analysis - Analyze trace
- GET /traces/<task_id>/stream - Stream trace events
- DELETE /traces/<task_id> - Delete trace
- POST /traces/cleanup - Cleanup old traces
- POST /agents/<agent_id>/completions/trace - Completion with trace

Closes #10081
2025-12-03 18:08:14 +01:00
..
__init__.py Refactor: fix typos (#10200) 2025-09-25 12:05:43 +08:00
api_service.py Add time utils (#10849) 2025-10-28 19:09:14 +08:00
canvas_service.py Feat: add or logic operations for meta data filters. (#11404) 2025-11-20 14:31:12 +08:00
common_service.py Fix: add auto_parse to kb detail. (#11153) 2025-11-11 12:22:43 +08:00
connector_service.py feat: improve metadata handling in connector service (#11421) 2025-11-26 19:55:48 +08:00
conversation_service.py Move some constants to common (#11004) 2025-11-05 08:01:39 +08:00
dialog_service.py Feat:support tts in agent (#11675) 2025-12-03 12:03:59 +08:00
document_service.py Refa: make RAGFlow more asynchronous 2 (#11689) 2025-12-03 14:19:53 +08:00
evaluation_service.py Feat: RAG evaluation (#11674) 2025-12-03 17:00:58 +08:00
file2document_service.py Move some constants to common (#11004) 2025-11-05 08:01:39 +08:00
file_service.py Refa: make RAGFlow more asynchronous (#11601) 2025-12-01 14:24:06 +08:00
knowledgebase_service.py Feat: Alter flask to Quart for async API serving. (#11275) 2025-11-18 17:05:16 +08:00
langfuse_service.py Add time utils (#10849) 2025-10-28 19:09:14 +08:00
llm_service.py Fix: incorrect async chat streamly output (#11679) 2025-12-03 11:15:45 +08:00
mcp_server_service.py Fix typos: retrievaler -> retriever (#10372) 2025-10-10 09:17:36 +08:00
pipeline_operation_log_service.py Feat: add data source to pipleline logs . (#11075) 2025-11-07 11:43:59 +08:00
search_service.py Move some constants to common (#11004) 2025-11-05 08:01:39 +08:00
task_service.py Move api.settings to common.settings (#11036) 2025-11-06 09:36:38 +08:00
tenant_llm_service.py Move api.settings to common.settings (#11036) 2025-11-06 09:36:38 +08:00
trace_service.py feat: add trace logging for agent completions API (Issue #10081) 2025-12-03 18:08:14 +01:00
user_canvas_version.py Fix typos: retrievaler -> retriever (#10372) 2025-10-10 09:17:36 +08:00
user_service.py Move api.settings to common.settings (#11036) 2025-11-06 09:36:38 +08:00