feat: 新增 ICMP/Ping checker 设计提案

- 定义 ping target 配置：host、count、packetSize - 定义 ping expect 断言：alive、maxPacketLoss、maxAvgLatencyMs、maxMaxLatencyMs - 设计跨平台 ping 输出解析器（Linux/macOS/Windows 含多语言支持） - 双重超时保障：ping 命令自身超时 + AbortSignal 兜底 - 扩展 checker-runner-abstraction spec 支持 ping checker 子进程控制 - 更新 probe-config spec 支持 ping type 配置
2026-05-18 00:33:11 +08:00
parent 0a9a9016be
commit 393e8da5fd
7 changed files with 510 additions and 0 deletions
--- a/openspec/changes/add-icmp-checker/specs/checker-runner-abstraction/spec.md
+++ b/openspec/changes/add-icmp-checker/specs/checker-runner-abstraction/spec.md
@@ -0,0 +1,16 @@
+## MODIFIED Requirements
+
+### Requirement: 超时控制由引擎注入 signal
+Checker 实现的 `execute()` MUST 使用 `ctx.signal` 感知超时，不得自行创建 `AbortController` 或 `setTimeout` 用于超时控制。Cmd checker 和 ping checker 可在 signal abort 时 `proc.kill()` 以确保子进程被终止。
+
+#### Scenario: HTTP checker 使用 signal
+- **WHEN** HttpChecker 执行 HTTP 请求
+- **THEN** SHALL 将 `ctx.signal` 传入 `fetch()` 的 `signal` 选项，不自行创建 `AbortController`
+
+#### Scenario: Cmd checker 响应 signal
+- **WHEN** CommandChecker 执行命令且 signal 被 abort
+- **THEN** SHALL 调用 `proc.kill()` 终止子进程，并在 CheckResult 中记录超时错误
+
+#### Scenario: Ping checker 响应 signal
+- **WHEN** IcmpChecker 执行 ping 命令且 signal 被 abort
+- **THEN** SHALL 调用 `proc.kill()` 终止 ping 子进程，并在 CheckResult 中记录超时错误
--- a/openspec/changes/add-icmp-checker/specs/icmp-checker/spec.md
+++ b/openspec/changes/add-icmp-checker/specs/icmp-checker/spec.md
@@ -0,0 +1,192 @@
+## Purpose
+
+定义 ICMP/Ping checker 的配置格式、命令执行、跨平台输出解析、expect 校验、失败结构和状态摘要。
+
+## Requirements
+
+### Requirement: ping target 配置
+系统 SHALL 支持 `type: ping` 的 target 配置，通过 `ping.host` 描述目标主机地址，并通过可选字段控制探测行为。
+
+#### Scenario: 解析最简 ping target
+- **WHEN** YAML 中 target 配置 `type: ping` 和 `ping.host: "10.0.0.1"`
+- **THEN** 系统 SHALL 将其解析为 ping checker，并填充 `count=3`、`packetSize=56`、interval、timeout、group 和 expect 配置
+
+#### Scenario: ping target 缺少 host
+- **WHEN** YAML 中 target 配置 `type: ping` 但缺少 `ping.host`
+- **THEN** 系统 SHALL 以配置错误退出，并提示该 target 缺少 ping.host 字段
+
+#### Scenario: ping host 类型非法
+- **WHEN** YAML 中 ping target 的 `ping.host` 不是非空字符串
+- **THEN** 系统 SHALL 以配置错误退出，提示 ping.host 必须为非空字符串
+
+#### Scenario: ping count 配置
+- **WHEN** YAML 中 ping target 配置 `ping.count: 5`
+- **THEN** 系统 SHALL 使用 5 作为 ICMP 包发送数量
+
+#### Scenario: ping count 非法
+- **WHEN** YAML 中 ping target 的 `ping.count` 不是 1 到 100 之间的正整数
+- **THEN** 系统 SHALL 以配置错误退出，提示 ping.count 必须为 1-100 的正整数
+
+#### Scenario: ping packetSize 配置
+- **WHEN** YAML 中 ping target 配置 `ping.packetSize: 1472`
+- **THEN** 系统 SHALL 使用 1472 作为 ICMP 包大小（bytes）
+
+#### Scenario: ping packetSize 非法
+- **WHEN** YAML 中 ping target 的 `ping.packetSize` 不是 1 到 65500 之间的正整数
+- **THEN** 系统 SHALL 以配置错误退出，提示 ping.packetSize 必须为 1-65500 的正整数
+
+#### Scenario: ping 分组未知字段失败
+- **WHEN** YAML 中 ping target 的 `ping` 分组包含 `timeout: 5` 等未知字段
+- **THEN** 系统 SHALL 以配置错误退出，提示 ping 分组包含未知字段
+
+#### Scenario: ping 序列化展示摘要
+- **WHEN** 系统同步 ping target 到 targets 表
+- **THEN** `target` 展示摘要 SHALL 为 `ping <host>`，`config` JSON SHALL 包含 resolved 后的 host、count 和 packetSize
+
+### Requirement: ping checker 执行
+系统 SHALL 通过调用系统 `ping` 命令执行 ICMP 探测，记录完整执行耗时，并在命令不可用、超时或解析失败时产生结构化失败信息。
+
+#### Scenario: ping 命令构建（Linux）
+- **WHEN** 系统平台为 linux，ping target 配置 host="10.0.0.1"、count=3、packetSize=56，且外层 timeoutMs=10000
+- **THEN** 系统 SHALL 执行 `ping -c 3 -s 56 -W 10 10.0.0.1`（-W 单位为秒，向上取整）
+
+#### Scenario: ping 命令构建（macOS）
+- **WHEN** 系统平台为 darwin，ping target 配置 host="10.0.0.1"、count=3、packetSize=56，且外层 timeoutMs=10000
+- **THEN** 系统 SHALL 执行 `ping -c 3 -s 56 -W 10000 10.0.0.1`（-W 单位为毫秒）
+
+#### Scenario: ping 命令构建（Windows）
+- **WHEN** 系统平台为 win32，ping target 配置 host="10.0.0.1"、count=3、packetSize=56，且外层 timeoutMs=10000
+- **THEN** 系统 SHALL 执行 `ping -n 3 -l 56 -w 10000 10.0.0.1`（-w 单位为毫秒）
+
+#### Scenario: ping 命令不存在
+- **WHEN** 系统未安装 `ping` 命令（spawn 抛出 ENOENT）
+- **THEN** 系统 SHALL 记录 `matched=false`，failure 的 kind 为 `error`，phase 为 `ping`，path 为 `spawn`，message 包含 "ping 命令不可用" 和原始错误信息
+
+#### Scenario: ping 执行超时
+- **WHEN** 引擎注入的 `ctx.signal` 在 ping 命令执行过程中 abort
+- **THEN** 系统 SHALL 调用 `proc.kill()` 终止子进程，记录 `matched=false`，failure 的 kind 为 `error`，phase 为 `ping`，message 包含超时信息
+
+#### Scenario: ping 目标可达
+- **WHEN** ping target 指向可达主机，且 ping 命令正常返回
+- **THEN** 系统 SHALL 解析 stdout 获取统计数据，并按断言链执行 expect 校验
+
+#### Scenario: ping 目标不可达
+- **WHEN** ping target 指向不可达主机，且 ping 命令返回 100% packet loss
+- **THEN** 系统 SHALL 解析 stdout 获取统计数据，`alive` 为 false，延迟字段为 null
+
+#### Scenario: duration 覆盖完整执行
+- **WHEN** ping 命令执行完成
+- **THEN** 结果中的 `durationMs` SHALL 覆盖从 spawn 到进程退出的完整耗时
+
+### Requirement: 跨平台 ping 输出解析
+系统 SHALL 实现跨平台 ping 输出解析器，支持 Linux、macOS 和 Windows（含多语言 locale），从 stdout 中提取 transmitted、received、packetLoss、minLatencyMs、avgLatencyMs、maxLatencyMs。
+
+#### Scenario: 解析 Linux ping 输出
+- **WHEN** 平台为 linux，stdout 包含 "3 packets transmitted, 3 received, 0% packet loss" 和 "rtt min/avg/max/mdev = 1.234/2.345/3.456/0.567 ms"
+- **THEN** 系统 SHALL 解析为 transmitted=3, received=3, packetLoss=0, minLatencyMs=1.234, avgLatencyMs=2.345, maxLatencyMs=3.456
+
+#### Scenario: 解析 macOS ping 输出
+- **WHEN** 平台为 darwin，stdout 包含 "3 packets transmitted, 3 packets received, 0.0% packet loss" 和 "round-trip min/avg/max/stddev = 1.234/2.345/3.456/0.567 ms"
+- **THEN** 系统 SHALL 解析为 transmitted=3, received=3, packetLoss=0, minLatencyMs=1.234, avgLatencyMs=2.345, maxLatencyMs=3.456
+
+#### Scenario: 解析 Windows 英文 ping 输出
+- **WHEN** 平台为 win32，stdout 包含 "Packets: Sent = 3, Received = 3, Lost = 0 (0% loss)" 和 "Minimum = 1ms, Maximum = 3ms, Average = 2ms"
+- **THEN** 系统 SHALL 解析为 transmitted=3, received=3, packetLoss=0, minLatencyMs=1, avgLatencyMs=2, maxLatencyMs=3
+
+#### Scenario: 解析 Windows 中文 ping 输出
+- **WHEN** 平台为 win32，stdout 包含 "数据包: 已发送 = 3，已接收 = 3，丢失 = 0 (0% 丢失)" 和 "最短 = 1ms，最长 = 3ms，平均 = 2ms"
+- **THEN** 系统 SHALL 解析为 transmitted=3, received=3, packetLoss=0, minLatencyMs=1, avgLatencyMs=2, maxLatencyMs=3
+
+#### Scenario: 解析全部丢包（无延迟行）
+- **WHEN** stdout 包含丢包统计行但无延迟统计行（100% packet loss）
+- **THEN** 系统 SHALL 解析为 alive=false，延迟字段（min/avg/max）均为 null
+
+#### Scenario: 输出无法解析
+- **WHEN** stdout 不匹配任何已知的统计行格式
+- **THEN** 系统 SHALL 记录 `matched=false`，failure 的 kind 为 `error`，phase 为 `ping`，path 为 `parse`，message 包含 "无法解析 ping 输出"
+
+### Requirement: ping expect 校验
+系统 SHALL 支持 ping 专属 expect，包括 `alive`、`maxPacketLoss`、`maxAvgLatencyMs`、`maxMaxLatencyMs` 和 `maxDurationMs`，并按 alive、packetLoss、avgLatency、maxLatency、duration 的阶段顺序快速失败。
+
+#### Scenario: 默认 alive 成功语义
+- **WHEN** ping target 未显式配置 `expect.alive`
+- **THEN** 系统 SHALL 使用默认 `expect.alive: true` 进行校验
+
+#### Scenario: alive 校验通过
+- **WHEN** ping target 配置 `expect.alive: true`，且目标主机可达
+- **THEN** 系统 SHALL 判定 alive 阶段通过
+
+#### Scenario: alive 校验失败
+- **WHEN** ping target 配置 `expect.alive: true`，且目标主机不可达
+- **THEN** 系统 SHALL 返回 `matched=false`，failure 的 kind 为 `mismatch`，phase 为 `alive`
+
+#### Scenario: 反向 alive 断言
+- **WHEN** ping target 配置 `expect.alive: false`，且目标主机不可达
+- **THEN** 系统 SHALL 判定 alive 阶段通过（`matched=true`）
+
+#### Scenario: 反向 alive 断言失败
+- **WHEN** ping target 配置 `expect.alive: false`，但目标主机可达
+- **THEN** 系统 SHALL 返回 `matched=false`，failure 的 kind 为 `mismatch`，phase 为 `alive`
+
+#### Scenario: maxPacketLoss 校验通过
+- **WHEN** ping target 配置 `expect.maxPacketLoss: 10`，且实际丢包率为 0%
+- **THEN** 系统 SHALL 判定 packetLoss 阶段通过
+
+#### Scenario: maxPacketLoss 校验失败
+- **WHEN** ping target 配置 `expect.maxPacketLoss: 10`，且实际丢包率为 33%
+- **THEN** 系统 SHALL 返回 `matched=false`，failure 的 kind 为 `mismatch`，phase 为 `packetLoss`
+
+#### Scenario: maxAvgLatencyMs 校验通过
+- **WHEN** ping target 配置 `expect.maxAvgLatencyMs: 200`，且实际平均延迟为 12ms
+- **THEN** 系统 SHALL 判定 avgLatency 阶段通过
+
+#### Scenario: maxAvgLatencyMs 校验失败
+- **WHEN** ping target 配置 `expect.maxAvgLatencyMs: 100`，且实际平均延迟为 156ms
+- **THEN** 系统 SHALL 返回 `matched=false`，failure 的 kind 为 `mismatch`，phase 为 `avgLatency`
+
+#### Scenario: maxMaxLatencyMs 校验通过
+- **WHEN** ping target 配置 `expect.maxMaxLatencyMs: 500`，且实际最大延迟为 340ms
+- **THEN** 系统 SHALL 判定 maxLatency 阶段通过
+
+#### Scenario: maxMaxLatencyMs 校验失败
+- **WHEN** ping target 配置 `expect.maxMaxLatencyMs: 200`，且实际最大延迟为 340ms
+- **THEN** 系统 SHALL 返回 `matched=false`，failure 的 kind 为 `mismatch`，phase 为 `maxLatency`
+
+#### Scenario: maxDurationMs 校验
+- **WHEN** ping target 配置 `expect.maxDurationMs: 5000`，且完整执行耗时超过 5000ms
+- **THEN** 系统 SHALL 返回 `matched=false`，failure 的 phase 为 `duration`
+
+#### Scenario: alive=false 时跳过延迟断言
+- **WHEN** ping target 配置 `expect.alive: true` 和 `expect.maxAvgLatencyMs: 100`，且目标不可达
+- **THEN** 系统 SHALL 在 alive 阶段即返回失败，不执行后续延迟断言
+
+#### Scenario: ping expect 未知字段失败
+- **WHEN** YAML 中 ping target 的 expect 包含 `status: [200]` 或其他非 ping expect 字段
+- **THEN** 系统 SHALL 以配置错误退出，提示 expect 包含未知字段
+
+#### Scenario: maxPacketLoss 类型非法
+- **WHEN** YAML 中 ping target 的 `expect.maxPacketLoss` 不是 0 到 100 之间的数字
+- **THEN** 系统 SHALL 以配置错误退出，提示 expect.maxPacketLoss 必须为 0-100 的数字
+
+#### Scenario: maxAvgLatencyMs 类型非法
+- **WHEN** YAML 中 ping target 的 `expect.maxAvgLatencyMs` 不是非负有限数字
+- **THEN** 系统 SHALL 以配置错误退出，提示 expect.maxAvgLatencyMs 格式错误
+
+#### Scenario: maxMaxLatencyMs 类型非法
+- **WHEN** YAML 中 ping target 的 `expect.maxMaxLatencyMs` 不是非负有限数字
+- **THEN** 系统 SHALL 以配置错误退出，提示 expect.maxMaxLatencyMs 格式错误
+
+### Requirement: ping statusDetail 摘要
+系统 SHALL 在 ping 执行成功后生成结构化 statusDetail 摘要，展示关键指标。
+
+#### Scenario: 目标可达无丢包
+- **WHEN** ping 结果为 alive=true, avg=12ms, packetLoss=0%, transmitted=3, received=3
+- **THEN** statusDetail SHALL 为 `alive, avg 12ms, loss 0% (3/3)`
+
+#### Scenario: 目标可达有丢包
+- **WHEN** ping 结果为 alive=true, avg=156ms, max=340ms, packetLoss=33%, transmitted=3, received=2
+- **THEN** statusDetail SHALL 包含 avg、max 和 loss 信息
+
+#### Scenario: 目标不可达
+- **WHEN** ping 结果为 alive=false, transmitted=3, received=0
+- **THEN** statusDetail SHALL 为 `unreachable (0/3 received)`
--- a/openspec/changes/add-icmp-checker/specs/probe-config/spec.md
+++ b/openspec/changes/add-icmp-checker/specs/probe-config/spec.md
@@ -0,0 +1,38 @@
+## MODIFIED Requirements
+
+### Requirement: YAML 配置文件格式
+系统 SHALL 支持通过 YAML 配置文件定义全部运行参数，包括 server 配置、runtime 配置、可选的 variables 段、checker 默认值和 typed target 列表（含可选 group 字段）。target MUST 使用 `id` 字段作为唯一标识符，MUST 使用 `type` 字段声明 checker 类型，SHALL 支持可选的 `name` 字段作为展示名称元信息，SHALL 支持可选的 `description` 字段作为目标说明。`name` 和 `description` 均 SHALL 允许省略或显式配置为 `null`；省略或显式 null 时解析结果 SHALL 保留为 null。HTTP 领域字段 MUST 放在 `http` 分组，cmd 领域字段 MUST 放在 `cmd` 分组，db 领域字段 MUST 放在 `db` 分组，tcp 领域字段 MUST 放在 `tcp` 分组，ping 领域字段 MUST 放在 `ping` 分组。HTTP target 的 `http` 分组 SHALL 支持可选的 `ignoreSSL`（布尔值）和 `maxRedirects`（非负整数）字段。Db target 的 `db` 分组 SHALL 支持 `url`（必填）和 `query`（可选）字段。Tcp target 的 `tcp` 分组 SHALL 支持 `host`（必填）、`port`（必填）、`readBanner`（可选）、`bannerReadTimeout`（可选）和 `maxBannerBytes`（可选）字段。Ping target 的 `ping` 分组 SHALL 支持 `host`（必填）、`count`（可选，默认 3）和 `packetSize`（可选，默认 56）字段。
+
+`defaults.http` 分组 SHALL 仅支持 `headers`（可选）和 `maxBodyBytes`（可选）字段。`defaults.http` 分组 MUST NOT 支持 `method` 字段。`defaults.tcp` 分组 SHALL 仅支持 `bannerReadTimeout`（可选）和 `maxBannerBytes`（可选）字段。
+
+#### Scenario: 最简 ping 配置文件解析
+- **WHEN** 系统读取只包含一个 `type: ping` target（含 `id` 和 `ping.host`）的 YAML 配置文件
+- **THEN** 系统 SHALL 使用内置默认值填充未指定的字段（interval=30s, timeout=10s, group="default", ping.count=3, ping.packetSize=56），并保留 name=null、description=null
+
+### Requirement: 配置校验
+系统 SHALL 在启动时对 YAML 配置进行完整校验，校验失败时以非零状态退出并输出清晰的错误信息。系统 SHALL 使用 TypeBox 定义配置契约和 raw config TypeScript 类型，由 Ajv 校验 TypeBox 生成的 JSON Schema，再执行启动期语义 validator。配置加载流程 SHALL 明确区分 `RawProbeConfig`、`ValidatedProbeConfig`、`ResolvedConfig` 三段生命周期，并在 YAML 解析之后、AJV 校验之前执行变量替换阶段。JSON Schema 契约 SHALL 覆盖业务无关的结构规则，包括字段类型、必填字段、枚举、数组与对象形状、数值范围和未知字段。语义 validator SHALL 覆盖契约不适合表达的业务规则，包括 target id 唯一性、id 命名规则校验、checker type 注册状态、时长和大小解析、HTTP URL、正则可编译、JSONPath 子集和 XPath 可编译。
+
+契约校验和语义 validator SHALL 统一产出 `ConfigValidationIssue`，最终由配置加载流程统一渲染为中文错误信息。
+
+系统 SHALL 导出完整 `probe-config.schema.json`，该文件 SHALL 与运行期 TypeBox fragments 生成的 JSON Schema 保持一致，用于用户配置引用和编辑器提示。
+
+除 `headers`、`env`、`variables` 等明确声明为动态键值表的对象外，配置中的未知字段 SHALL 导致启动期配置错误。系统 MUST NOT 静默忽略未知字段。
+
+#### Scenario: ping target 缺少 host
+- **WHEN** YAML 中某个 target 配置 `type: ping` 但缺少 `ping.host`
+- **THEN** 系统 SHALL 以错误退出，提示该 target 缺少 ping.host 字段
+
+#### Scenario: ping expect 未知字段
+- **WHEN** YAML 中 ping target 的 expect 包含非 ping expect 字段
+- **THEN** 系统 SHALL 以配置错误退出，提示 expect 包含未知字段
+
+### Requirement: expect 配置增强
+系统 SHALL 支持 typed target 的领域专用 expect 配置，包括 HTTP 的 `status`（支持精确数字和范围模式）、`headers`、`body`，cmd 的 `exitCode`、`stdout`、`stderr`，tcp 的 `connected`、`banner`，以及 ping 的 `alive`、`maxPacketLoss`、`maxAvgLatencyMs`、`maxMaxLatencyMs`。内容类 expect MUST 使用数组表达配置顺序。
+
+#### Scenario: 解析 ping expect 配置
+- **WHEN** YAML 配置文件中 ping target 的 expect 包含 alive、maxPacketLoss、maxAvgLatencyMs、maxMaxLatencyMs 和 maxDurationMs
+- **THEN** 系统 SHALL 正确解析并存储为 ping target 的 expect 字段
+
+#### Scenario: 不配置 ping expect
+- **WHEN** ping target 未配置任何 expect 规则
+- **THEN** 系统 SHALL 正常处理，expect 字段为 undefined，执行时使用默认 alive=true 语义