故障注入插件,该插件可以和其他插件一起使用,并且会在其他插件前被执行,配置 abort
参数将直接返回给客户端指定的响应码并且终止其他插件的执行,配置 delay
参数将延迟某个请求,并且还会执行配置的其他插件。
名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
---|---|---|---|---|---|
abort.http_status | integer | 可选 | [200, ...] | 返回给客户端的 http 状态码 | |
abort.body | string | 可选 | 返回给客户端的响应数据 | ||
abort.percentage | integer | 可选 | [0, 100] | 将被中断的请求占比 | |
delay.duration | number | 可选 | 延迟时间,可以指定小数 | ||
delay.percentage | integer | 可选 | [0, 100] | 将被延迟的请求占比 |
注:参数 abort 和 delay 至少要存在一个。
示例1:为特定路由启用 fault-injection
插件,并指定 abort
参数:
curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "plugins": { "fault-injection": { "abort": { "http_status": 200, "body": "Fault Injection!" } } }, "upstream": { "nodes": { "127.0.0.1:1980": 1 }, "type": "roundrobin" }, "uri": "/hello" }'
测试:
$ curl http://127.0.0.1:9080/hello -i HTTP/1.1 200 OK Date: Mon, 13 Jan 2020 13:50:04 GMT Content-Type: text/plain Transfer-Encoding: chunked Connection: keep-alive Server: APISIX web server Fault Injection!
http status 返回
200
并且响应body
为Fault Injection!
,表示该插件已启用。
示例2:为特定路由启用 fault-injection
插件,并指定 delay
参数:
curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "plugins": { "fault-injection": { "delay": { "duration": 3 } } }, "upstream": { "nodes": { "127.0.0.1:1980": 1 }, "type": "roundrobin" }, "uri": "/hello" }'
测试:
$ time curl http://127.0.0.1:9080/hello -i HTTP/1.1 200 OK Content-Type: application/octet-stream Content-Length: 6 Connection: keep-alive Server: APISIX web server Date: Tue, 14 Jan 2020 14:30:54 GMT Last-Modified: Sat, 11 Jan 2020 12:46:21 GMT hello real 0m3.034s user 0m0.007s sys 0m0.010s
移除插件配置中相应的 JSON 配置可立即禁用该插件,无需重启服务:
curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "uri": "/hello", "plugins": {}, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } } }'
这时该插件已被禁用。