断路器插件说明
概述
断路器是ROMA Connect在后端服务出现性能问题时保护系统的内置机制。当API的后端服务出现连续N次超时或者时延较高的情况下，会触发断路器的降级机制，向API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后，断路器关闭，请求恢复正常。
配置参数说明
|
参数 |
配置说明 |
|---|---|
|
共享API生效 |
开启后，所有绑定到当前插件的API共同计算断路器触发次数。 |
|
断路器类型 |
选择断路器的触发类型。
|
|
条件模式 |
选择断路器的触发模式。
|
|
匹配条件 |
仅当“断路器类型”选择“匹配条件降级”时需配置。 配置断路器的触发条件。
|
|
时间窗 |
断路器的触发次数统计时间窗，与“阈值”或“最小百分比”参数配合使用，当时间窗内的触发次数达到设定阈值或百分比，则触发断路器。 |
|
阈值 |
仅当“条件模式”选择“计数器”时需配置。 断路器的触发阈值，与“时间窗”参数配合使用。当时间窗内的满足触发条件的后端请求次数达到阈值，则触发断路器。
说明：
断路器插件是按单个网关组件分开触发，若ROMA Connect存在多个网关组件，则各个网关组件的触发统计分开计数。 若某个网关组件在时间窗内的触发次数超过阈值，则发送到该网关组件上的请求会触发断路器，其他未超过阈值的网关组件依然正常转发请求。 您可以在ROMA Connect实例控制台的“实例信息”页面，在“连接地址”下查看网关组件的IP个数，一个IP表示为一个网关组件。 |
|
最小调用次数 |
仅当“条件模式”选择“百分比”时需配置。 时间窗内触发断路器的API最小调用次数。如果时间窗内API的总调用次数小于该值，则不触发断路器 |
|
最小百分比 |
仅当“条件模式”选择“百分比”时需配置。 断路器的触发阈值，与“时间窗”参数配合使用。当时间窗内的满足触发条件的后端请求百分比达到阈值，则触发断路器。 |
|
开启时长 |
断路器开启的持续时间，断路器开启时间达到该值后将关闭。 |
|
后端降级策略 |
后端降级策略开关。
|
|
后端策略类型 |
仅当“后端降级策略”开启时需配置。 断路器开启后，后端请求的转发策略类型。
|
|
降级参数配置 |
降级参数配置开关。开启后可为断路器自定义规则，API请求优先匹配自定义规则中的触发条件和降级策略，仅当未匹配到自定义规则时才执行上方配置的默认触发条件和降级策略。
|
|
定义参数 |
定义用于规则匹配的参数。
系统默认包含reqPath（请求路径）和method（请求方法）参数。单击“添加参数”，可添加其他匹配参数。 |
|
定义规则 |
自定义断路器的匹配规则。单击“添加规则”，可添加规则，系统根据从上到下的顺序匹配规则，可通过上下移动调整规则优先级。
例如，开启“降级参数配置”，按顺序添加“rule01”和“rule02”规则，“rule01”关闭“触发条件配置”并且开启“后端降级策略”，“rule02”两者都开启。断路器优先判断“rule01”匹配条件，若匹配则会按照上方配置的默认触发条件开启断路器（rule01内未配置触发条件），并执行rule01内的后端降级策略。若不匹配则会继续判断“rule02”，以此类推。 |
脚本配置示例
{
"breaker_condition":{
"breaker_type":"timeout",
"breaker_mode":"counter",
"unhealthy_threshold":30,
"time_window":15,
"open_breaker_time":15,
"unhealthy_percentage":51,
"min_call_threshold":20
},
"scope":"share",
"downgrade_default":{
"type":"http",
"passthrough_infos":null,
"func_info":null,
"mock_info":null,
"http_info":{
"isVpc":false,
"vpc_channel_id":"",
"address":"10.10.10.10",
"scheme":"HTTP",
"method":"GET",
"path":"/demo",
"timeout":5000
},
"http_vpc_info":null
},
"downgrade_parameters":[
{
"name":"reqPath",
"type":"path",
"value":"path",
"disabled":true,
"focused":true,
"id":"92002eqbpilg6g"
},
{
"name":"method",
"type":"method",
"value":"method",
"disabled":true,
"focused":true,
"id":"tuvxetsdqvcos8"
}],
"downgrade_rules":[
{
"rule_name":"rule-test1",
"parameters":[
"reqPath",
"method"
],
"match_regex":"[\"reqPath\",\"==\",\"/test\"]",
"downgrade_backend":{
"type":"mock",
"passthrough_infos":null,
"func_info":null,
"mock_info":{
"status_code":200,
"result_content":"{status: ok}",
"headers":[]
},
"http_info":null,
"http_vpc_info":null
},
"breaker_condition":{
"breaker_type":"timeout",
"breaker_mode":"percentage",
"unhealthy_threshold":30,
"time_window":15,
"open_breaker_time":15,
"unhealthy_percentage":51,
"min_call_threshold":20
}
}]
}
