Work README: request telemetry (telemetry_samples, one-minute aggregates, 14 days) (#47)

OP OpenVibers committed 29 days ago · 94d52eb0cd · 1 file, +1 −0

Changes

ddiff --git a/README.md b/README.md
iindex e0a89eb..ce21f98 100644
---- a/README.md
++++ b/README.md
@@@ -42,6 +42,7 @@ republished: Work stores a short plain-text excerpt and sends the reader to the
  | Discovery | [server/http/discovery.js](server/http/discovery.js) | `robots.txt`, `sitemap.xml` (the newest listings too), `llms.txt`, `llms-full.txt`, JSON-LD; with `INDEXNOW_KEY`, each ingest run's new listings are sent to IndexNow |
  | Limits | [server/http/caller-limits.js](server/http/caller-limits.js), [deploy/nginx/](deploy/nginx/) | Per-caller limits at the API (the search and the saved-search writes have their own) and per-address limits at nginx |
  | Health | [server/observability.js](server/observability.js) | `/api/health`, a truthful `/api/ready` (the database is required) and Prometheus metrics on loopback only |
++| Telemetry | [server/app.js](server/app.js), [server/index.js](server/index.js), [migrations/0006_telemetry.sql](migrations/0006_telemetry.sql) | Every request aggregated by route template, method and status class, never by raw URL; once a minute one `http.request` sample per key, plus the active-requests, p95-latency and event-loop-lag gauges, written to this service's own `telemetry_samples` table (openvibe-sdk 0.46 telemetry, the `platform.telemetry-sample@1` shape); rows older than 14 days are deleted daily; `/shared` files, static assets, health, readiness and `/metrics` are not counted. `app.js` builds the collector (`createHttpTelemetry`) and mounts its middleware; `index.js` flushes it every minute and on stop and runs the retention |
  | Database | [server/db.js](server/db.js), [migrations/](migrations/) | PostgreSQL through `openvibe-sdk/db`; `NNNN_*.sql` applied at boot; PGlite in development |
  | Process | [server/index.js](server/index.js) | Listens on `PORT`, starts the ingest when it is on, and stops gracefully through `openvibe-sdk/service` |
  | Deploy | [deploy/nginx/openvibe.work.conf](deploy/nginx/openvibe.work.conf), [deploy/systemd/openvibe-work.service](deploy/systemd/openvibe-work.service) | nginx vhost and systemd unit (port 4960, `/opt/openvibe.work`, `/etc/openvibe/work.env`) |

diff --git a/README.md b/README.md

index e0a89eb..ce21f98 100644

--- a/README.md

+++ b/README.md

@@ -42,6 +42,7 @@ republished: Work stores a short plain-text excerpt and sends the reader to the

| Discovery | [server/http/discovery.js](server/http/discovery.js) | `robots.txt`, `sitemap.xml` (the newest listings too), `llms.txt`, `llms-full.txt`, JSON-LD; with `INDEXNOW_KEY`, each ingest run's new listings are sent to IndexNow |

| Limits | [server/http/caller-limits.js](server/http/caller-limits.js), [deploy/nginx/](deploy/nginx/) | Per-caller limits at the API (the search and the saved-search writes have their own) and per-address limits at nginx |

| Health | [server/observability.js](server/observability.js) | `/api/health`, a truthful `/api/ready` (the database is required) and Prometheus metrics on loopback only |

+| Telemetry | [server/app.js](server/app.js), [server/index.js](server/index.js), [migrations/0006_telemetry.sql](migrations/0006_telemetry.sql) | Every request aggregated by route template, method and status class, never by raw URL; once a minute one `http.request` sample per key, plus the active-requests, p95-latency and event-loop-lag gauges, written to this service's own `telemetry_samples` table (openvibe-sdk 0.46 telemetry, the `platform.telemetry-sample@1` shape); rows older than 14 days are deleted daily; `/shared` files, static assets, health, readiness and `/metrics` are not counted. `app.js` builds the collector (`createHttpTelemetry`) and mounts its middleware; `index.js` flushes it every minute and on stop and runs the retention |

| Database | [server/db.js](server/db.js), [migrations/](migrations/) | PostgreSQL through `openvibe-sdk/db`; `NNNN_*.sql` applied at boot; PGlite in development |

| Process | [server/index.js](server/index.js) | Listens on `PORT`, starts the ingest when it is on, and stops gracefully through `openvibe-sdk/service` |

| Deploy | [deploy/nginx/openvibe.work.conf](deploy/nginx/openvibe.work.conf), [deploy/systemd/openvibe-work.service](deploy/systemd/openvibe-work.service) | nginx vhost and systemd unit (port 4960, `/opt/openvibe.work`, `/etc/openvibe/work.env`) |