Cấu hình Healthcheck và depends_on trong Docker Compose đúng cách

Cấu hình Healthcheck và depends_on trong Docker Compose đúng cách | Shanverse

Codeyaml

1healthcheck:2  test:3    [4      "CMD",5      "node",6      "-e",7      "fetch('http://localhost:3000/health/ready').then(r=>process.exit(r.ok?0:1)).catch(()=>process.exit(1))",8    ]9  interval: 10s10  timeout: 3s11  retries: 512  start_period: 15s

Codejavascript

1// healthcheck.js2const controller = new AbortController();3const timer = setTimeout(() => controller.abort(), 2_000);45try {6  const response = await fetch("http://localhost:3000/health/ready", {7    signal: controller.signal,8  });9  process.exit(response.ok ? 0 : 1);10} catch {11  process.exit(1);12} finally {13  clearTimeout(timer);14}

Codejavascript

1app.get("/health/ready", async (_request, response) => {2  try {3    await pool.query("SELECT 1");4    response.status(200).json({ status: "ready" });5  } catch {6    response.status(503).json({ status: "not-ready" });7  }8});

Codeyaml

1postgres:2  image: postgres:17-alpine3  environment:4    POSTGRES_USER: ${POSTGRES_USER}5    POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}6    POSTGRES_DB: ${POSTGRES_DB}7  healthcheck:8    test:9      [10        "CMD-SHELL",11        "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}",12      ]13    interval: 5s14    timeout: 5s15    retries: 1016    start_period: 10s

Codeyaml

1mongodb:2  image: mongo:8.03  healthcheck:4    test:5      [6        "CMD",7        "mongosh",8        "--quiet",9        "--eval",10        "quit(db.adminCommand('ping').ok ? 0 : 2)",11      ]12    interval: 10s13    timeout: 5s14    retries: 10

Codeyaml

1name: healthcheck-demo23services:4  postgres:5    image: postgres:17-alpine6    environment:7      POSTGRES_USER: ${POSTGRES_USER}8      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}9      POSTGRES_DB: ${POSTGRES_DB}10    volumes:11      - postgres_data:/var/lib/postgresql/data12    healthcheck:13      test:14        [15          "CMD-SHELL",16          "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}",17        ]18      interval: 5s19      timeout: 5s20      retries: 1021      start_period: 10s22    restart: unless-stopped2324  migrate:25    build: .26    command: npm run db:migrate27    environment:28      DATABASE_URL: postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}29    depends_on:30      postgres:31        condition: service_healthy32    restart: "no"3334  api:35    build: .36    command: npm run start37    environment:38      PORT: 300039      DATABASE_URL: postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}40    ports:41      - "3000:3000"42    depends_on:43      postgres:44        condition: service_healthy45        restart: true46      migrate:47        condition: service_completed_successfully48    healthcheck:49      test:50        [51          "CMD",52          "node",53          "-e",54          "fetch('http://localhost:3000/health/ready').then(r=>process.exit(r.ok?0:1)).catch(()=>process.exit(1))",55        ]56      interval: 10s57      timeout: 3s58      retries: 559      start_period: 20s60    restart: unless-stopped6162  worker:63    build: .64    command: npm run worker65    environment:66      DATABASE_URL: postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}67    depends_on:68      api:69        condition: service_healthy70    restart: unless-stopped7172volumes:73  postgres_data:

Codejavascript

1const sleep = (milliseconds) =>2  new Promise((resolve) => setTimeout(resolve, milliseconds));34export async function connectWithRetry(connect, attempts = 8) {5  for (let attempt = 1; attempt <= attempts; attempt += 1) {6    try {7      return await connect();8    } catch (error) {9      if (attempt === attempts) throw error;1011      const delay = Math.min(1_000 * 2 ** (attempt - 1), 30_000);12      const jitter = Math.floor(Math.random() * 250);13      await sleep(delay + jitter);14    }15  }16}

Codebash

1docker compose exec api \2  node -e "fetch('http://localhost:3000/health/ready').then(async r=>{console.log(r.status, await r.text()); process.exit(r.ok?0:1)}).catch(e=>{console.error(e); process.exit(1)})"

Vấn đề: Container đã chạy nhưng ứng dụng chưa sẵn sàng

Comments

Health status hoạt động thế nào?

Cấu trúc healthcheck

CMD và CMD-SHELL

Exec form: CMD

Shell form: CMD-SHELL

Healthcheck chạy ở đâu?

Healthcheck cho Node.js không cần curl

Liveness và readiness khác nhau

Liveness

Readiness

Healthcheck cho PostgreSQL

Healthcheck cho MongoDB và Redis

depends_on dạng ngắn: chỉ đảm bảo thứ tự start

depends_on dạng dài và ba condition

service_started

service_healthy

service_completed_successfully

Stack hoàn chỉnh: PostgreSQL → Migration → API → Worker

restart: true bên trong depends_on

Dependency tùy chọn với required: false

Restart policy khác healthcheck và depends_on

depends_on chỉ giúp lúc khởi động

Dùng healthcheck từ Dockerfile hay Compose?

Khởi động và đợi stack healthy

Theo dõi và debug health status

Vì sao healthcheck luôn fail?

Tool không tồn tại

App bind sai interface

Endpoint yêu cầu authentication

Timeout quá ngắn

start_period quá ngắn

Biến bị Compose interpolate nhầm

Healthcheck quá nặng

Anti-pattern phổ biến

Dùng sleep 30

Chỉ dùng short depends_on

Healthcheck gọi mọi dependency

Dùng healthcheck để chạy migration

Ghi password trực tiếp trong health command

Tạo dependency vòng tròn

Tin rằng healthy nghĩa là business logic hoàn hảo

Checklist production

Tổng kết

Related posts

Khi nào Docker Compose không còn đủ? Chuyển sang Kubernetes hoặc Docker Swarm

Thiết lập Live Reload và Hot Reload khi phát triển với Docker Compose

Docker Compose là gì? Kết nối Node.js với PostgreSQL hoặc MongoDB