Skip to content

检测服务状态拦截器

功能介绍 💡

WARNING

检测服务状态拦截器用于验证网关服务是否正常运行,通过请求接口并验证返回结果来确认服务状态。

应用场景

  • ✓ 服务健康检查
  • ✓ 存活状态监控
  • ✓ 负载均衡探测
  • ✓ 容器健康探针

配置说明 ⚙️

基础配置参数

参数名类型必填默认值说明
enabledbooleanfalse是否启用拦截器
itemsarray-检测规则列表

检测规则配置 (items)

参数名类型必填说明
urlsarray需要检测的接口地址列表
resultstring期望的返回结果字符串

TIP

URL匹配规则详见 URL匹配规则说明

配置示例 📝

基础配置

yaml
wueasy:
  gateway:
    filter:
      check:
        enabled: true #是否启用
        items:
        - urls: 
          - /demo/check #检测接口地址
          result: ok #期望返回结果

多接口检测

yaml
wueasy:
  gateway:
    filter:
      check:
        enabled: true
        items:
        - urls: 
          - /demo/check
          - /demo/health
          result: ok
        - urls:
          - /demo/status
          result: running

使用建议 💡

  1. 检测接口设计

    • 接口响应要快速
    • 返回结果要简单
    • 避免复杂业务逻辑
  2. 配置建议

    • 合理设置检测地址
    • 使用简单的返回值
    • 配置多个检测点

注意事项 ⚠️

  1. 检测接口应避免需要认证
  2. 返回结果区分大小写
  3. 检测地址要确保可访问
  4. 避免过于频繁的检测

常见问题 ❓

检测失败

  • 检查接口是否可访问
  • 验证返回结果是否匹配
  • 确认网络连接正常

响应超时

  • 检查接口性能
  • 确认服务器负载
  • 验证网络状态