Skip to content

docs: document per-instance API metrics limits #136

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
hivecommons-hive merged 1 commit into from
Sep 30, 2026
Merged

docs: document per-instance API metrics limits #136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,22 @@ The site is Next.js + Nextra, deployed on Netlify (site `hivecommons-docs`).
Navigation is defined in `src/app/docs/page-map.ts`; project registry in
`src/config/versions.ts`.

## Observability

The site exposes per-instance API metrics via `/api/metrics` in Prometheus text format.
The endpoint serves bounded, in-process counters and histograms for the `search` and
`docs-image` API handlers only (not static assets or page traffic).

**Scope and durability:** The registry is process-local with no configured exporter or
backend. On Netlify, instances are ephemeral, so the `/api/metrics` snapshot is not
durable or site-wide. It is suitable only for immediate, per-instance instrumentation
during development or local testing.

**Site-wide telemetry:** If persistent, aggregated request telemetry is needed, use a
deployment-supported collection path — for example, Netlify's platform-native traffic
analytics, or an explicitly operator-configured scraper/aggregator that polls `/api/metrics`
across instances and persists data to a central observability backend.

## Contributing

PRs welcome. Sign your commits (DCO): `git commit -s`.
Expand Down
Loading