断点配置使用指南 ✨

功能介绍 💡

WARNING

断点（Breakpoint）是一种高效的服务治理策略，它能够:

• 智能拦截和处理服务请求与响应
• 实时监控和记录关键参数信息
• 快速定位和分析系统问题
• 支持动态配置和实时生效

通过断点机制，开发人员可以更好地掌控服务流程，提升问题排查效率。

配置说明 ⚙️

基础配置参数

参数名	类型	必填	默认值	说明
enabled	boolean	否	false	是否启用断点
breakpoint-server-url	string	是	-	断点服务器地址
rules	array[object]	是	-	规则列表

灰度规则配置 (rules)

参数名	类型	必填	说明
urls	array[string]	是	URL规则列表，用于区分不同系统的规则
rule-types	array[object]	否	规则类型配置

规则类型说明 (rule-types)

参数名	类型	必填	说明
type	string	是	验证类型
data	string	是	验证数据,支持正则表达式
field-name	string	否	需要处理的字段名称,header类型时需要指定

验证类型说明 (type)

类型	说明	示例值
authorization	基于令牌判断	token-xxx
ip	基于IP地址判断	192.168.1.*
merchant	基于商户判断	merchant-001
header	基于请求头判断	custom-header

TIP

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

配置示例 📝

基础配置

WARNING

rule-types：不配置默认是全部匹配

gateway:
  filter:
    breakpoint:
      enabled: true
      breakpoint-server-url: http://127.0.0.1:9888
      # breakpoint-server-url: lb://web1  # 负载均衡方式调用自定义接口
      rules:
        - urls:
            - /**

多规则配置

gateway:
  filter:
    breakpoint:
      enabled: true
      breakpoint-server-url: http://127.0.0.1:9888
      rules:
        - urls: 
            - /api/**
          rule-types:
            - type: ip
              data: 192.168.1.*
        - urls: 
            - /admin/**
          rule-types:
            - type: header
              field-name: x-gray-flag
              data: test