docker和docker-compose中加入healthcheck

最新推荐文章于 2025-11-20 15:02:05 发布

原创最新推荐文章于 2025-11-20 15:02:05 发布 · 1.6w 阅读

11 ·

CC 4.0 BY-SA版权

文章标签：

#docker-compose

docker 专栏收录该内容

8 篇文章

订阅专栏

本文介绍了如何在Dockerfile和docker-compose中加入HEALTHCHECK，以确保容器内的应用程序健康运行。HEALTHCHECK指令允许从业务层面检查容器状态，避免仅依赖容器进程是否运行来判断健康状况。在Docker 1.12及以后版本，可以通过HEALTHCHECK CMD命令设置检查，如使用curl检查HTTP服务状态。在docker-compose中，HEALTHCHECK的配置格式略有不同，并可通过设置参数调整检查间隔和重试次数。

dockerfile中加入HEALTHCHECK

docker 容器的健康检查
在这里插入图片描述
容器的状态是 Up ，应用就是健康的吗？
其实即使容器状态是 Up ，也不能保证应用没有问题。比如当我们在 docker-compose 文件里面设置了 restart: always 时候，当容器崩溃的时候，docker 守护进程会重启容器。但是，如果容器的确在运行，但是容器里的应用不可用怎么办（比如容器里的 web server 应用一直返回 500）？

HEALTHCHECK 指令是告诉 Docker 应该如何进行判断容器的状态是否正常，这是 Docker 1.12 引入的新指令。在没有 HEALTHCHECK 指令前，Docker 引擎只可以通过容器内主进程是否退出来判断容器是否状态异常。很多情况下这没问题，但是如果程序进入死锁状态，或者死循环状态，应用进程并不退出，但是该容器已经无法提供服务了。在 1.12 以前，Docker 不会检测到容器的这种状态，从而不会重新调度，导致可能会有部分容器已经无法提供服务了却还在接受用户请求。

而自 1.12 之后，Docker 提供了 HEALTHCHECK 指令，通过该指令指定一行命令，用这行命令来判断容器主进程的服务状态是否还正常，从而比较真实的反应容器实际状态。

当在一个镜像指定了 HEALTHCHECK 指令后，用其启动容器，初始状态会为 starting，在 HEALTHCHECK 指令检查成功后变为 healthy，如果连续一定次数失败，则会变为 unhealthy。

因此我们需要使用 HEALTHCHECK 从应用的业务层面检查容器的状态。

在 HEALTHCHECK [选项] CMD 后面的命令，格式和 ENTRYPOINT 一样，分为 shell 格式，和 exec 格式。命令的返回值决定了该次健康检查的成功与否：0：成功；1：失败；2：保留，一般不使用这个值。

格式：

HEALTHCHECK [选项] CMD <命令>：设置检查容器健康状况的命令
HEALTHCHECK NONE：如果基础镜像有健康检查指令，使用这行可以屏蔽掉其健康检查指令

HEALTHCHECK  支持下列选项：
--interval=<间隔>：两次健康检查的间隔，默认为 30 秒，单位(h/m/s)；
--timeout=<时长>：健康检查命令运行超时时间，如果超过这个时间，本次健康检查就被视为失败，默认 30 秒，单位(h/m/s)；
--retries=<次数>：当连续失败指定次数后，则将容器状态视为 unhealthy，默认 3 次。
和 CMD, ENTRYPOINT 一样，HEALTHCHECK 只可以出现一次，如果写了多个，只有最后一个生效。

举个例子，对于提供 HTTP 服务接口的应用，可以通过 curl 检查 HTTP 状态吗。比如：

FROM node:11.15.0-alpine
MAINTAINER wollens

WORKDIR /code

RUN apk update && apk upgrade && \
    apk add --no-cache bash git curl
HEALTHCHECK --interval=2m --timeout=10s --start-period=5s --retries=3 CMD curl -f http://127.0.0.1:8012/ || exit 1
ADD src /code/src

COPY package.json ./
COPY tsconfig.json ./
RUN npm install
EXPOSE 8012
RUN npm run compile
CMD npm run start

docker-compose中加入HEALTHCHECK

在docker-compose中加入healthcheck

healthcheck 支持下列选项：
interval=<间隔>：两次健康检查的间隔，默认为 30 秒，单位(h/m/s)；
timeout=<时长>：健康检查命令运行超时时间，如果超过这个时间，本次健康检查就被视为失败，默认 30 秒，单位(h/m/s)；
retries=<次数>：当连续失败指定次数后，则将容器状态视为 unhealthy，默认 3 次。
和 CMD, ENTRYPOINT 一样，HEALTHCHECK 只可以出现一次，如果写了多个，只有最后一个生效。

在docker-compose中使用HEALTHCHECK 和在dockerfile中使用格式上稍有不同。

具体格式如下(注意参数和 : 之间的空格):

healthcheck:
      test: ["CMD" "命令"]
      interval:
      timeout:
      retries:

举个?: 验证我们本地web服务是否正常启动

version: "3"

services:
  server:
    build: .
    image: test:0.0.7
    volumes:
      - .:/code
      - /code/node_modules
    ports:
      - "8012:8012"
    environment:
      MYSQL_HOST: mysqldb
    links:
      - mysqldb
    healthcheck:
      test: ["CMD", "curl", "-f", "http://127.0.0.1:8012"/, "||", "exit", "1"]
      interval: 2m
      timeout: 10s
      retries: 3

  mysqldb:
    image: mysql:5.6
    command: --default-authentication-plugin=mysql_native_password
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: xxx
      MYSQL_DATABASE: test