Docker Health Check

Background

通常情况下,我们会使用一个容器运行一种服务,比如一个容器运行数据库服务,一个容器作为web服务器等等, 因此一个容器被setup起来并不能代表其中的服务毫无问题,因此如何check容器中的服务器是否正常才是最重要的问题。

容器的状态

我们都知道,通过docker ps你可以看到所有正在运行的容器,以及容器的部分信息:
[图片上传失败...(image-f10236-1555504132810)]
有两个列是需要关注的:

  • COMMAND:
    通常为了容器中的service正常启动,我们会使用CMD/ENTRYPOINT设置一段指令。容器启动之后,通常会根据 Dockerfile 中的 CMD 或 ENTRYPOINT 启动一个进程,Command描述的就是这个进程执行的指令。

  • STATUS
    描述的是当前容器的状态,以及容器在多久之前进入这样的状态。也可以说他描述的是上面COMMAND指令执行的情况。

    命令显示:

    • 有的容器正在运行,状态为 UP。

    • 有的容器已经正常停止了,状态是 Exited (0)。或者说COMMAND执行的指令正常退出

    • 有的则因发生故障停止了,退出代码为非 0,例如 Exited (137)、Exited (1) 等。

虽然,我们通常会通过CMD、ENTRYPOINT设置COMMAND指令是容器server的启动指令,我们也能通过STATUS看到启动指令是否执行成功。但是及时COMMAND没有出错STATUS是up也不能等同于这个server可以提供服务

Health Check

What

Docker允许指定一个命令作为health check命令,Docker可以通过这个指令执行的成功与否来判定容器当前的状态。

Docker 支持的 Health Check 可以是任何一个单独的命令,Docker 会在容器中执行该命令,如果返回 0,容器被认为是 healthy,如果返回 1,则为 unhealthy。

当一个容器有指定健康检查 (HEALTHCHECK) 时,它除了普通的容器状态之外,还有:

  • starting: Initial status when the container is still starting
  • healthy: 如果health check成功
  • unhealthy: If a single run of the takes longer than the specified timeout then it is considered unhealthy. If a health check fails then the will run retries number of times and will be declared unhealthy if the still fails.

这些状态你可以通过docker ps看到。

how to check health

In Dockerfile
  • 给镜像设置HEALTHCHECK
    HEALTHCHECK [option] CMD <command>
    
    • command是HEAlthcheck的指令:如果你的service是restful api,指令可以是curl heartbeat api
    • option:
      • --interval=<interval>: 两次健康检查命令执行的间隔时间. default value 是 30 seconds.
      • --timeout=<interval>: 设置某一个次health check执行的timeout时间,一旦超时代表这一次healthcheck失败. default value 是 30 seconds.
      • --retries=<number of times>: 设置health check连续失败次数一旦达到设置的值容器状态就会变成unhealthy. default value 是 3.
      • --start-period=<interval>: The initialization time of application startup. Failed health check during the startup is not counted. The default value is 0 second (introduced since version 17.05).

Note
The HEALTHCHECK 只能在Dockerfile中出现一次,如果你设置了多次,那么就会直接使用最后一个命令

  • 如果本身镜像中有HEALTHCHECK,下面的指令可以禁止HEALTHCHECK
HEALTHCHECK NONE

一旦容器被正常启动,初始状态就是starting. Docker engine会自动的根据你设定的--interval, 每个interval时间运行一次这个health check command, 并且根据每次运行的结果及时的update你的容器的status

举个例子:

FROM elasticsearch:5.5
HEALTHCHECK --interval=5s --timeout=2s --retries=12 \
  CMD curl --silent --fail localhost:9200/_cluster/health || exit 1
In docker compose

docker compose 2.1版本之后才支持health check

healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost"]
  interval: 1m30s
  timeout: 10s
  retries: 3
  start_period: 40s
  • test: 定义了health check的指令,只能是string或者一个list。如果是list,第一个参数只能是NONE, CMD or CMD-SHELL
healthcheck:
  test: curl -f https://localhost || exit 1
  interval: 1m30s
  timeout: 10s
  retries: 3
  start_period: 40s

可以使用如下指令disable掉image的healthcheck

healthcheck:
  disable: true
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342

推荐阅读更多精彩内容