Fault injection plugin, this plugin can be used with other plugins and will be executed before other plugins. The abort
attribute will directly return the user-specified http code to the client and terminate the subsequent plugins. The delay
attribute will delay a request and execute subsequent plugins.
Name | Type | Requirement | Default | Valid | Description |
---|---|---|---|---|---|
abort.http_status | integer | required | [200, ...] | user-specified http code returned to the client. | |
abort.body | string | optional | response data returned to the client. Nginx variable can be used inside, like client addr: $remote_addr\n | ||
abort.percentage | integer | optional | [0, 100] | percentage of requests to be aborted. | |
abort.vars | array[] | optional | The rules for executing fault injection will only be executed when the rules are matched. vars is a list of expressions, which is from the lua-resty-expr. | ||
delay.duration | number | required | delay time (can be decimal). | ||
delay.percentage | integer | optional | [0, 100] | percentage of requests to be delayed. | |
delay.vars | array[] | optional | Execute the request delay rule, and the request will be delayed only after the rule matches. vars is a list of expressions, which is from the lua-resty-expr. |
Note: One of abort
and delay
must be specified.
The vars
is a list of expression which is from the lua-resty-expr
, which can flexibly implement the and/or
relationship between rules. Example:
[ [ [ "arg_name","==","jack" ], [ "arg_age","==",18 ] ], [ [ "arg_name2","==","allen" ] ] ]
This means that the relationship between the first two expressions is and
, and the relationship between the first two expressions and the third expression is or
.
1: enable the fault-injection plugin for a specific route and specify the abort attribute:
curl http://127.0.0.1:9080/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" }'
Test plugin:
$ 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 is 200 and the response body is "Fault Injection! " indicate that the plugin is enabled.
2: Enable the fault-injection
plugin for a specific route and specify the delay
attribute:
curl http://127.0.0.1:9080/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" }'
Test plugin:
$ 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
Example 3: Enable the fault-injection
plugin for a specific route and specify the vars rule of the abort parameter.
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "plugins": { "fault-injection": { "abort": { "http_status": 403, "body": "Fault Injection!\n", "vars": [ [ [ "arg_name","==","jack" ] ] ] } } }, "upstream": { "nodes": { "127.0.0.1:1980": 1 }, "type": "roundrobin" }, "uri": "/hello" }'
Test plugin:
$ curl "http://127.0.0.1:9080/hello?name=allen" -i HTTP/1.1 200 OK Content-Type: application/octet-stream Transfer-Encoding: chunked Connection: keep-alive Date: Wed, 20 Jan 2021 07:21:57 GMT Server: APISIX/2.2 hello
$ curl "http://127.0.0.1:9080/hello?name=jack" -i HTTP/1.1 403 Forbidden Date: Wed, 20 Jan 2021 07:23:37 GMT Content-Type: text/plain; charset=utf-8 Transfer-Encoding: chunked Connection: keep-alive Server: APISIX/2.2 Fault Injection!
Example 4: Enable the fault-injection
plugin for a specific route and specify the vars rule for the delay parameter.
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "plugins": { "fault-injection": { "delay": { "duration": 2, "vars": [ [ [ "arg_name","==","jack" ] ] ] } } }, "upstream": { "nodes": { "127.0.0.1:1980": 1 }, "type": "roundrobin" }, "uri": "/hello" }'
Test plugin:
$ time curl "http://127.0.0.1:9080/hello?name=allen" -i HTTP/1.1 200 OK Content-Type: application/octet-stream Transfer-Encoding: chunked Connection: keep-alive Date: Wed, 20 Jan 2021 07:26:17 GMT Server: APISIX/2.2 hello real 0m0.007s user 0m0.003s sys 0m0.003s
$ time curl "http://127.0.0.1:9080/hello?name=jack" -i HTTP/1.1 200 OK Content-Type: application/octet-stream Transfer-Encoding: chunked Connection: keep-alive Date: Wed, 20 Jan 2021 07:57:50 GMT Server: APISIX/2.2 hello real 0m2.009s user 0m0.004s sys 0m0.004s
Example 5: Enable the fault-injection
plugin for a specific route, and specify the vars rules for the abort and delay parameters.
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "plugins": { "fault-injection": { "abort": { "http_status": 403, "body": "Fault Injection!\n", "vars": [ [ [ "arg_name","==","jack" ] ] ] }, "delay": { "duration": 2, "vars": [ [ [ "http_age","==","18" ] ] ] } } }, "upstream": { "nodes": { "127.0.0.1:1980": 1 }, "type": "roundrobin" }, "uri": "/hello" }'
Test plugin:
$ time curl "http://127.0.0.1:9080/hello?name=allen" -H 'age: 20' -i HTTP/1.1 200 OK Content-Type: application/octet-stream Transfer-Encoding: chunked Connection: keep-alive Date: Wed, 20 Jan 2021 08:01:43 GMT Server: APISIX/2.2 hello real 0m0.007s user 0m0.003s sys 0m0.003s
$ time curl "http://127.0.0.1:9080/hello?name=allen" -H 'age: 18' -i HTTP/1.1 200 OK Content-Type: application/octet-stream Transfer-Encoding: chunked Connection: keep-alive Date: Wed, 20 Jan 2021 08:19:03 GMT Server: APISIX/2.2 hello real 0m2.009s user 0m0.001s sys 0m0.006s
$ time curl "http://127.0.0.1:9080/hello?name=jack" -H 'age: 20' -i HTTP/1.1 403 Forbidden Date: Wed, 20 Jan 2021 08:20:18 GMT Content-Type: text/plain; charset=utf-8 Transfer-Encoding: chunked Connection: keep-alive Server: APISIX/2.2 Fault Injection! real 0m0.007s user 0m0.002s sys 0m0.004s
$ time curl "http://127.0.0.1:9080/hello?name=jack" -H 'age: 18' -i HTTP/1.1 403 Forbidden Date: Wed, 20 Jan 2021 08:21:17 GMT Content-Type: text/plain; charset=utf-8 Transfer-Encoding: chunked Connection: keep-alive Server: APISIX/2.2 Fault Injection! real 0m2.006s user 0m0.001s sys 0m0.005s
Example 6: Enable the fault-injection
plugin for a specific route, and specify the vars rule of the abort parameter (the relationship of or
).
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "plugins": { "fault-injection": { "abort": { "http_status": 403, "body": "Fault Injection!\n", "vars": [ [ ["arg_name","==","jack"], ["arg_age","!","<",18] ], [ ["http_apikey","==","apisix-key"] ] ] } } }, "upstream": { "nodes": { "127.0.0.1:1980": 1 }, "type": "roundrobin" }, "uri": "/hello" }'
Indicates that when the request parameters name and age satisfy both name == "jack"
and age >= 18
, fault injection is performed. Or when the request header apikey satisfies apikey == "apisix-key"
, fault injection is performed.
Test plugin:
apikey
is missing, and fault injection is performed:$ curl "http://127.0.0.1:9080/hello?name=jack&age=19" -i HTTP/1.1 403 Forbidden Date: Fri, 22 Jan 2021 11:05:46 GMT Content-Type: text/plain; charset=utf-8 Transfer-Encoding: chunked Connection: keep-alive Server: APISIX/2.2 Fault Injection!
apikey
is successfully matched, and the request parameters are missing, and fault injection is performed:$ curl http://127.0.0.1:9080/hello -H "apikey: apisix-key" -i HTTP/1.1 403 Forbidden Date: Fri, 22 Jan 2021 11:08:34 GMT Content-Type: text/plain; charset=utf-8 Transfer-Encoding: chunked Connection: keep-alive Server: APISIX/2.2 Fault Injection!
$ curl http://127.0.0.1:9080/hello -i HTTP/1.1 200 OK Content-Type: application/octet-stream Transfer-Encoding: chunked Connection: keep-alive Date: Fri, 22 Jan 2021 11:11:17 GMT Server: APISIX/2.2 hello
Remove the corresponding JSON in the plugin configuration to disable the plugin immediately without restarting the service:
curl http://127.0.0.1:9080/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 } } }'
The plugin has been disabled now.