From 232ede123703a22a04afa2785bdd586793d25721 Mon Sep 17 00:00:00 2001 From: ITQ Date: Tue, 24 Feb 2026 09:43:00 +0300 Subject: [PATCH] docs: added docs --- README.md | 54 ++++++++++++++++++++++- assets/images/health.png | 3 ++ assets/images/logs.png | 3 ++ assets/images/metrics.png | 3 ++ assets/images/pipeline.png | 3 ++ assets/images/ready.png | 3 ++ assets/images/style.png | 3 ++ assets/images/testing_report.png | 3 ++ assets/images/tests_coverage.png | 3 ++ assets/images/tests_coverage_per_file.png | 3 ++ 10 files changed, 79 insertions(+), 2 deletions(-) create mode 100644 assets/images/health.png create mode 100644 assets/images/logs.png create mode 100644 assets/images/metrics.png create mode 100644 assets/images/pipeline.png create mode 100644 assets/images/ready.png create mode 100644 assets/images/style.png create mode 100644 assets/images/testing_report.png create mode 100644 assets/images/tests_coverage.png create mode 100644 assets/images/tests_coverage_per_file.png diff --git a/README.md b/README.md index 0e8ec57..182e21c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,36 @@ Service for managing A/B testing experiments. Drive your tests without breaking user experience!_) +## 🎨 Artifacts + +### Runbook + +[RUNBOOK.md](./RUNBOOK.md) + +### Diagrams + +### Testing report + +Can be seen in GitLab CI/CD pipeline run + +1. Go to the [pipelines page](https://gitlab.prodcontest.com/2026-final-users/backend/itq.dev/-/pipelines) +2. Click on the latest pipeline run +![pipeline run](./assets/images/pipeline.png) +3. Testing report (`Tests` tab) +![testing report](./assets/images/testing_report.png) +4. Tests coverage (`Jobs` tab) +![tests coverage](./assets/images/tests_coverage.png) + +Here on screenshot you can see coverage percent (`97%`), for detailed coverage per file go to the `test` job log + +![tests coverage per file](./assets/images/tests_coverage_per_file.png) + +### Repository map + +[MAP.md](./MAP.md) + +Yep, artifacts content is written in Russian, but all other docs are in English, this is for judges' convenient experience. + ## 📋 Instructions ### Dedicated services setup @@ -52,6 +82,26 @@ docker compose -f compose.prod.yaml up Thats it, project is already preconfigured for running, so no changes before running this are required. -## Linting and formatting +## Linting && formatting -Described [here](./src/backend/README.md#) +Instructions [here](./src/backend/README.md#linting--formatting). + +Example run: +![style](./assets/images/style.png) + +## Observability + +### Structured logs + +![logs](./assets/images/logs.png) + +### Health/ready endpoints (`/health`/`/ready`) + +![health](./assets/images/health.png) +![ready](./assets/images/ready.png) + +### Metrics (`/metrics`) + +![metrics](./assets/images/metrics.png) + +System metrics (gc, requests, etc.) and several business metrics (`lotty_decide_requests_total`, `lotty_events_ingested_total"`). diff --git a/assets/images/health.png b/assets/images/health.png new file mode 100644 index 0000000..8a2d7a2 --- /dev/null +++ b/assets/images/health.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:42ad71febd26c8d1f3cfe9b9c533d5b7ab814a2404fa4e8e1fa44221d361a5d1 +size 79631 diff --git a/assets/images/logs.png b/assets/images/logs.png new file mode 100644 index 0000000..0c12eab --- /dev/null +++ b/assets/images/logs.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b5bfb86bfaea1d973bbb3cc628c323a9a885f48fb79c29d3017c612dd73f636d +size 1020301 diff --git a/assets/images/metrics.png b/assets/images/metrics.png new file mode 100644 index 0000000..b2194c3 --- /dev/null +++ b/assets/images/metrics.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:695670c29e56471fee856871a31ac39cc26025a0d3b82ef5845514c33b433e1d +size 989859 diff --git a/assets/images/pipeline.png b/assets/images/pipeline.png new file mode 100644 index 0000000..700826d --- /dev/null +++ b/assets/images/pipeline.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0789ce55e6f03c9ac565b8e8c933383ac27b4a4e479656f80a8f1343ceda6be5 +size 241663 diff --git a/assets/images/ready.png b/assets/images/ready.png new file mode 100644 index 0000000..2131813 --- /dev/null +++ b/assets/images/ready.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a25ccd0adfc641e10228491c987ff5f8ebcc398ba8a0bfe2fdd64bc7953acd5f +size 118058 diff --git a/assets/images/style.png b/assets/images/style.png new file mode 100644 index 0000000..f20c6e7 --- /dev/null +++ b/assets/images/style.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8d38cd8d1e175a9ce9fb36a0b139779fa2129a35015d9ae13872cf1d3ba4f326 +size 48045 diff --git a/assets/images/testing_report.png b/assets/images/testing_report.png new file mode 100644 index 0000000..3e81cec --- /dev/null +++ b/assets/images/testing_report.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fad678f5f7fb7fb2deeedf5d30916e69de7c7b10b7e8f29b579bca4e0dff8e35 +size 188594 diff --git a/assets/images/tests_coverage.png b/assets/images/tests_coverage.png new file mode 100644 index 0000000..2346916 --- /dev/null +++ b/assets/images/tests_coverage.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:691d954098191dbda3c962b8ec1c7ba0536953adb54cd2279af33b019783661a +size 419702 diff --git a/assets/images/tests_coverage_per_file.png b/assets/images/tests_coverage_per_file.png new file mode 100644 index 0000000..094fdaa --- /dev/null +++ b/assets/images/tests_coverage_per_file.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ed3836c9ca3df02fd92dca061d3d509ed8cb5c46c90c8ea649556e4384c80094 +size 380811