Przejdź do głównej zawartości

Administracja22 paź 20261 minuta czytania

Kontrola stanu

Mitra odpowiada na jedno pytanie każdemu, kto ją monitoruje: czy ta instancja działa? Zadaj je pod tym adresem, który nie wymaga logowania:

GET /api/health

Sprawdzana jest jedyna rzecz, bez której Mitra nie może działać, czyli baza danych:

OdpowiedźZnaczenie
200 {"status":"ok"}Działa. Baza danych odpowiada.
503 {"status":"error"}Nie działa. Baza danych nie odpowiedziała albo odpowiadała zbyt długo.

Odpowiedź jest celowo skąpa. Nie zawiera wersji ani szczegółów kompilacji, które zdradziłyby obcym, czego używasz, i nigdy nie trafia do pamięci podręcznej, więc każde sprawdzenie widzi bieżący stan.

Połączone usługi, takie jak serwer CalDAV, Notion, Google, dostawca logowania czy geokoder, nie są brane pod uwagę. Krótka awaria jednej z nich nie powinna oznaczać samej aplikacji Mitra jako niesprawnej.

Obraz ma już wbudowany health check Dockera, który korzysta z tego punktu końcowego, więc docker ps i docker inspect pokazują rzeczywisty stan aplikacji Mitra bez żadnej konfiguracji. Nowy kontener ma najpierw stan starting, a gdy baza danych zacznie działać, stan healthy. Jeśli zmienisz MITRA_PORT, health check to uwzględni.

Terminal window
curl -f http://localhost:3000/api/health # fails unless Mitra is healthy
docker inspect --format '{{.State.Health.Status}}' mitra

Skieruj na ten punkt końcowy zarówno sondę liveness, jak i sondę readiness:

livenessProbe:
httpGet:
path: /api/health
port: 3000
periodSeconds: 30
readinessProbe:
httpGet:
path: /api/health
port: 3000
periodSeconds: 10

Dowolny monitor HTTP, na przykład Uptime Kuma, Healthchecks.io albo wbudowane sprawdzanie load balancera, może odpytywać /api/health i traktować każdą odpowiedź inną niż 200 jako awarię. Działa to tak samo z logowaniem i bez niego.