HTTP API: health

Zda je to, co tento proces servíruje, v pořádku, rozhodnuté stroji, které o tom už rozhodují: diagnostika indexu, builder registru, pokrytí projekce měření výkonu, porovnání, které provádí `generate --check`, a čtení lease, z něhož odpovídá `server.status`. Žádná zdejší kontrola nemá vlastní názor.

Vykresleno z docs/generated/openapi.json, který spustitelný soubor generuje ze svého registru schopností a CI jej odmítne, je-li zastaralý. Surový dokument je na /openapi.json; běžící server servíruje stejný dokument na vlastní /openapi.json a Swagger UI na /swagger.

zdraví

GET /api/v1/health health.report

Zdraví tohoto procesu

Každý rozměr toho, co tento proces servíruje — vrstva tak, jak byla načtena, registr, rozsah, správa verzí, pokrytí měření výkonu, commitnutý manifest registru, sdílený server tohoto checkoutu a připojení peerové — každý posouzený motorem, který jej vlastní, s příkazem, který verdikt reprodukuje.

query
behaviorally_verified
vyžaduje se měření výkonu
proces cache (max_entries=4, ttl_seconds=5)
Nástroj MCP majordomus_health
Zdroj MCP {"name": "health", "uri": "majordomus://health"}

Žádné parametry.

Vyzkoušejte

Port je ten, který server zalogoval; 8741 je ten, o který žádá jako první. Hodnoty jsou první příklad operace.

curl -s "http://127.0.0.1:8741/api/v1/health"

Testováno v apps/majordomus-cli/tests/http_serve.rs, který přehrává routu s těmito hodnotami proti serveru na skutečném socketu.

Odpovědi

status	tělo	význam
200	Zdraví	Stav tohoto procesu: výsledek.
400	ErrorBody	`invalid_input`: Vstup neodpovídá schématu: parametr špatného typu, neznámý parametr nebo hodnota, kterou schopnost odmítne.
404	ErrorBody	`not_found`: Vstup pojmenovává něco, co repozitář nemá.
500	ErrorBody	`internal`: Schopnost selhala z vlastního důvodu; zpráva ho pojmenovává.
výchozí	ErrorBody	Jakékoli jiné selhání, které transport hlásí: 405 `method_not_allowed` pro jinou metodu na této cestě, 400 `invalid_input` pro tělo, které není objektem JSON.

GET /api/v1/live health.live

Živost

Je tento proces naživu: nejlevnější pravdivé tvrzení, které o sobě tento spustitelný soubor může učinit, s verzí, která odpověděla. Žádný průchod souborovým systémem, žádné budování indexu, žádná síť — to se ptá hostingová platforma a říct to nesmí nic stát.

query
behaviorally_verified
vyžaduje se měření výkonu
cache vypnuta

Žádné parametry.

Vyzkoušejte

Port je ten, který server zalogoval; 8741 je ten, o který žádá jako první. Hodnoty jsou první příklad operace.

curl -s "http://127.0.0.1:8741/api/v1/live"

Testováno v apps/majordomus-cli/tests/http_serve.rs, který přehrává routu s těmito hodnotami proti serveru na skutečném socketu.

Odpovědi

status	tělo	význam
200	Živost	Liveness: výsledek.
400	ErrorBody	`invalid_input`: Vstup neodpovídá schématu: parametr špatného typu, neznámý parametr nebo hodnota, kterou schopnost odmítne.
404	ErrorBody	`not_found`: Vstup pojmenovává něco, co repozitář nemá.
500	ErrorBody	`internal`: Schopnost selhala z vlastního důvodu; zpráva ho pojmenovává.
výchozí	ErrorBody	Jakékoli jiné selhání, které transport hlásí: 405 `method_not_allowed` pro jinou metodu na této cestě, 400 `invalid_input` pro tělo, které není objektem JSON.

GET /api/v1/ready health.ready

Připravenost

Může tento proces obsluhovat provoz: registr a index, které sestavil při startu, už rezidentní, a jak se vrstva četla. Jen lokální inicializace — nikdy externí provider, databáze nebo jiná služba, protože kontrola připravenosti, která sonduje závislost, shodí nasazení kvůli něčemu, co není tento proces.

query
behaviorally_verified
vyžaduje se měření výkonu
cache vypnuta

Žádné parametry.

Vyzkoušejte

Port je ten, který server zalogoval; 8741 je ten, o který žádá jako první. Hodnoty jsou první příklad operace.

curl -s "http://127.0.0.1:8741/api/v1/ready"

Testováno v apps/majordomus-cli/tests/http_serve.rs, který přehrává routu s těmito hodnotami proti serveru na skutečném socketu.

Odpovědi

status	tělo	význam
200	Připravenost	Připravenost: výsledek.
400	ErrorBody	`invalid_input`: Vstup neodpovídá schématu: parametr špatného typu, neznámý parametr nebo hodnota, kterou schopnost odmítne.
404	ErrorBody	`not_found`: Vstup pojmenovává něco, co repozitář nemá.
500	ErrorBody	`internal`: Schopnost selhala z vlastního důvodu; zpráva ho pojmenovává.
výchozí	ErrorBody	Jakékoli jiné selhání, které transport hlásí: 405 `method_not_allowed` pro jinou metodu na této cestě, 400 `invalid_input` pro tělo, které není objektem JSON.

Schémata

Komponenty, které používají jen operace tohoto tagu. Každý řádek je pole daného typu, jeho doc komentář je popis; typ vlastněný jinou stránkou na ni odkazuje.

Zdraví

object

Zdraví toho, co tento proces obsluhuje.

vlastnost	typ	povinné	popis
status	HealthStatus → HealthStatus	ano	Stav nejhorší kontroly.
repozitář	HealthStatus → HealthStatus	ano	Nejhorší stav mezi dimenzemi, které popisují repozitář při tomto commitu: každá kontrola kromě těch v `PROCESS_DIMENSIONS`. Proces, který není server — příkazová řádka nebo čtenář publikovaného snapshotu (ADR 0141) — nemůže rozhodnout, kdo je připojen ani co udělal runtime meshe, a řekne `unknown` pro ně; toto je verdikt, který je stejný, ať repozitář četl kterýkoli proces, a publikace ukazuje jako první právě ten.
součty	mapa celých čísel (uint)	ano	Kolik kontrol stojí kde, podle slova stavu.
kontroly	pole HealthCheck → HealthCheck	ano	Každá dimenze ve stabilním pořadí.
pozorováno	mapa AnswerObservation → AnswerObservation	ne	Kdy byl přečten stav, na jehož základě se kontrola rozhodla, podle ID kontroly: smlouva o aktuálnosti (`crate::index::AnswerObservation`). Kontrola, která zde chybí, rozhodla živě, během tohoto volání. `layer` a `git` jsou zde proto, že posuzují obraz, který pořídil index, a ten je stejně starý jako index.

Používá health.report

HealthCheck

object

Jeden rozměr systému, rozhodnutý jedním enginem, s tím, co čtenář potřebuje, aby si ho ověřil sám.

vlastnost	typ	povinné	popis
id	string	ano	Stabilní id, `[a-z][a-z0-9-]*`.
název	string	ano	Krátký název.
status	HealthStatus → HealthStatus	ano	Jak to stojí.
detail	string	ano	Jeden řádek: co engine rozhodl a na čem.
decided_by	string	ano	Engine, který rozhodl, pojmenovaný, aby čtenář věděl, co opravit.
evidence	array of string	ne	Co verdikt reprodukuje: příkaz, nebo cesta.
zjištění	array of string	ne	Nálezy za verdiktem, když nějaké engine vytvořil: diagnostické zprávy, zastaralé soubory, chybějící řádky pokrytí.

Používá Health

Živost

object

Odpověď na otázku "žije tento proces": nejlevnější pravdivá věc, kterou tento spustitelný soubor o sobě může říct. Záměrně není souhrnem ničeho — sonda, která by si vypěstovala názor, by přestala hlásit jedinou skutečnost, kvůli které se na ni platforma ptá.

vlastnost	typ	povinné	popis
živý	boolean	ano	Vždy `true`. Proces, který by nedokázal odpovědět, by neodpověděl vůbec, a to je ten signál.
verze	string	ano	Verze tohoto spustitelného souboru, aby postupné nasazení poznalo, které sestavení odpovědělo.
commit	string	ano	Commit, z něhož byl tento spustitelný soubor sestaven, celý, nebo `unknown`, když ho build nedokázal určit. Verze je to, jak se build nazývá, a dvě revize ji sdílejí; toto je to, proti čemu se nasazení kontroluje. Nikdy se nevynechává: chybějící pole by se četlo jako server příliš starý na to, aby to řekl, a `unknown` je jiná, pravdivá odpověď.
špinavé	boolean \| null	ne	Zda strom onoho commitu nesl při sestavení tohoto spustitelného souboru necommitnuté změny; `null`, když to build nevěděl.

Používá health.live

Připravenost

object

Odpověď na otázku „může tento proces obsluhovat provoz“: lokální inicializace, kterou by požadavek potřeboval, a nic nad rámec tohoto procesu. Kontrola připravenosti, které narostla sonda závislostí, shodí nasazení kvůli tomu, že nefunguje nesouvisející služba.

vlastnost	typ	povinné	popis
připraveno	boolean	ano	Zda je každá část níže na místě.
verze	string	ano	Verze tohoto spustitelného souboru.
commit	string	ano	Commit, z něhož byl tento spustitelný soubor sestaven, nebo `unknown`; tutéž hodnotu vrací `health.live`.
špinavé	boolean \| null	ne	Zda byl strom buildu špinavý; `null`, když to build nevěděl.
capabilities	integer (uint)	ano	Kolik schopností registr drží; nula by znamenala, že není co servírovat.
objekty	integer (uint)	ano	Kolik objektů index drží. Čteno z indexu, který tento proces sestavil při startu: už je v paměti a jeho čtení nic neprochází.
vrstva	HealthStatus → HealthStatus	ano	Zda se vrstva četla čistě. Degradovaná vrstva se přesto obsluhuje — diagnostika je smyslem — takže toto hlásí, neodmítá.
zastaralé	string \| null	ne	Proč tento proces obsluhuje kód, který už na disku není: spustitelný soubor, z něhož byl spuštěn, byl od té doby nahrazen nebo odstraněn. Je-li přítomno, `ready` je nepravda — server odpovídající včerejším kódem to říká na místě, kde říká, že je připraven, klientovi, který nedrží nic než tuto odpověď (I1502).
důvody	array of string	ne	Každý důvod, proč tato odpověď není prosté ano, jako `code: words`. `lease_lost` a `stale` činí `ready` nepravdivým: jiný proces drží lease tohoto checkoutu, nebo tento obsluhuje kód, který už neexistuje. `layer_degraded` ho nepravdivým nečiní: vrstva se servíruje se svou diagnostikou a klient rozhodne, zda to stačí.

Používá health.ready