You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2020/10/06 13:39:07 UTC
[GitHub] [apisix] membphis commented on a change in pull request #2339: feature: breaker request by api
membphis commented on a change in pull request #2339:
URL: https://github.com/apache/apisix/pull/2339#discussion_r500282768
##########
File path: t/plugin/api-breaker.t
##########
@@ -0,0 +1,219 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+use t::APISIX 'no_plan';
+
+$ENV{TEST_NGINX_HTML_DIR} ||= html_dir();
+
+repeat_each(1);
+no_long_string();
+no_shuffle();
+no_root_location();
+log_level('info');
+run_tests;
+
+__DATA__
+
+=== TEST 1: sanity
+--- config
+ location /t {
+ content_by_lua_block {
+ local plugin = require("apisix.plugins.api-breaker")
+ local ok, err = plugin.check_schema({
+ unhealthy_response_code = 502,
+ unhealthy = {
+ http_statuses = {500},
+ failures = 1,
+ },
+ healthy = {
+ http_statuses = {200},
+ successes = 1,
+ },
+ })
+ if not ok then
+ ngx.say(err)
+ end
+
+ ngx.say("done")
+ }
+ }
+--- request
+GET /t
+--- response_body
+done
+--- no_error_log
+[error]
+
+
+=== TEST 2: default http_statuses
+--- config
+ location /t {
+ content_by_lua_block {
+ local plugin = require("apisix.plugins.api-breaker")
+ local ok, err = plugin.check_schema({
+ unhealthy_response_code = 502,
+ unhealthy = {
+ failures = 1,
+ },
+ healthy = {
+ successes = 1,
+ },
+ })
+ if not ok then
+ ngx.say(err)
+ end
+
+ ngx.say("done")
+ }
+ }
+--- request
+GET /t
+--- response_body
+done
+--- no_error_log
+[error]
+
+
+=== TEST 3: add plugin
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PUT,
+ [[{
+ "plugins": {
+ "api-breaker": {
+ "unhealthy_response_code": 502,
+ "unhealthy": {
+ "http_statuses": [500, 503],
+ "failures": 3
+ },
+ "healthy": {
+ "http_statuses": [200, 206],
+ "successes": 3
+ }
+ }
+ },
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1988": 1
+ },
+ "type": "roundrobin"
+ },
+ "uri": "/hello"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- request
+GET /t
+--- response_body
+passed
+--- no_error_log
+[error]
+
+
+=== TEST 4: trigger breaker
+--- request eval
+["GET /hello?r=200", "GET /hello?r=500", "GET /hello?r=503", "GET /hello?r=500", "GET /hello?r=500", "GET /hello?r=500"]
+--- error_code eval
+[200, 500, 503, 500, 502, 502]
+--- no_error_log
+[error]
+
+
+=== TEST 5: trigger reset status
+--- request eval
+["GET /hello?r=500", "GET /hello?r=500", "GET /hello?r=200", "GET /hello?r=200", "GET /hello?r=200", "GET /hello?r=500", "GET /hello?r=500"]
+--- error_code eval
+[500, 500, 200, 200, 200, 500, 500]
+--- no_error_log
+[error]
+
+
+=== TEST 6: trigger del healthy numeration
+--- request eval
+["GET /hello?r=500", "GET /hello?r=200", "GET /hello?r=500", "GET /hello?r=500", "GET /hello?r=500", "GET /hello?r=500", "GET /hello?r=500"]
+--- error_code eval
+[500, 200, 500, 500, 502, 502, 502]
+--- no_error_log
+[error]
+
+
+=== TEST 7: add plugin with default config value
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PUT,
+ [[{
+ "plugins": {
+ "api-breaker": {
+ "unhealthy_response_code": 502,
+ "unhealthy": {
+ "failures": 3
+ },
+ "healthy": {
+ "successes": 3
+ }
+ }
+ },
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1988": 1
+ },
+ "type": "roundrobin"
+ },
+ "uri": "/test"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- request
+GET /t
+--- response_body
+passed
+--- no_error_log
+[error]
+
+
+=== TEST 8: default value
+--- request
+GET /test?r=500
+--- error_code: 500
+--- no_error_log
+[error]
+
+
+=== TEST 9: trigger default value breaker
+--- request eval
+["GET /test?r=200", "GET /test?r=500", "GET /test?r=503", "GET /test?r=500", "GET /test?r=500", "GET /test?r=500"]
+--- error_code eval
+[200, 500, 503, 500, 500, 502]
+--- no_error_log
+[error]
Review comment:
style: need a blank line at the end of file
##########
File path: apisix/plugins/api-breaker.lua
##########
@@ -0,0 +1,208 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements. See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License. You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+local plugin_name = "api-breaker"
+local ngx = ngx
+local math = math
+local ipairs = ipairs
+local error = error
+local core = require("apisix.core")
+
+local DEFAULT_EXPTIME = 600
+
+local shared_buffer = ngx.shared['plugin-'.. plugin_name]
+if not shared_buffer then
+ error("get ngx.shared dict error.")
+end
+
+
+local schema = {
+ type = "object",
+ properties = {
+ unhealthy_response_code = {
+ type = "integer",
+ minimum = 200,
+ maximum = 599,
+ },
+ unhealthy = {
+ type = "object",
+ http_statuses = {
+ type = "array",
+ minItems = 1,
+ items = {
+ type = "integer",
+ minimum = 500,
+ maximum = 599,
+ },
+ uniqueItems = true,
+ default = {500}
+ },
+ failures = {
+ type = "integer",
+ minimum = 1,
+ default = 1,
+ },
+ },
+ healthy = {
+ type = "object",
+ http_statuses = {
+ type = "array",
+ minItems = 1,
+ items = {
+ type = "integer",
+ minimum = 200,
+ maximum = 499,
+ },
+ uniqueItems = true,
+ default = {200, 206}
+ },
+ successes = {
+ type = "integer",
+ minimum = 1,
+ default = 1,
+ }
+ }
+ },
+ required = {"unhealthy_response_code", "unhealthy", "healthy"},
+}
+
+
+local function is_unhealthy(unhealthy_status, upstream_statu)
+ for _, unhealthy in ipairs(unhealthy_status) do
+ if unhealthy == upstream_statu then
+ return true
+ end
+ end
+
+ return false
+end
+
+
+local function is_healthy(healthy_status, upstream_statu)
+ for _, healthy in ipairs(healthy_status) do
+ if healthy == upstream_statu then
+ return true
+ end
+ end
+
+ return false
+end
+
+
+local function healthy_cache_key(ctx)
+ return "healthy-" .. core.request.get_host(ctx) .. ctx.var.uri
+end
+
+
+local function unhealthy_cache_key(ctx)
+ return "unhealthy-" .. core.request.get_host(ctx) .. ctx.var.uri
+end
+
+
+local function unhealthy_lastime_cache_key(ctx)
+ return "unhealthy-lastime" .. core.request.get_host(ctx) .. ctx.var.uri
+end
+
+
+local _M = {
+ version = 0.1,
+ name = plugin_name,
+ priority = 1005,
+ schema = schema,
+}
+
+
+function _M.check_schema(conf)
+ local ok, err = core.schema.check(schema, conf)
+ if not ok then
+ return false, err
+ end
+
+ return true
+end
+
+
+function _M.access(conf, ctx)
+ local unhealthy_val, err = shared_buffer:get(unhealthy_cache_key(ctx))
+ if err then
+ core.log.error("ngx.shared get error", err)
+ end
+
+ local unhealthy_lastime, err = shared_buffer:get(unhealthy_lastime_cache_key(ctx))
+ if err then
+ core.log.error("ngx.shared get error", err)
+ end
+
+ if unhealthy_val and unhealthy_lastime then
+ local ride = math.ceil(unhealthy_val / conf.unhealthy.failures)
+ if ride < 1 then
+ ride = 1
+ end
+
+ if unhealthy_lastime + 2^ride >= ngx.time() then
+ return conf.unhealthy_response_code
+ end
+ end
+end
+
+
+function _M.header_filter(conf, ctx)
+ local unhealthy_status = conf.unhealthy.http_statuses
+ local healthy_status = conf.healthy.http_statuses
+
+ local unhealthy_key = unhealthy_cache_key(ctx)
+ local healthy_key = healthy_cache_key(ctx)
+
+ local upstream_statu = core.response.get_upstream_status(ctx)
+
+ if is_unhealthy(unhealthy_status, upstream_statu) then
+ local newval, err = shared_buffer:incr(unhealthy_key, 1, 0, DEFAULT_EXPTIME)
+ if err then
+ core.log.error("ngx.shared incr error", err)
+ end
+ shared_buffer:expire(unhealthy_key, DEFAULT_EXPTIME)
+ shared_buffer:delete(healthy_key) -- del healthy numeration
+
+ if 0 == newval % conf.unhealthy.failures then
+ shared_buffer:set(unhealthy_lastime_cache_key(ctx), os.time(), DEFAULT_EXPTIME)
Review comment:
@liuhengloveyou still not fix
##########
File path: apisix/plugins/api-breaker.lua
##########
@@ -0,0 +1,212 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements. See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License. You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+local plugin_name = "api-breaker"
+local ngx = ngx
+local math = math
+local ipairs = ipairs
+local error = error
+local core = require("apisix.core")
+
+local DEFAULT_EXPTIME = 600
+
+local shared_buffer = ngx.shared['plugin-'.. plugin_name]
+if not shared_buffer then
+ error("get ngx.shared dict error.")
Review comment:
This error message is not friendly.
If it fails, the user needs to use the latest `bin/apisix`. @liuhengloveyou
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org