Путь проверки состояния нужен, если вы хотите выполнять периодическую проверку того, запущено ли приложение и работает ли оно корректно.
По умолчанию, если проверка состояния не включена, после деплоя выполняется только базовая проверка: система убеждается, что контейнер с приложением успешно запущен. При этом работоспособность самого приложения не оценивается — оно может отвечать некорректно или не отвечать совсем — статус деплоя останется успешным.
Чтобы избежать таких ситуаций, можно настроить путь проверки состояния. Для этого в приложении должен быть реализован эндпоинт, который не зависит от внешних факторов (например, готовности базы данных или сторонних сервисов) и отражает состояние приложения.
Этот эндпоинт вы сможете указать при настройке — например, /health, /status или /ping.
Как работает
Во всех случаях запрос к пути проверки состояния выполняется с localhost.
Главное требование — возвращать код 2xx. Содержимое ответа неважно, главное — корректный код ответа.
При редеплое
Если путь проверки состояния указан, система делает до трех последовательных GET-запросов к новому инстансу приложения.
- Если хотя бы один запрос возвращает код
2xx— деплой считается успешным, и новая версия приложения становится активной. - Если три проверки подряд завершаются ошибкой (любой ответ, отличный от
2xx) — деплой считается неуспешным, и продолжает работать предыдущая версия. - Проверки продолжаются до тех пор, пока не будет:
- один успешный ответ,
- три неуспешных ответа подряд через 40 секунд после запуска,
- или не пройдет 180 секунд — если за это время ни одно из условий не выполнено, деплой считается неуспешным.
В логах деплоя появится сообщение, если проверка не пройдена.
После запуска
После успешного деплоя система продолжает регулярно проверять работоспособность приложения: один запрос каждые 30 секунд.
Если три проверки подряд завершаются ошибкой, приложение автоматически перезапускается. Это отобразится в логах приложения.
Настройка
Путь проверки состояния можно указать как при создании приложения, так и для уже существующего.
При создании приложения
App Platform автоматически определит путь проверки состояния, если он реализован для вашего приложения, но вы можете просмотреть и при необходимости отредактировать его.
Для этого в разделе «Расширенные настройки» кликните «Показать расширенные настройки» и найдите поле «Путь проверки состояния».
Например, если в приложении реализован эндпоинт /health, который доступен по адресу https://домен/health, нужно указать:
/health
Для уже созданного приложения
-
Откройте нужное приложение в панели управления.
-
Перейдите на вкладку «Настройки».
-
В блоке «Настройки деплоя» нажмите кнопку «Редактировать».
-
Введите путь проверки состояния.
-
Нажмите «Сохранить данные».
После этого автоматически запустится новый деплой с обновленной настройкой.
Docker и Docker Compose
Если вы используете деплой через Dockerfile, в панели управления будет доступна настройка пути проверки состояния.
Путь проверки состояния, указанный в панели управления, имеет приоритет над HEALTHCHECK в Dockerfile. Проверка из Dockerfile используется только в том случае, если поле «Путь проверки состояния» в панели оставлено пустым.
Настройка через Dockerfile подробно описана в официальной документации.
Пример:
HEALTHCHECK --interval=30s --timeout=10s --retries=3 \ CMD curl -f http://localhost/health || exit 1
Для деплоев через Docker Compose настройка пути проверки состояния в панели управления не поддерживается. Если при этом используется Dockerfile, вы можете настроить HEALTHCHECK внутри него — правило будет работать, как описано выше.