API健康检查:监控并诊断API端点 - Openclaw Skills

作者:互联网

2026-04-14

AI教程

什么是 API健康检查?

API健康检查(API Health Check)技能是一项技术实用工具,旨在为开发者提供Web服务状态和性能的实时见解。通过将标准网络诊断集成到智能体工作流中,它可以快速验证端点可用性、响应时间和负载大小。无论您是在调试微服务还是验证外部依赖项,该技能都为您在Openclaw Skills生态系统中进行基础设施监控提供了一种结构化方法。

该技能不仅提供简单的Ping操作,还针对失败的请求提供深度诊断。它会自动分析DNS解析、端口可访问性和SSL证书有效性,以精准定位服务中断的确切原因。凭借SSRF预防和Header掩码等内置安全功能,它确保您的监控任务既安全又符合最佳实践。

下载入口:https://github.com/openclaw/skills/tree/main/skills/sa9saq/api-health-check

安装与下载

1. ClawHub CLI

从源直接安装技能的最快方式。

npx clawhub@latest install api-health-check

2. 手动安装

将技能文件夹复制到以下位置之一

全局模式 ~/.openclaw/skills/ 工作区 /skills/

优先级:工作区 > 本地 > 内置

3. 提示词安装

将此提示词复制到 OpenClaw 即可自动安装。

请帮我使用 Clawhub 安装 api-health-check。如果尚未安装 Clawhub,请先安装(npm i -g clawhub)。

API健康检查 应用场景

  • 在部署或基础设施变更后验证服务可用性。
  • 通过监控各个端点的总请求时间来识别性能瓶颈。
  • 排查与DNS配置错误或SSL证书过期相关的连接故障。
  • 使用Openclaw Skills界面自动监控内部和外部API。
  • 主动检查多个基础URL的常见健康路径,如 /healthz 或 /status。
API健康检查 工作原理
  1. 智能体从用户处接收一个URL或端点列表。
  2. 如果提供了基础URL,该技能会自动探测常见的健康检查路径。
  3. 它执行一系列curl命令来捕获HTTP状态码和精准的时间指标。
  4. 结果根据性能阈值分为不同颜色的状态:健康(Healthy)、缓慢(Slow)或宕机(Down)。
  5. 对于任何无响应的端点,该技能会触发dig和nc等二级诊断工具来调查网络层。
  6. 生成详细的摘要表,提供API状况的清晰概览。

API健康检查 配置指南

API健康检查技能依赖于标准系统工具。请确保您的环境中安装了以下工具:

# 检查所需工具
curl --version
dig -v
nc -h

将此技能作为Openclaw Skills库的一部分开始使用时,无需复杂的配置或API密钥。

API健康检查 数据架构与分类体系

该技能将结果组织成结构化格式,以便于分析和报告。输出包括:

字段 描述
Endpoint 被监控的目标URL
Status 服务器返回的HTTP响应状态码
Time (ms) 请求花费的总时间(毫秒)
Verdict 状态判定(健康、缓慢或宕机)
Diagnostics 如果主请求失败,则提供来自DNS或SSL检查的补充数据
description: Monitor API endpoints, measure response times, and diagnose connectivity issues.

API Health Check

Monitor API endpoints and diagnose connectivity issues.

Instructions

  1. Accept endpoint URLs from the user. If a single base URL is given, check common paths: /, /health, /healthz, /api/status, /ping.
  2. For each endpoint, run:
    curl -s -o /dev/null -w "HTTP %{http_code} | %{time_total}s | %{size_download}B" -m 10 
    
  3. Classify results:
    • ?? Healthy — 2xx, <1s
    • ?? Slow — 2xx, >1s
    • ?? Down — Non-2xx, timeout, or connection refused
  4. Present summary table:
    | Endpoint | Status | Time (ms) | Verdict |
    |----------|--------|-----------|---------|
    | /health  | 200    | 142       | ??      |
    
  5. For failed endpoints, diagnose:
    • DNS resolution: dig +short
    • Port connectivity: nc -zw3
    • SSL issues: curl -vI https://... 2>&1 | grep -i ssl
  6. For repeated monitoring: watch -n curl -s -o /dev/null -w "%{http_code}"

Security

  • Never log or display auth tokens in output — mask as Bearer ****
  • Accept custom headers via user input, but redact them in reports
  • SSRF prevention: Reject requests to private/internal IPs (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, 169.254.0.0/16, 127.0.0.0/8) unless the user explicitly confirms the target is intentional (e.g., homelab monitoring)

Edge Cases

  • Self-signed SSL: Use curl -k only if user explicitly approves
  • Redirects: Use curl -L to follow; report redirect chain
  • IPv6: Test both A and AAAA if DNS returns both
  • Rate limiting: Space requests with 1s delay if checking many endpoints

Requirements

  • curl (pre-installed on most systems)
  • Optional: dig, nc for deeper diagnostics
  • No API keys needed

相关推荐