openstacktop/rfc-service-health
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Specification for a uniform /service-health endpoint — JSON + OpenMetrics, scrapeable by Prometheus.
3 commits 1 branch 1 tag 165 KiB
  • Python 51.2%
  • Shell 48.8%
Find a file
Exact
Tom-Oliver Dick 91b4b3f25b add README.md
2026-05-19 22:57:12 +02:00
docs chore: build docs 2026-05-19 22:57:05 +02:00
scripts init: definition of v1.0 for service-health RFC independent standard 2026-05-19 22:56:48 +02:00
.gitignore init: definition of v1.0 for service-health RFC independent standard 2026-05-19 22:56:48 +02:00
LICENSE init: definition of v1.0 for service-health RFC independent standard 2026-05-19 22:56:48 +02:00
README.md add README.md 2026-05-19 22:57:12 +02:00
rfc-service-health.md init: definition of v1.0 for service-health RFC independent standard 2026-05-19 22:56:48 +02:00

README.md

Service Health Spec

Specification for the /service-health endpoint that every service across relatable systems implements. Defines a uniform JSON / OpenMetrics format so Prometheus can scrape directly and Grafana can render a single health view across them.

The RFC

docs/rfc-service-health.txt — the canonical RFC. Open in any monospace context (editor, terminal, browser) for the classic IETF text rendering. This is the file to read or share.

Other rendered formats

Same content, different presentations (regenerated by scripts/build_docs.sh):

Source

rfc-service-health.md — the kramdown-rfc Markdown source. Edit this and rebuild; everything under docs/ is regenerated from it.

Build

scripts/build_docs.sh

Outputs land in docs/. See the script header for system prerequisites (uv, Ruby + kdrfc, WeasyPrint native libs). Python is pinned and provisioned by uv — the host Python is not used.

License

CC BY 4.0 — see LICENSE.