Skip to content

docs(backlog): track PR #82 review suggestion as DEBT-026 #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fvadicamo merged 2 commits into from
Jul 12, 2026
Merged

docs(backlog): track PR #82 review suggestion as DEBT-026 #83

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
434d3cc
docs(backlog): add DEBT-026 for Prometheus instrumentation exclusions
fvadicamo Jul 12, 2026
0beb32a
docs(backlog): reorder DEBT-026 after DEBT-025; anchor regex examples
fvadicamo Jul 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .s2s/BACKLOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -907,6 +907,22 @@ Three near-duplicates is the threshold where extraction starts to pay off (a fou

---

### DEBT-026: Tune Prometheus instrumentation exclusions (health/docs endpoints)

**Status**: planned | **Priority**: low | **Created**: 2026-07-12
**Origin**: Gemini review on PR #82 (v0.5.1 release), `vektra-app/src/vektra_app/main.py:680`

**Context**: the prometheus-fastapi-instrumentator setup (introduced in v0.5.1 when it replaced starlette-prometheus) excludes only `/metrics` from instrumentation. Health endpoints (`/health`, `/health/{component}`, `/health/memory`) and docs endpoints (`/docs`, `/openapi.json`) are polled by load balancers, orchestrators, and monitoring systems; instrumenting them inflates request counters and histogram cardinality with traffic that carries no signal about API usage.

**Proposed approach**: extend `excluded_handlers` with anchored, escaped regexes — the instrumentator compiles each pattern and matches with `re.match`, so an unanchored `/docs` would also match `/docsomething` and an unescaped `.` matches any character. Example: `["^/metrics$", "^/health", "^/docs$", "^/openapi\\.json$"]`. Consider whether health-endpoint latency is itself worth tracking (it can reveal DB/LLM check slowness) before excluding it wholesale — an alternative is excluding only `/docs`/`/openapi.json` and keeping `/health` instrumented.

**Acceptance criteria**:
- [ ] Decision recorded on which endpoints stay instrumented (with rationale)
- [ ] `excluded_handlers` updated accordingly
- [ ] `/metrics` output verified: excluded handlers no longer appear in `http_requests_total`

---

### INFRA-005: Docker log persistence across container restarts

**Status**: planned | **Priority**: medium | **Created**: 2026-03-23
Expand Down
Loading