Skip to content

🔍 接口检测指南

📖 功能介绍

TIP

接口检测功能提供一个轻量级的健康检查接口,用于验证服务是否正常运行。这对于服务监控、负载均衡和容器编排等场景非常有用。

⚙️ 配置说明

基础配置

yaml
wueasy: 
  check: 
    enabled: true  # 启用健康检查接口
参数说明默认值可选值
enabled是否启用检测接口falsetrue/false

🚀 使用示例

接口调用

http
GET http://ip:port/check

响应说明

  • 正常响应:ok
  • 异常响应:无响应或超时

💡 最佳实践

  1. 监控配置

    • 建议配置定期检测
    • 设置合理的超时时间
    • 配置失败告警机制
  2. 使用场景

    • 服务健康监控
    • 容器存活检查
    • 负载均衡检测
    • 自动故障转移
  3. 注意事项

    • 避免过于频繁的检测
    • 合理设置检测超时时间
    • 考虑添加访问控制

🔧 集成示例

Kubernetes 配置

yaml
livenessProbe:
  httpGet:
    path: /check
    port: 8080
  initialDelaySeconds: 30
  periodSeconds: 10

Nginx 配置

nginx
location /check {
    proxy_pass http://backend/check;
    proxy_connect_timeout 2s;
    proxy_read_timeout 2s;
}

📊 监控建议

  1. 监控指标

    • 响应时间
    • 可用性统计
    • 故障记录
  2. 告警策略

    • 连续失败次数
    • 响应时间阈值
    • 可用性下降

🔍 故障排查

  1. 服务无响应

    • 检查服务进程状态
    • 验证网络连通性
    • 查看服务日志
  2. 响应异常

    • 检查服务负载
    • 验证配置是否正确
    • 查看系统资源使用情况