docs(diagrams): added C4 diagrams

2026-02-24 09:13:24 +03:00
parent c5ea0b7d5d
commit 6700e55e50
3 changed files with 96 additions and 0 deletions
@@ -0,0 +1,39 @@
+@startuml
+!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml
+
+LAYOUT_TOP_DOWN()
+
+title LOTTY Backend - C4 Component
+
+Container_Boundary(api, "Backend Container (Django + Django Ninja)") {
+  Component(decision_endpoint, "Decision Endpoint", "api/v1/decision/endpoints.py", "POST /api/v1/decide")
+  Component(decision_service, "Decision Service", "apps/decision/services.py", "Flag lookup, targeting DSL, participation limits, hash-based variant assignment")
+
+  Component(events_endpoint, "Events Endpoint", "api/v1/events/endpoints.py", "POST /api/v1/events")
+  Component(events_service, "Events Service", "apps/events/services.py", "Validation, dedup, exposure/conversion attribution, pending promotion")
+
+  Component(reports_endpoint, "Reports Endpoint", "api/v1/reports/endpoints.py", "GET /reports/{experiment_id}")
+  Component(reports_service, "Reports Service", "apps/reports/services.py", "Per-variant metric calculation (ratio, count, average, percentile)")
+
+  Component(guardrails_service, "Guardrails Service", "apps/guardrails/services.py", "Threshold checks, auto pause/rollback")
+}
+
+ContainerDb(db, "Relational DB", "PostgreSQL / SQLite", "Flags, experiments, variants, decisions, events, exposures")
+Container(cache, "Cache", "Valkey / LocMem", "Flag and active experiment cache")
+Container(worker, "Celery Beat", "Celery", "Periodic guardrail checks (60s)")
+
+Rel(decision_endpoint, decision_service, "Delegates")
+Rel(decision_service, cache, "Reads cached flag / active experiment")
+Rel(decision_service, db, "Reads variants, writes Decision")
+
+Rel(events_endpoint, events_service, "Delegates batch")
+Rel(events_service, db, "Writes Event / Exposure / PendingEvent")
+
+Rel(reports_endpoint, reports_service, "Builds report")
+Rel(reports_service, db, "Reads attributed events / exposures")
+
+Rel(guardrails_service, reports_service, "Uses metric calculations")
+Rel(guardrails_service, db, "Writes triggers, updates experiment status")
+Rel(worker, guardrails_service, "Periodic check_all")
+
+@enduml