乐趣区

极速体验docker容器健康

jiezi

本文目是体验 docker 容器的健康检查功能，以体验为主不涉及开发，与开发相关的内容会在后面的文章细说。

关于容器健康检查

考虑这样的情况：docker 环境中，springboot 应用的容器还在，但已无法提供服务（例如数据或文件被破坏，线程池等资源被耗尽等各种异常），此时需要一种方式快速得知这种状态。
此时 <font color=”blue”> 容器健康检查 (即 HEALTHCHECK)</font> 就派上用场了，只要容器按照 Docker 的规则提供自身状态信息，就可以将容器健康信息以多种方式告知外界；

版本要求

docker 官方文档说明，HEALTHCHECK 功能从 1.12 版本开始提供，这里对 docker 社区版的版本号做个简介：

  1. 1.12 版本是 2016 年 07 月 28 日发布的；
  2. 1.13.1 版本 2017 年 02 月 08 日发布的，此版本之后，docker 的版本命名规则有了变化，改为 ”YY.MM” 格式；
  3. 17.03.0-ce 版本是 2017 年 03 月 01 日发布的，从此开始了 ”YY.MM” 格式的版本命名；
  4. 今天实战的 docker 环境是 19.03.2 版本;

实战环境信息

  1. 操作系统：macOS Catalina 10.15
  2. Docker：19.03.2

开始体验

  1. 在控制台输入以下命令，即可创建一个带有健康检查信息的容器：
docker run --rm \
--name=healthcheck \
-p 8080:8080 \
--health-cmd="curl --silent --fail localhost:8080/getstate || exit 1" \
--health-interval=15s \
--health-retries=10 \
--health-timeout=5s \
bolingcavalry/dockerhealthcheck:0.0.1-SNAPSHOT
  1. 上述命令中带有四个和健康检查相关的参数，这里解释一下：
参数名 作用
health-cmd 指定命令在容器内执行，用于检查容器健康状态
health-interval 每次健康检查的间隔时间，默认 30 秒
health-retries 假设该值为 3，表示若连续三次检测的返回结果都是不健康，就判定该容器不健康，默认值为 3
health-timeout 超时时间，默认 30 秒
  1. 关于 health-cmd 参数，最常用的是 shell 命令，例如本例中就是 <font color=”blue”>curl –silent –fail localhost:8080/getstate || exit 1</font>，意思是向容器的 8080 端口发起 http 请求，如果 http 响应的 code 为 200，整个 shell 的返回值就是 0，此时被 docker 判定为容器健康，如果 http 响应 code 不是 200，shell 的返回值就是 1，此时被 docker 判定为容器不健康；
  2. 再打开一个控制台窗口，执行 <font color=”blue”>docker ps</font> 查看容器状态，注意 STATUS 字段，可见刚创建容器的时候是 <font color=”red”>health: starting</font> 状态，稍后会变为 <font color=”red”>healthy</font> 状态：
(base) zhaoqindeMacBook-Pro:~ zhaoqin$ docker ps
CONTAINER ID        IMAGE                                            COMMAND                  CREATED             STATUS                             PORTS               NAMES
d86c11321cef        bolingcavalry/dockerhealthcheck:0.0.1-SNAPSHOT   "java -Xms1g -Xmx1g …"   13 seconds ago      Up 12 seconds (health: starting)   8080/tcp            healthcheck
(base) zhaoqindeMacBook-Pro:~ zhaoqin$ docker ps
CONTAINER ID        IMAGE                                            COMMAND                  CREATED             STATUS                    PORTS               NAMES
d86c11321cef        bolingcavalry/dockerhealthcheck:0.0.1-SNAPSHOT   "java -Xms1g -Xmx1g …"   17 seconds ago      Up 16 seconds (healthy)   8080/tcp            healthcheck
  1. 本次实战的镜像提供了 http 接口 <font color=”blue”>localhost:8080/getstate</font>，用于返回容器状态，每次被调用都会在控制台打印一行信息，容器日志如下：
2019-10-20 03:05:02.350  INFO 1 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
2019-10-20 03:05:02.364  INFO 1 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Completed initialization in 14 ms
2019-10-20 03:05:02.384  INFO 1 --- [nio-8080-exec-1] c.b.d.DockerhealthcheckApplication       : step probe return success
2019-10-20 03:05:17.584  INFO 1 --- [nio-8080-exec-2] c.b.d.DockerhealthcheckApplication       : step probe return success
2019-10-20 03:05:32.748  INFO 1 --- [nio-8080-exec-3] c.b.d.DockerhealthcheckApplication       : step probe return success

可见容器自启动后，该接口每隔 15 秒就会调用一次；

模拟不健康状态

  1. 在前面的操作中我们知道，只要容器的 http 接口 <font color=”blue”>localhost:8080/getstate</font> 的返回码是 200，容器就被判定为健康；
  2. 想看看不健康状态的样子，只要 http 接口 <font color=”blue”>localhost:8080/getstate</font> 的返回码不是 200 就行了；
  3. 此镜像提供了另一个接口来方便观察不健康状态，假设宿主机的 IP 地址是 102.168.0.3，在浏览器输入 <font color=”blue”>192.168.0.3:8080/setstate?state=false</font>，该接口调用完毕后，<font color=”blue”>localhost:8080/getstate</font> 的返回码就从 200 变成了 403；
  4. 再去看容器的控制台信息，这次内容有变化了，从 <font color=”blue”>step probe return success</font> 变成了 <font color=”red”>step probe return fail</font>，此时 getstate 接口的返回码是 403：
2019-10-20 03:38:51.428  INFO 1 --- [nio-8080-exec-3] c.b.d.DockerhealthcheckApplication       : step probe return success
2019-10-20 03:39:06.592  INFO 1 --- [nio-8080-exec-9] c.b.d.DockerhealthcheckApplication       : step probe return fail
2019-10-20 03:39:21.757  INFO 1 --- [io-8080-exec-10] c.b.d.DockerhealthcheckApplication       : step probe return fail
2019-10-20 03:39:36.912  INFO 1 --- [nio-8080-exec-3] c.b.d.DockerhealthcheckApplication       : step probe return fail
  1. 前面在创建容器时的 health-retries 参数的值是 10，意味着 <font color=”blue”>localhost:8080/getstate</font> 连续 10 次返回码非 200 才会被判定为不健康，因此，在控制台连续十次输出 <font color=”blue”>step probe return fail</font> 之前，执行 docker ps 命令观察容器状态，应该还是 <font color=”red”>healthy</font>，超过十次 <font color=”blue”>step probe return fail</font> 输出之后，再去看容器状态，就变成了 <font color=”red”>healthy</font>：
(base) zhaoqindeMacBook-Pro:~ zhaoqin$ docker ps
CONTAINER ID        IMAGE                                            COMMAND                  CREATED             STATUS                      PORTS                    NAMES
070e56cc99f2        bolingcavalry/dockerhealthcheck:0.0.1-SNAPSHOT   "java -Xms1g -Xmx1g …"   18 minutes ago      Up 18 minutes (unhealthy)   0.0.0.0:8080->8080/tcp   healthcheck
  1. 恢复健康状态：在浏览器输入 <font color=”blue”>192.168.0.3:8080/setstate?state=true</font>，这样 <font color=”blue”>localhost:8080/getstate</font> 接口的返回码又变成了 200，观察控制台，只要 ”step probe return success” 输出一次，容器健康状态就恢复为 healthy 了；

观察容器事件

  1. 在控制台输入 <font color=”blue”>docker events –filter event=health_status</font>，即可观察宿主机上所有的容器健康状态事件；
  2. 按照上面的操作，在浏览器输入 <font color=”blue”>192.168.0.3:8080/setstate?state=true</font> 或者 <font color=”blue”>192.168.0.3:8080/setstate?state=false</font>，将容器的健康状态转变几次，可以观察到容器事件变化：
(base) zhaoqindeMacBook-Pro:~ zhaoqin$ docker events --filter event=health_status
2019-10-20T12:19:18.349588676+08:00 container health_status: unhealthy 2d538f8752ae1e94ce23f34b7fb71c8f2ea3a075df82943ffdbe62c49ad4d6c8 (image=bolingcavalry/dockerhealthcheck:0.0.1-SNAPSHOT, name=healthcheck)
2019-10-20T12:20:19.030857534+08:00 container health_status: healthy 2d538f8752ae1e94ce23f34b7fb71c8f2ea3a075df82943ffdbe62c49ad4d6c8 (image=bolingcavalry/dockerhealthcheck:0.0.1-SNAPSHOT, name=healthcheck)

至此，docker 容器健康体验完毕，我们已经对此功能有了基本认识，接下来实战中，我们会尝试让自己的应用容器支持健康检查功能；

本文由博客一文多发平台 OpenWrite 发布！

退出移动版