feat: Implement traffic splitting plugin #2935

Firstsawyou · 2020-12-02T16:53:11Z

What this PR does / why we need it:

Implement a traffic splitting plugin, the plugin is named traffic-split. The main function of the plug-in is to divide the request traffic according to the specified ratio and divert it to the corresponding "upstream". The functions of Gray release, Blue-green release and Custom release can be realized through this plugin.

Related issue：
https://github.com/apache/apisix/issues/2303

https://github.com/apache/apisix/issues/2603

Mailing list discussion address:
https://lists.apache.org/thread.html/rf02dc53a4af5d98d2513d89256b47466934d129af06d0bdcdb49cc8e%40%3Cdev.apisix.apache.org%3E

Pre-submission checklist:

Did you explain what problem does this PR solve? Or what new features have been added?
Have you added corresponding test cases?
Have you modified the corresponding document?
Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

moonming · 2020-12-03T00:32:13Z

Please write a better title and desc

tokers · 2020-12-03T02:33:09Z

@Firstsawyou CI failed, please fix it.

Firstsawyou · 2020-12-03T02:43:31Z

@spacewander @membphis @tokers
Help me take a look at this test case: https://github.com/apache/apisix/pull/2935/files#diff-1badbb10ecfbb255409af122651c06a0b308ba0d51e672180d4e78719dce7e88R128. When executing this test case, the following error message is prompted:

nginx: [emerg] Lua code block missing the closing long bracket "]=]" in /home/runner/work/apisix/apisix/t/servroot/conf/nginx.conf:148
nginx: [emerg] Lua code block missing the closing long bracket "]=]" in /home/runner/work/apisix/apisix/t/servroot/conf/nginx.conf:148
nginx: [emerg] Lua code block missing the closing long bracket "]=]" in /home/runner/work/apisix/apisix/t/servroot/conf/nginx.conf:148

I don't know what caused this.

moonming · 2020-12-03T05:58:16Z

@Firstsawyou What is the name of this plugin? the PR title and code file are not the same.

Firstsawyou · 2020-12-03T06:06:24Z

@Firstsawyou What is the name of this plugin? the PR title and code file are not the same.

updated.

moonming · 2020-12-03T06:12:33Z

@Firstsawyou What is the name of this plugin? the PR title and code file are not the same.

updated.

Not yet , please read your desc again

membphis · 2020-12-03T06:23:30Z

t/plugin/dynamic-upstream.t

+=== TEST 5: Multiple vars rules and multiple plugin upstream
+--- config
+    location /t {
+        content_by_lua_block {


Reduce the total code length in content_by_lua_block

Thank you very much, I will try.

tokers · 2020-12-03T06:33:04Z

We should use traffic split instead dynamic-upstream, in the future, the traffic split plugin will provide the labels based selector to choose nodes inside a upstream, this function is not covered by the name dynamic-upstream, which gives us an illusion this plugin is used for choosing one upstream from multiple upstreams.

Firstsawyou · 2020-12-03T07:37:59Z

We should use traffic split instead dynamic-upstream, in the future, the traffic split plugin will provide the labels based selector to choose nodes inside a upstream, this function is not covered by the name dynamic-upstream, which gives us an illusion this plugin is used for choosing one upstream from multiple upstreams.

Ok i will update later.

Firstsawyou · 2020-12-06T17:13:06Z

There was a problem when this pr handled the conflict. A related pr has been newly submitted.

moonming · 2020-12-07T00:11:18Z

No, please fix it in this PR

doc/plugins/traffic-split.md

apisix/plugins/traffic-split.lua

tokers · 2020-12-09T09:29:49Z

@Firstsawyou Could you paste some sample traffic split configurations here to help us understand the schema better.

apisix/plugins/traffic-split.lua

tokers · 2020-12-09T09:39:04Z

@Firstsawyou Please resolve the conflicts.

apisix/plugins/traffic-split.lua

doc/plugins/traffic-split.md

Firstsawyou · 2020-12-09T15:06:27Z

@Firstsawyou Could you paste some sample traffic split configurations here to help us understand the schema better.

@tokers These are two cases, which will help you understand：

Grayscale Release

Traffic is split according to the weight value configured by upstreams in the plugin (the rule of match is not configured, and match is passed by default). The request traffic is divided into 4:2, 2/3 of the traffic reaches the upstream of the 1981 port in the plugin, and 1/3 of the traffic reaches the upstream of the default 1980 port on the route.

{
    "weight": 2
}

There is only a weight value in the plugin upstreams, which represents the weight value of the upstream traffic arriving on the route.

curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "uri": "/index.html",
    "plugins": {
        "traffic-split": {
            "rules": [
                {
                    "upstreams": [
                        {
                            "upstream": {
                                "name": "upstream_A",
                                "type": "roundrobin",
                                "nodes": {
                                    "127.0.0.1:1981":10
                                },
                                "timeout": {
                                    "connect": 15,
                                    "send": 15,
                                    "read": 15
                                }
                            },
                            "weight": 4
                        },
                        {
                            "weight": 2
                        }
                    ]
                }
            ]
        }
    },
    "upstream": {
            "type": "roundrobin",
            "nodes": {
                "127.0.0.1:1980": 1
            }
    }
}'

Custom Release

Multiple matching rules can be set in match (multiple conditions in vars are the relationship of add, and the relationship between multiple vars rules is the relationship of or; as long as one of the vars rules passes, it means match passed), only one is configured here, and the traffic is divided into 4:2 according to the value of weight. Among them, only the weight part represents the proportion of upstream on the route. When match fails to match, all traffic will only hit upstream on the route.

curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "uri": "/index.html",
    "plugins": {
        "traffic-split": {
            "rules": [
                {
                    "match": [
                        {
                            "vars": [
                                ["arg_name","==","jack"],
                                ["http_user-id",">","23"],
                                ["http_apisix-key","~~","[a-z]+"]
                            ]
                        }
                    ],
                    "upstreams": [
                        {
                            "upstream": {
                                "name": "upstream_A",
                                "type": "roundrobin",
                                "nodes": {
                                    "127.0.0.1:1981":10
                                }
                            },
                            "weight": 4
                        },
                        {
                            "weight": 2
                        }
                    ]
                }
            ]
        }
    },
    "upstream": {
            "type": "roundrobin",
            "nodes": {
                "127.0.0.1:1980": 1
            }
    }
}'

t/plugin/traffic-split.t

doc/README.md

doc/plugins/traffic-split.md

doc/zh-cn/plugins/traffic-split.md

doc/plugins/traffic-split.md

doc/zh-cn/plugins/traffic-split.md

doc/plugins/traffic-split.md

juzhiyuan · 2023-05-06T06:13:24Z

doc/plugins/traffic-split.md

+                                ["http_user-id",">","23"],
+                                ["http_apisix-key","~~","[a-z]+"]


This should not work :(

Firstsawyou changed the title ~~feat: traffic split plugin.~~ feat: Implement traffic splitting plugin Dec 3, 2020

Firstsawyou changed the title ~~feat: Implement traffic splitting plugin~~ feat: Implement dynamic-upstream plugin Dec 3, 2020

membphis reviewed Dec 3, 2020

View reviewed changes

Firstsawyou changed the title ~~feat: Implement dynamic-upstream plugin~~ feat: Implement traffic splitting plugin Dec 4, 2020

Firstsawyou closed this Dec 6, 2020

Firstsawyou reopened this Dec 7, 2020

Firstsawyou force-pushed the dynamic-upstream-plugin branch 3 times, most recently from 6d88ccb to f11e9b2 Compare December 7, 2020 08:36

Firstsawyou marked this pull request as ready for review December 7, 2020 09:08

spacewander requested changes Dec 7, 2020

View reviewed changes

tokers approved these changes Dec 9, 2020

View reviewed changes

apisix/plugins/traffic-split.lua Outdated Show resolved Hide resolved

apisix/plugins/traffic-split.lua Show resolved Hide resolved

apisix/plugins/traffic-split.lua Show resolved Hide resolved

apisix/plugins/traffic-split.lua Show resolved Hide resolved

tokers self-requested a review December 9, 2020 09:39

tokers reviewed Dec 9, 2020

View reviewed changes

apisix/plugins/traffic-split.lua Outdated Show resolved Hide resolved

tokers self-requested a review December 9, 2020 09:46

spacewander reviewed Dec 9, 2020

View reviewed changes

doc/plugins/traffic-split.md Outdated Show resolved Hide resolved

spacewander approved these changes Dec 9, 2020

View reviewed changes

Firstsawyou added 3 commits December 24, 2020 19:54

add more test case and update schema field.

84399e8

update test case.

80683f5

update code style and doc

f752da8

Firstsawyou requested review from spacewander and tokers December 24, 2020 13:02

spacewander reviewed Dec 24, 2020

View reviewed changes

t/plugin/traffic-split.t Outdated Show resolved Hide resolved

update test.

9fa9ded

Firstsawyou requested review from spacewander, moonming and membphis December 24, 2020 13:12

spacewander approved these changes Dec 24, 2020

View reviewed changes

moonming added this to the 2.2 milestone Dec 24, 2020

moonming requested changes Dec 24, 2020

View reviewed changes

Firstsawyou added 3 commits December 25, 2020 01:46

refactored plugin docs.

f819400

update plugin docs.

2e9dde5

fix doc typo.

ce0abab

Firstsawyou requested a review from moonming December 25, 2020 00:44

moonming requested changes Dec 25, 2020

View reviewed changes

doc/plugins/traffic-split.md Outdated Show resolved Hide resolved

doc/plugins/traffic-split.md Outdated Show resolved Hide resolved

doc/zh-cn/plugins/traffic-split.md Outdated Show resolved Hide resolved

doc/zh-cn/plugins/traffic-split.md Outdated Show resolved Hide resolved

update docs.

cc550e0

Firstsawyou requested a review from moonming December 25, 2020 03:33

update doc note content.

2dca214

tokers reviewed Dec 25, 2020

View reviewed changes

doc/plugins/traffic-split.md Outdated Show resolved Hide resolved

doc/plugins/traffic-split.md Outdated Show resolved Hide resolved

update docs title.

6f6263b

Firstsawyou requested a review from tokers December 25, 2020 06:07

in docs add how to enable content.

237a4e1

tokers approved these changes Dec 25, 2020

View reviewed changes

moonming approved these changes Dec 25, 2020

View reviewed changes

spacewander merged commit 86fa46d into apache:master Dec 25, 2020

gxthrj mentioned this pull request Jan 4, 2021

Support ingress-nginx Canary ? apache/apisix-ingress-controller#13

Closed

juzhiyuan reviewed May 6, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Implement traffic splitting plugin #2935

feat: Implement traffic splitting plugin #2935

Firstsawyou commented Dec 2, 2020 •

edited

Loading

moonming commented Dec 3, 2020

tokers commented Dec 3, 2020

Firstsawyou commented Dec 3, 2020 •

edited

Loading

moonming commented Dec 3, 2020

Firstsawyou commented Dec 3, 2020

moonming commented Dec 3, 2020

membphis Dec 3, 2020

Firstsawyou Dec 3, 2020

tokers commented Dec 3, 2020 •

edited

Loading

Firstsawyou commented Dec 3, 2020

Firstsawyou commented Dec 6, 2020

moonming commented Dec 7, 2020

tokers commented Dec 9, 2020

tokers commented Dec 9, 2020

Firstsawyou commented Dec 9, 2020

juzhiyuan May 6, 2023

feat: Implement traffic splitting plugin #2935

feat: Implement traffic splitting plugin #2935

Conversation

Firstsawyou commented Dec 2, 2020 • edited Loading

What this PR does / why we need it:

Pre-submission checklist:

moonming commented Dec 3, 2020

tokers commented Dec 3, 2020

Firstsawyou commented Dec 3, 2020 • edited Loading

moonming commented Dec 3, 2020

Firstsawyou commented Dec 3, 2020

moonming commented Dec 3, 2020

membphis Dec 3, 2020

Choose a reason for hiding this comment

Firstsawyou Dec 3, 2020

Choose a reason for hiding this comment

tokers commented Dec 3, 2020 • edited Loading

Firstsawyou commented Dec 3, 2020

Firstsawyou commented Dec 6, 2020

moonming commented Dec 7, 2020

tokers commented Dec 9, 2020

tokers commented Dec 9, 2020

Firstsawyou commented Dec 9, 2020

Grayscale Release

Custom Release

juzhiyuan May 6, 2023

Choose a reason for hiding this comment

Firstsawyou commented Dec 2, 2020 •

edited

Loading

Firstsawyou commented Dec 3, 2020 •

edited

Loading

tokers commented Dec 3, 2020 •

edited

Loading