Проверки работоспособности
Mitra отвечает всем, кто за ним следит, на один вопрос: работает ли этот экземпляр? Спросите по этому адресу, вход не нужен:
GET /api/healthОн проверяет единственное, без чего Mitra не может работать: свою базу данных.
| Ответ | Значение |
|---|---|
200 {"status":"ok"} | Работает. База данных отвечает. |
503 {"status":"error"} | Не работает. База данных не ответила или отвечала слишком долго. |
Ответ намеренно скупой. В нём нет ни версии, ни сведений о сборке, по которым посторонний мог бы понять, что у вас запущено, и он никогда не кешируется, поэтому каждая проверка видит текущее состояние.
Подключённые сервисы, например сервер CalDAV, Notion, Google, провайдер входа или геокодер, в проверку не входят. Кратковременный сбой у одного из них не должен помечать сам Mitra как неработающий.
Docker
Section titled “Docker”В образе уже есть проверка работоспособности Docker на основе этого адреса, поэтому docker ps и docker inspect показывают реальное состояние Mitra без какой-либо настройки. Новый контейнер сначала показывает состояние starting, а когда база данных готова, оно меняется на healthy. Если вы меняли MITRA_PORT, проверка это учитывает.
curl -f http://localhost:3000/api/health # fails unless Mitra is healthydocker inspect --format '{{.State.Health.Status}}' mitraKubernetes
Section titled “Kubernetes”Направьте на этот адрес и liveness-, и readiness-пробу:
livenessProbe: httpGet: path: /api/health port: 3000 periodSeconds: 30readinessProbe: httpGet: path: /api/health port: 3000 periodSeconds: 10Мониторинг доступности
Section titled “Мониторинг доступности”Любой HTTP-монитор, например Uptime Kuma, Healthchecks.io или собственная проверка балансировщика нагрузки, может опрашивать /api/health и считать недоступным всё, что не 200. Это работает одинаково и с входом, и без него.