Chapter DDeploy a RAG appPage 6 of 8

Deploy a RAG app

Instrument deploy versions and request traces

Page 6 advances one concrete production-shaped RAG deploy unit: explain the decision, run the code, inspect failure, measure evidence, and keep only what is ready to ship.

~15 minTesting and observability

Before you start

Why this matters

Predict which three fields must appear in one log or metric event to compare two versions of the production-shaped RAG deploy unit. What raw payload should never be logged at info level?

1Learn the idea

Read

Build focus

Instrumentation should explain behavior without collecting raw material unnecessarily. For this artifact, record enough to calculate or monitor smoke golden pass rate 100%, readiness true only when pins match, rollback under five minutes. Include version or configuration identifiers so two runs can be compared. A log line is useful only if it answers a debugging question.

Traces need request_id, pins, status, and latency. Metrics should slice error rates by index_version and model_id so a bad canary is obvious.

The artifact's user-facing goal is specific: serve /ask only when dependencies and version pins match a tested release unit. Its accepted input is request question, tenant auth context, and pinned model/index/config versions. Those statements are intentionally narrower than “build an AI system.” Narrow scope lets us inspect every input and expected result, and it prevents a toy result from being presented as a production claim. System shape for this chapter: a stateless FastAPI service validates requests, queries a separately managed vector index, calls an answer model through an adapter, and emits citations; liveness checks the process while readiness checks dependencies and exact model/index pins. Keep model calls behind adapters, keep authorization and validation in deterministic code, and carry stable IDs and versions through every response. That separation lets you decide whether a bad result came from input handling, retrieval, inference, validation, or deployment. This page's job is the testing and observability step: instrumentation should explain behavior without collecting raw material unnecessarily. Setup baseline for the chapter (run once per machine, not secrets in git):

python -m venv .venv && source .venv/bin/activate
pip install fastapi uvicorn pydantic httpx
export MODEL_ID=answer-v3 INDEX_VERSION=mini-v1

If hardware or a hosted provider differs, preserve the interface and expected behavior. Do not present provider syntax as universal—when a vendor adapter is unavoidable, keep it behind a thin boundary and test with a fake first. The deliverable is not “it ran once”; it is a reproducible artifact another developer can inspect, including expected output and one deliberate failure related to ready=true while index or model pin is incompatible. Operationally, write down the owner of this stage, the command you ran, the observed output, and the next page's dependency on that output. If you cannot point to a file, fixture, metric, or config key, the stage is not done. Prefer small, reviewable increments: one contract, one path, one metric, one failure, one gate. When tradeoffs appear—latency versus quality, hit rate versus false hits, local privacy versus cloud quality—record both numbers instead of moving the threshold until the report looks green. The chapter ships only when evidence for smoke golden pass rate 100%, readiness true only when pins match, rollback under five minutes and a rehearsed recovery path exist beside containerized FastAPI RAG service with /healthz, /ready, and canary switch.

Read

Run the example

Save this as lesson.py and run python3 lesson.py. Prefer the standard library or the pinned packages from the setup block so the example stays reproducible.

trace={"request_id":"r1","model_id":"answer-v3","index_version":"mini-v1","status":"ok","ms":210}
print(trace)

Expected output: trace with request_id and pins. Exact floating-point formatting may vary slightly, but the asserted behavior must not. Read the output as evidence about this stage, not merely proof that the interpreter started.

Read

Debug the stage

Compare two events from different versions on the same fixture. Divergent IDs or statuses need an eval note before traffic moves. At the testing and observability stage, save the smallest failing fixture beside the expected result. Change one cause at a time and rerun the exact command printed above; that makes the repair reviewable and keeps this chapter's progressive artifact reproducible.

Read

Evaluate before continuing

Dashboards or reports should slice by version pins. Alerts should fire on safety failures immediately. For this testing and observability page, preserve the fixture and result as evidence for the next page. Label observations separately from conclusions: a passing assertion establishes the behavior it names, while broader usefulness requires the chapter's full evaluation set and stated operating limits. Primary metrics for the chapter remain smoke golden pass rate 100%, readiness true only when pins match, rollback under five minutes.

Checking tutor…

Continue learning · glossary & guides
  • [ ] Can an event distinguish configuration, failure class, and duration?
  • [ ] Did I avoid logging secrets or unnecessary raw input?
  • [ ] Can two runs be compared with the recorded fields?
  • [ ] Would these events diagnose ready=true while index or model pin is incompatible?

How-to: deploy RAG checklist · Cheatsheet: production RAG ship · Snippet: RAG health route

Previous · Next