Docker HEALTHCHECK 指令

示例

该HEALTHCHECK指令有两种形式:

HEALTHCHECK [OPTIONS] CMD command (check container health by running a command inside the container)
HEALTHCHECK NONE (disable any healthcheck inherited from the base image)

该HEALTHCHECK指令告诉Docker如何测试容器以检查其是否仍在工作。这样可以检测到诸如Web服务器陷入无限循环并且无法处理新连接的情况,即使服务器进程仍在运行。

当指定了运行状况检查的容器时,除了其正常状态外,它还具有运行状况。此状态最初开始。只要运行状况检查通过,它就会变得健康(无论以前处于什么状态)。在一定数量的连续失败之后,它就变得不健康。

之前可能出现的选项CMD是:

--interval=DURATION (default: 30s)
--timeout=DURATION (default: 30s)
--retries=N (default: 3)

运行状况检查将首先在容器启动后的间隔秒数内运行,然后在每次之前的检查完成后的间隔秒数内运行。

如果单次检查花费的时间超过超时秒数,则认为检查失败。

需要重新尝试连续进行的健康检查失败,才能将容器视为不健康。

HEALTHCHECK指令中只能有一条指令Dockerfile。如果您列出多个,则只有最后一个HEALTHCHECK才会生效。

CMD关键字之后的命令可以是shell命令(例如HEALTHCHECK CMD /bin/check-running)或exec数组(与其他Dockerfile命令一样;ENTRYPOINT有关详细信息,请参见例如)。

命令的退出状态指示容器的健康状态。可能的值为:

  • 0: success -容器健康且可以使用

  • 1: unhealthy -容器工作不正常

  • 2: starting -容器尚未准备就绪,但可以正常使用

如果在容器已移出“开始”状态时探针返回2(“开始”),则将其视为“不健康”。

例如,要每五分钟检查一次,以便网络服务器能够在三秒钟内为站点的主页提供服务:

HEALTHCHECK --interval=5m --timeout=3s \
  CMD curl -f http://localhost/ || exit 1

为了帮助调试失败的探针,命令在stdout或stderr上写入的任何输出文本(UTF-8编码)将存储在运行状况中,并可以通过查询docker inspect。此类输出应保持简短(当前仅存储前4096个字节)。

当容器的健康状态发生变化时,将health_status生成具有新状态的事件。

该HEALTHCHECK功能已在Docker 1.12中添加。