membphis commented on a change in pull request #2339: URL: https://github.com/apache/apisix/pull/2339#discussion_r502718278
########## File path: doc/plugins/api-breaker.md ########## @@ -0,0 +1,102 @@ +<!-- +# +# 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. +# +--> + +- [中文](../zh-cn/plugins/api-blocker.md) + +# Summary + +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable**](#how-to-enable) +- [**Test Plugin**](#test-plugin) +- [**Disable Plugin**](#disable-plugin) + +## Name + +The plugin implements API fuse functionality to help us protect our upstream business services. + +## Attributes + +| Name | Type | Requirement | Default | Valid | Description | +| ------------- | ------------- | ----------- | ------- | ---------- | --------------------------------------------------------------------------- | +| unhealthy_response_code | integer | required | | [200, ..., 600] | return error code when unhealthy | +| unhealthy.http_statuses | array[integer] | optional | {500} | [500, ..., 599] | Status codes when unhealthy | +| unhealthy.failures | integer | optional | 1 | >=1 | Number of consecutive error requests that triggered an unhealthy state | +| healthy.http_statuses | array[integer] | optional | {200, 206} | [200, ..., 499] | Status codes when healthy | +| successes.successes | integer | optional | 1 | >=1 | Number of consecutive normal requests that trigger health status | + +## How To Enable + +Here's an example, enable the `api-breaker` plugin on the specified route: + +```shell +curl "http://127.0.0.1:9080/apisix/admin/routes/5"; -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' + { + "plugins": { + "api-breaker": { + "unhealthy_response_code": 502, + "unhealthy": { + "http_statuses": [500, 503], + "failures": 3 + }, + "healthy": { + "http_statuses": [200], + "successes": 1 + } + } + }, + "uri": "/get", Review comment: bad indentation ########## File path: doc/plugins/api-breaker.md ########## @@ -0,0 +1,102 @@ +<!-- +# +# 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. +# +--> + +- [中文](../zh-cn/plugins/api-blocker.md) + +# Summary + +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable**](#how-to-enable) +- [**Test Plugin**](#test-plugin) +- [**Disable Plugin**](#disable-plugin) + +## Name + +The plugin implements API fuse functionality to help us protect our upstream business services. + +## Attributes + +| Name | Type | Requirement | Default | Valid | Description | +| ------------- | ------------- | ----------- | ------- | ---------- | --------------------------------------------------------------------------- | +| unhealthy_response_code | integer | required | | [200, ..., 600] | return error code when unhealthy | +| unhealthy.http_statuses | array[integer] | optional | {500} | [500, ..., 599] | Status codes when unhealthy | +| unhealthy.failures | integer | optional | 1 | >=1 | Number of consecutive error requests that triggered an unhealthy state | +| healthy.http_statuses | array[integer] | optional | {200, 206} | [200, ..., 499] | Status codes when healthy | +| successes.successes | integer | optional | 1 | >=1 | Number of consecutive normal requests that trigger health status | + +## How To Enable + +Here's an example, enable the `api-breaker` plugin on the specified route: + +```shell +curl "http://127.0.0.1:9080/apisix/admin/routes/5"; -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' + { + "plugins": { + "api-breaker": { + "unhealthy_response_code": 502, + "unhealthy": { + "http_statuses": [500, 503], + "failures": 3 + }, + "healthy": { + "http_statuses": [200], + "successes": 1 + } + } + }, + "uri": "/get", + "host": "127.0.0.1", + "upstream_id": 50 + }' +``` + +## Test Plugin + +```shell Review comment: we should provide two examples, a healthy response and an unhealthy response. ########## File path: apisix/plugins/api-breaker.lua ########## @@ -0,0 +1,214 @@ +-- +-- 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 = 300 + +local shared_buffer = ngx.shared['plugin-'.. plugin_name] +if not shared_buffer then + error("failed to get ngx.shared dict when load plugin " .. plugin_name) +end + + +local schema = { + type = "object", + properties = { + unhealthy_response_code = { + type = "integer", + minimum = 200, + maximum = 599, + }, + unhealthy = { + type = "object", + properties = { + 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", + properties = { + 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_status) + for _, unhealthy in ipairs(unhealthy_status) do + if unhealthy == upstream_status then + return true + end + end + + return false +end + + +local function is_healthy(healthy_status, upstream_status) + for _, healthy in ipairs(healthy_status) do + if healthy == upstream_status 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("failed to get unhealthy_cache_key in ngx.shared:", err) + end + + local unhealthy_lastime, err = shared_buffer:get(unhealthy_lastime_cache_key(ctx)) + if err then + core.log.error("failed to get unhealthy_lastime_cache_key in ngx.shared: ", 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 + + -- The maximum intercept request is 5 minutes(DEFAULT_EXPTIME), + -- and then the upstream service will be retry. + 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_status = core.response.get_upstream_status(ctx) + + if is_unhealthy(unhealthy_status, upstream_status) then + local newval, err = shared_buffer:incr(unhealthy_key, 1, 0, DEFAULT_EXPTIME) + if err then + core.log.error("failed to incr unhealthy_key in ngx.shared: ", 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), ngx.time(), DEFAULT_EXPTIME) Review comment: do we have any test case to cover this logic? ########## 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.") +end + + +local schema = { + type = "object", + properties = { + unhealthy_response_code = { + type = "integer", + minimum = 200, + maximum = 599, + }, + unhealthy = { + type = "object", + properties = { + 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", + properties = { + 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 Review comment: @liuhengloveyou we need to write this into the doc, the user needs to know it. ########## File path: apisix/plugins/api-breaker.lua ########## @@ -0,0 +1,214 @@ +-- +-- 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 = 300 + +local shared_buffer = ngx.shared['plugin-'.. plugin_name] +if not shared_buffer then + error("failed to get ngx.shared dict when load plugin " .. plugin_name) +end + + +local schema = { + type = "object", + properties = { + unhealthy_response_code = { + type = "integer", + minimum = 200, + maximum = 599, + }, + unhealthy = { + type = "object", + properties = { + 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", + properties = { + 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_status) + for _, unhealthy in ipairs(unhealthy_status) do + if unhealthy == upstream_status then + return true + end + end + + return false +end + + +local function is_healthy(healthy_status, upstream_status) + for _, healthy in ipairs(healthy_status) do + if healthy == upstream_status 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("failed to get unhealthy_cache_key in ngx.shared:", err) + end + + local unhealthy_lastime, err = shared_buffer:get(unhealthy_lastime_cache_key(ctx)) + if err then + core.log.error("failed to get unhealthy_lastime_cache_key in ngx.shared: ", 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 + + -- The maximum intercept request is 5 minutes(DEFAULT_EXPTIME), + -- and then the upstream service will be retry. + 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_status = core.response.get_upstream_status(ctx) + + if is_unhealthy(unhealthy_status, upstream_status) then Review comment: code style: ``` -- bad style if xxx then ... elseif then ... end ``` ``` -- good style if xxx then ... return end if xxx then ... return end ``` ---------------------------------------------------------------- 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: [email protected]
