mirror of
https://github.com/onestardao/WFGY.git
synced 2026-04-28 11:40:07 +00:00
5.5 KiB
5.5 KiB
Live monitoring & alerting — RAG services
Goal: list of recommended metrics, alert rules and dashboard panels to keep RAG pipelines observable and actionable.
Core metrics to collect (recommended names)
Service-level
rag_e2e_latency_seconds(histogram) — E2E latency (request in → answer out)rag_error_count_total— errors per endpointrag_request_count_total— total requests
Retrieval-level
retriever_qps_totalretriever_retrieved_docs_count(per request)retriever_empty_result_count_total— unexpected empty sets
Vectorstore
vectorstore_index_load_time_secondsvectorstore_memory_bytesvectorstore_indexed_docs_total
Accuracy/provenance
rag_citation_hit_rate(CHR gauge over sliding window)rag_precision_shipped(periodic batch scorer push)rag_under_refusal_count_total
Infrastructure
llm_api_rate_limited_totalllm_api_error_totalqueue_backlog_count(if using background queues)
Suggested PromQL alerts (examples)
Tune thresholds to your workload.
A) Latency breach (interactive)
alert: RAGHighP95Latency
expr: histogram_quantile(0.95, sum(rate(rag_e2e_latency_seconds_bucket[5m])) by (le,instance)) > 2
for: 5m
labels:
severity: page
annotations:
summary: "RAG p95 > 2s ({{ $labels.instance }})"
B) Error spike
alert: RAGErrorSpike
expr: increase(rag_error_count_total[5m]) > 50
for: 2m
labels: { severity: page }
C) Retriever empty results
alert: RetrieverEmptyResults
expr: increase(retriever_empty_result_count_total[5m]) > 1
for: 5m
labels: { severity: ticket }
D) CHR drop
alert: CHRDrop
expr: rag_citation_hit_rate < 0.6
for: 10m
labels: { severity: ticket }
E) LLM auth failure
alert: LLMAuthFail
expr: increase(llm_api_error_total{code="401"}[5m]) > 0
for: 1m
Dashboard panels (recommended)
- E2E latency (p50/p95/p99) trend.
- Requests per second and error rate.
- Retriever QPS, avg retrieved docs, empty results.
- CHR & Precision (batch scorer push).
- Vectorstore memory & disk IO.
- LLM provider error & rate-limit metrics.
Incident play (fast actions)
- If CHR drop → run diagnostic retrieval for 10 golden queries (retrieved ids + cosine scores).
- If retriever empty → check vectorstore health and index partitions. Restart index shard if needed.
- If E2E latency spike with LLM errors → throttle traffic, put a hard rate limit and rollback deploy if needed.
- If LLM auth failure → rotate key & redeploy secrets.
How to integrate scoring metrics
- Periodic scorer job should push
rag_citation_hit_rateandrag_precision_shippedas a short-timeseries gauge (per 5–15m window). - Use batching: run
score_eval.py(seeProblemMap/eval/README.md) nightly and push summary metrics via a small exporter.
Troubleshooting queries (prometheus examples)
-
Check p95 per instance:
histogram_quantile(0.95, sum(rate(rag_e2e_latency_seconds_bucket[5m])) by (le,instance)) -
CHR trend:
avg_over_time(rag_citation_hit_rate[30m])
Links
- Deployment checklist → deployment_checklist.md
- Debug playbook → debug_playbook.md
- Eval & scoring → ../eval/README.md
🔗 Quick-Start Downloads (60 sec)
| Tool | Link | 3-Step Setup |
|---|---|---|
| WFGY 1.0 PDF | Engine Paper | 1️⃣ Download · 2️⃣ Upload to your LLM · 3️⃣ Ask “Answer using WFGY + <your question>” |
| TXT OS (plain-text OS) | TXTOS.txt | 1️⃣ Download · 2️⃣ Paste into any LLM chat · 3️⃣ Type “hello world” — OS boots instantly |
Explore More
| Layer | Page | What it’s for |
|---|---|---|
| ⭐ Proof | WFGY Recognition Map | External citations, integrations, and ecosystem proof |
| ⚙️ Engine | WFGY 1.0 | Original PDF tension engine and early logic sketch (legacy reference) |
| ⚙️ Engine | WFGY 2.0 | Production tension kernel for RAG and agent systems |
| ⚙️ Engine | WFGY 3.0 | TXT based Singularity tension engine (131 S class set) |
| 🗺️ Map | Problem Map 1.0 | Flagship 16 problem RAG failure taxonomy and fix map |
| 🗺️ Map | Problem Map 2.0 | Global Debug Card for RAG and agent pipeline diagnosis |
| 🗺️ Map | Problem Map 3.0 | Global AI troubleshooting atlas and failure pattern map |
| 🧰 App | TXT OS | .txt semantic OS with fast bootstrap |
| 🧰 App | Blah Blah Blah | Abstract and paradox Q&A built on TXT OS |
| 🧰 App | Blur Blur Blur | Text to image generation with semantic control |
| 🏡 Onboarding | Starter Village | Guided entry point for new users |
If this repository helped, starring it improves discovery so more builders can find the docs and tools.