This is an automated email from the ASF dual-hosted git repository.
ashishtiwari pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new ce05ddb8b feat: support traffic split plugin for stream routes (#12630)
ce05ddb8b is described below
commit ce05ddb8be1616a0ff2b52985ac00c551a90ed2e
Author: Ashish Tiwari <[email protected]>
AuthorDate: Tue Sep 30 11:59:39 2025 +0530
feat: support traffic split plugin for stream routes (#12630)
---
apisix/cli/config.lua | 2 +-
apisix/stream/plugins/traffic-split.lua | 38 +++++
t/stream-plugin/traffic-split.t | 246 ++++++++++++++++++++++++++++++++
3 files changed, 285 insertions(+), 1 deletion(-)
diff --git a/apisix/cli/config.lua b/apisix/cli/config.lua
index 0b9a23198..35212eea7 100644
--- a/apisix/cli/config.lua
+++ b/apisix/cli/config.lua
@@ -289,7 +289,7 @@ local _M = {
"ext-plugin-post-resp",
"ai-request-rewrite",
},
- stream_plugins = { "ip-restriction", "limit-conn", "mqtt-proxy", "syslog" },
+ stream_plugins = { "ip-restriction", "limit-conn", "mqtt-proxy", "syslog",
"traffic-split" },
plugin_attr = {
["log-rotate"] = {
timeout = 10000,
diff --git a/apisix/stream/plugins/traffic-split.lua
b/apisix/stream/plugins/traffic-split.lua
new file mode 100644
index 000000000..c2940b75d
--- /dev/null
+++ b/apisix/stream/plugins/traffic-split.lua
@@ -0,0 +1,38 @@
+-- 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 traffic_split = require("apisix.plugins.traffic-split")
+local log = require("apisix.core.log")
+
+
+local plugin_name = "traffic-split"
+
+local _M = {
+ version = 0.1,
+ priority = 966,
+ name = plugin_name,
+ schema = traffic_split.schema,
+}
+_M.check_schema = traffic_split.check_schema
+
+function _M.preread(conf, ctx)
+ local status, err = traffic_split.access(conf, ctx)
+ if err then
+ log.error(err)
+ end
+ return status
+end
+
+return _M
diff --git a/t/stream-plugin/traffic-split.t b/t/stream-plugin/traffic-split.t
new file mode 100644
index 000000000..d0a864643
--- /dev/null
+++ b/t/stream-plugin/traffic-split.t
@@ -0,0 +1,246 @@
+#
+# 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';
+
+repeat_each(1);
+no_long_string();
+no_shuffle();
+no_root_location();
+
+add_block_preprocessor(sub {
+ my ($block) = @_;
+
+ if (!$block->error_log && !$block->no_error_log) {
+ $block->set_value("no_error_log", "[error]\n[alert]");
+ }
+
+ my $config = $block->config // <<_EOC_;
+ location /hit {
+ content_by_lua_block {
+ local sock = ngx.socket.tcp()
+ local ok, err = sock:connect("127.0.0.1", 1985)
+ if not ok then
+ ngx.log(ngx.ERR, "failed to connect: ", err)
+ return ngx.exit(503)
+ end
+
+ local bytes, err = sock:send("mmm")
+ if not bytes then
+ ngx.log(ngx.ERR, "send stream request error: ", err)
+ return ngx.exit(503)
+ end
+ local data, err = sock:receive("*a")
+ if not data then
+ sock:close()
+ return ngx.exit(503)
+ end
+ ngx.print(data)
+ }
+ }
+
+ location /test_multiple_requests {
+ content_by_lua_block {
+ local reqs = {}
+ for i = 1, 10 do
+ reqs[i] = { "/hit" }
+ end
+ local resps = { ngx.location.capture_multi(reqs) }
+ for i, resp in ipairs(resps) do
+ ngx.say(resp.body)
+ end
+ }
+ }
+_EOC_
+
+ $block->set_value("config", $config);
+
+ my $stream_upstream_code = $block->stream_upstream_code // <<_EOC_;
+ local sock = ngx.req.socket()
+ local data = sock:receive("1")
+ ngx.say("hello world from port " .. ngx.var.server_port)
+_EOC_
+ $block->set_value("stream_upstream_code", $stream_upstream_code);
+});
+
+run_tests;
+
+__DATA__
+
+=== TEST 1: set stream route with traffic-split plugin (basic weighted
upstreams)
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/stream_routes/1',
+ ngx.HTTP_PUT,
+ [[{
+ "plugins": {
+ "traffic-split": {
+ "rules": [{
+ "weighted_upstreams": [
+ {
+ "upstream": {
+ "name": "upstream_A",
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1995": 1
+ }
+ },
+ "weight": 9
+ },
+ {
+ "upstream": {
+ "name": "upstream_B",
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1996": 1
+ }
+ },
+ "weight": 1
+ }
+ ]
+ }]
+ }
+ }
+ }]]
+ )
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- request
+GET /t
+--- response_body
+passed
+
+
+
+=== TEST 2: traffic split distribution between two upstreams
+--- request
+GET /test_multiple_requests
+--- response_body_like
+hello world from port 1995
+
+hello world from port 1995
+
+hello world from port 1995
+
+hello world from port 1995
+
+hello world from port 1995
+
+hello world from port 1995
+
+hello world from port 1995
+
+hello world from port 1995
+
+
+hello world from port 1995
+--- stream_enable
+--- error_log
+Connection refused
+
+
+
+=== TEST 3: set stream route with traffic-split using default route upstream
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/upstreams/1',
+ ngx.HTTP_PUT,
+ [[{
+ "nodes": {
+ "127.0.0.1:1997": 1
+ },
+ "type": "roundrobin"
+ }]]
+ )
+ if code >= 300 then
+ ngx.status = code
+ ngx.say(body)
+ return
+ end
+
+ local code, body = t('/apisix/admin/stream_routes/2',
+ ngx.HTTP_PUT,
+ [[{
+ "plugins": {
+ "traffic-split": {
+ "rules": [{
+ "weighted_upstreams": [
+ {
+ "upstream": {
+ "name": "upstream_A",
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1995": 1
+ }
+ },
+ "weight": 9
+ },
+ {
+ "weight": 1
+ }
+ ]
+ }]
+ }
+ },
+ "upstream_id": "1"
+ }]]
+ )
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+--- request
+GET /t
+--- response_body
+passed
+
+
+
+=== TEST 4: traffic split between plugin upstream and default route upstream
+--- request
+GET /test_multiple_requests
+--- response_body_like
+hello world from port 1995
+
+hello world from port 1995
+
+hello world from port 1995
+
+hello world from port 1995
+
+hello world from port 1995
+
+hello world from port 1995
+
+hello world from port 1995
+
+hello world from port 1995
+
+
+hello world from port 1995
+--- stream_enable
+--- error_log
+Connection refused
