style: apply global formatting fixes (struct, spacing, zhlint)

This commit is contained in:
Baohua Yang
2026-02-21 11:08:52 -08:00
parent ad68b2d973
commit 79ac9c639a
159 changed files with 1708 additions and 882 deletions

View File

@@ -1,7 +1,11 @@
## 7.12 HEALTHCHECK 健康检查
本节涵盖了相关内容与详细描述主要探讨以下几个方面
### 基本语法
如下代码块所示展示了相关示例
```docker
HEALTHCHECK [选项] CMD <命令>
HEALTHCHECK NONE
@@ -19,7 +23,7 @@ HEALTHCHECK NONE
- 应用陷入死循环CPU 爆满但进程存活
**引入 HEALTHCHECK **
Docker 定期执行指定的检查命令根据返回值判断容器是否"健康"
Docker 定期执行指定的检查命令根据返回值判断容器是否 健康
```
容器状态转换:
@@ -32,8 +36,12 @@ Starting ──成功──> Healthy ──失败N次──> Unhealthy
### 基本用法
本节涵盖了相关内容与详细描述主要探讨以下几个方面
#### Web 服务检查
如下代码块所示展示了相关示例
```docker
FROM nginx
RUN apt-get update && apt-get install -y curl && rm -rf /var/lib/apt/lists/*
@@ -44,9 +52,9 @@ HEALTHCHECK --interval=30s --timeout=3s --retries=3 \
#### 命令返回值
- `0`: 成功 (healthy)
- `1`: 失败 (unhealthy)
- `2`: 保留值 (不使用)
- `0`成功 (healthy)
- `1`失败 (unhealthy)
- `2`保留值 (不使用)
#### 常用选项
@@ -72,6 +80,8 @@ HEALTHCHECK NONE
### 常见检查脚本
本节涵盖了相关内容与详细描述主要探讨以下几个方面
#### HTTP 服务
使用 `curl` `wget`
@@ -88,6 +98,8 @@ HEALTHCHECK CMD wget -q --spider http://localhost/ || exit 1
#### 数据库
如下代码块所示展示了相关示例
```docker
## MySQL
@@ -100,6 +112,8 @@ HEALTHCHECK CMD redis-cli ping || exit 1
#### 自定义脚本
如下代码块所示展示了相关示例
```docker
COPY healthcheck.sh /usr/local/bin/
HEALTHCHECK CMD ["healthcheck.sh"]
@@ -109,7 +123,7 @@ HEALTHCHECK CMD ["healthcheck.sh"]
### Compose 中使用
可以在 `compose.yaml` `docker-compose.yml`中覆盖或定义健康检查
可以在 `compose.yaml` ( `docker-compose.yml`) 中覆盖或定义健康检查
```yaml
services:
@@ -172,17 +186,19 @@ $ docker inspect --format '{{json .State.Health}}' mycontainer | jq
### 最佳实践
#### 1. 避免副作用
本节涵盖了相关内容与详细描述主要探讨以下几个方面
#### 1避免副作用
健康检查会被频繁执行不要在检查脚本中进行写操作或消耗大量资源的操作
#### 2. 使用轻量级工具
#### 2使用轻量级工具
优先使用镜像中已有的工具 `wget`避免为了健康检查安装庞大的依赖 `curl`
优先使用镜像中已有的工具 ( `wget`)避免为了健康检查安装庞大的依赖 ( `curl`)
#### 3. 设置合理的 Start Period
#### 3设置合理的 Start Period
应用启动可能需要时间 Java 应用设置 `--start-period` 可以防止在启动阶段因检查失败而误判
应用启动可能需要时间 ( Java 应用)设置 `--start-period` 可以防止在启动阶段因检查失败而误判
```docker
## 给应用 1 分钟启动时间
@@ -190,8 +206,8 @@ $ docker inspect --format '{{json .State.Health}}' mycontainer | jq
HEALTHCHECK --start-period=60s CMD curl -f http://localhost/ || exit 1
```
#### 4. 只检查核心依赖
#### 4只检查核心依赖
健康检查应主要关注**当前服务**是否可用而不是检查其下游依赖数据库等下游依赖的检查应由应用逻辑处理
健康检查应主要关注**当前服务**是否可用而不是检查其下游依赖 (数据库等)下游依赖的检查应由应用逻辑处理
---