openvibers/openvibe.search Commits

Search README: request telemetry (telemetry_samples, one-minute aggregates, 14 days) (#63)

OP OpenVibers committed 29 days ago · 730655de4a · 1 file, +9 −0

Changes

ddiff --git a/README.md b/README.md
iindex 32ba8e3..fca8861 100644
---- a/README.md
++++ b/README.md
@@@ -43,6 +43,15 @@ is on. `GET /metrics` (openvibe-shared/metrics) answers direct loopback callers
by route template, `search_documents{exposure}`, `search_documents_indexed{index}` and the outbox
backlog.
++Request telemetry is aggregated by route template, method and status class, never by raw URL, and
++leaves out `/shared` files, static assets, health, readiness and `/metrics`. Once a minute, one
++`http.request` sample per key plus the active-requests, p95 latency and event-loop-lag gauges is
++written to this service's own `telemetry_samples` table (openvibe-sdk 0.46 telemetry, the
++`platform.telemetry-sample@1` shape, created by `migrations/0003_telemetry.sql`), and rows older
++than 14 days are deleted daily. `server/app.js` mounts the SDK's `telemetryMiddleware` (a no-op
++until init); `server/index.js` calls `telemetry.init()` at production start, runs the 14-day
++retention and flushes on stop.
++
## Query API
```http