Проверка состояния контейнера в Docker

Каким-то непонятным образом я пропустил новость о том, что начиная с версии 1.12 Docker контейнерам можно навешивать проверку состояния. И речь тут идёт не о проверке, запущен ли ещё контейнер, а о том, делает ли он всё ещё то, ради чего создавался. Например, мы можем проверять, отзывается ли веб-сервер внутри контейнера на входящие запросы, вменяемое ли количество памяти он использует, встречаются ли в логах фразы вроде «epic fail!!!»… Много чего можно проверить, ведь проверка делается через запуск какого-нибудь стороннего скрипта или приложения, а её результат зависит от кода, с которым это приложение завершилось.

В обычном режиме контейнер, последние несколько проверок которого оказались «так себе», получит атрибут «unhealthy», в Docker events появится соответствующая запись (health_status), и на этом история закончится. Но если речь идёт о Swarm режиме, то проблемный контейнер без лишних разговоров усыпят и автоматически запустят новый. Вот так жестоко.

Как включить проверку состояний

Есть по крайней мере четыре места, где её можно включить и настроить:

  • в самом Dockerfile,
  • в команде docker run,
  • в YAML для docker-compose и docker stack
  • и в docker service create команде.

Как минимум в настройку проверки нужно передать команду (скрипт, экзешник), которая эту проверку будет делать. Команда должна завершаться с кодом 0 , если контейнер здоров, и 1, если всё уже плохо. В довесок можно указать, как часто запускать проверку (--interval), как долго ей можно длиться (--timeout), и сколько раз (—retries) она должна вернуть 1, прежде чем на контейнере поставят жирный «unhealthy» крест.

Проверка состояния контейнера в Dockerfile

Представьте, что у нас есть контейнер, в котором живёт веб-сервер, способность отвечать на запросы которого мы хотим проконтролировать. Например, раз в 5 секунд мы будем отправлять ему запрос, давать максимум 10 секунд на то, чтобы тот ответил, и если 3 раза подряд он слажает — будем подозревать неладное. Так как в Dockerfile есть инструкция HEALTHCHECK, и её формат — прост до безобразия (  HEALTHCHECK [OPTIONS] CMD command), то при помощи какого-нибудь curl нашу проверку можно сделать так:

Команда будет запускаться изнутри контейнера, так что обращаться к серверу можно и по 127.0.0.1.

Проверка состояния в docker-compose YAML

Она практически никак не отличается от оной в Dockerfile:

Проверка в docker run и service create

У этих двух синтаксис проверок одинаковый и тоже предсказуемо понятный:

Кстати, если в Dockerfile образе, который мы запускаем, уже была проверка, то на этой стадии её можно переопределить или даже выключить с помощью --no-healthcheck=true.

Большой пример проверки состояний

Жертва

Я сделал маленький node.js сервер, главной целью в жизни которого является отвечать ‘OK’ на запросы к порту 8080, и отключаться/включаться после запросов к порту 8081:

Примерно так:

Теперь положим этот server.js в Dockerfile, добавим туда HEALTHCHECK, соберём это всё в образ по имени server и запустим:

Первых трём символов айдишки контейнера — ec3 — нам будет достаточно, чтобы к нему обратиться, так что самое время перейти к проверкам.

Мониторим состояние контейнера

Основная команда для запроса состояния контейнера в Docker — docker inspect. Она много чего может рассказать, но нам всего-то нужно свойство State.Health:

Вполне предсказуемо, контейнер — в ‘healthy’ состоянии, а в Log даже можно посмотреть, чем отзывался сервер на запросы. Но если мы теперь отправим запрос на 8081 и подождём 3*5 секунд (3 проверки подряд), то кое-что изменится в интересную сторону.

Я промазал мимо 15 секунд и пропустил аж четыре проверки, поэтому значение в FailingStreak стало равно четырём. Но в остальном Нострадамус не врал — контейнер перешёл в разряд ‘unhealthy’.

Правда, достаточно лишь одной успешной проверки, чтобы контейнер официально воскрес:

Узнаём статус контейнера из Docker events

Кроме как спрашивать контейнер о его здоровье напрямую, можно спросить у его соседей — docker events:

Обычно событий у Docker достаточно много, так что пришлось приглушить ненужные параметром --filter. Сама docker events самостоятельно не завершится и будет спамить в консоль до скончания веков.

Состояние контейнера в Swarm сервисах

Чтобы начать играться с сервисами, мне пришлось временно перевести локальный Docker в Swarm режим через docker swarm init. Зато теперь наш server образ можно запускать вот так:

Оказывается, Swarm не очень любит локально созданные образы, поэтому-то и выплюнул в консоль несколько ошибок со своим недовольством. Но сервис всё-таки создал и вернул его айдишку:

curl 127.0.0.1:8080 теперь снова будет возвращать OK (я проверял), а запрос на порт 8081 временно заткнёт сервер. Но в отличие от первого примера, примерно через пол минуты после того, как сервер был явно отключён, он снова начнёт отзываться на 8080. Как же так?

Прикол в том, что как только мы отключили сервер и его контейнер получил статус unhealthy, это тут же заметил Swarm менеджер и понял, что заявленная конфигурация сервиса больше не выполняется. А так нельзя, поэтому он быстренько прибил проблемный сервисный контейнер и заменил его на новый, рабочий. Следы этого можно увидеть, посмотрев историю задач для всего сервиса:

Маленькая предыстория: для каждого контейнера в сервисе Swarm создаёт задачу. То есть сначала идёт задача, а она уже приводит к контейнеру. Наш первый контейнер «упал», поэтому менеджер создал новую задачу, и она привела к новому контейнеру. Но старая задача осталась в истории! docker service ps показывает всё цепочку смертей и реинкарнаций задач, и в нашем случае видно, что самая старая задача с айди pj77brhfhsjm помечена как упавшая, и через docker inspect можно узнать почему:

«Unhealthy container», вот почему.

Мораль

Проверки состояния контейнеров в Docker — это возможность регулярно запускать сторонние скрипты и экзешники внутри контейнера, чтобы узнать, достаточно ли живо его содержимое. В однохостовом режиме докер просто пометит проблемные контейнеры как unhealthy и сгенерирует health_status событие. В облачном же режиме он ещё и отключит этот контейнер и заменит его на новый, всё ещё здоровый. Быстро и автоматически.

3 комментария для “Проверка состояния контейнера в Docker

  1. Здравствуйте.
    У вас опечатка в разделе «Проверка состояния в docker-compose YAML»: вместо echo 1 должно быть exit 1.
    Спасибо за гайд.

    1. Здравствуйте! Кажется, вы абсолютно правы. Хотя я в упор не помню, зачем вообще был блок «|| exit 1». Если уже дело дошло до «||», то exit code перед этим был ненулевым, и для health check этого, по идее, и так достаточно. Старый стал. Не помню хода мыслей.

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *