feat: add new lua-resty-events as events implementation #10550

bzp2010 · 2023-11-27T06:23:01Z

Description

Provide lua-resty-events as a new implementation of the event system. It experimentally provides better performance and efficiency.
fix #10431

Checklist

I have explained the need for this PR and the problem it solves
I have explained the changes or the new features added to this PR
I have added tests corresponding to this change
I have updated the documentation to reflect this change
I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

Sn0rt · 2023-12-08T04:07:32Z

ci/centos7-ci.sh

@@ -41,11 +41,15 @@ install_dependencies() {
    # install openresty to make apisix's rpm test work
    yum install -y yum-utils && yum-config-manager --add-repo https://openresty.org/package/centos/openresty.repo
    wget "https://raw.githubusercontent.com/api7/apisix-build-tools/apisix-runtime/${APISIX_RUNTIME}/build-apisix-runtime-debug-centos7.sh"
-    wget "https://raw.githubusercontent.com/api7/apisix-build-tools/apisix-runtime/${APISIX_RUNTIME}/build-apisix-runtime.sh"
+    #wget "https://raw.githubusercontent.com/api7/apisix-build-tools/apisix-runtime/${APISIX_RUNTIME}/build-apisix-runtime.sh"
+    wget https://raw.githubusercontent.com/Sn0rt/apisix-build-tools/guohao/update-lua-resty-events/build-apisix-runtime.sh


pls change this link

Sn0rt · 2023-12-08T04:08:29Z

ci/centos7-ci.sh

    chmod +x build-apisix-runtime-debug-centos7.sh
    chmod +x build-apisix-runtime.sh
    ./build-apisix-runtime-debug-centos7.sh

+    # patch lua-resty-events


why update this ?

It is impossible to execute a reload without a transient interruption because the worker that was handling the unix socket connection is being restarted, and the other workers will not be able to connect to the broker over the unix socket again until the new worker that replaces it is up and running, so the logs will be some error level logs about connection closed, which will interrupt our tests, so we'll have to change the code here to warn level.

There is no need to apply this patch in production as it has no impact other than causing some error logs, when the worker is available, the worker and broker will reconnect, and event push will be available again.

Sn0rt · 2023-12-08T07:44:03Z

ci/redhat-ci.sh

@@ -94,7 +100,7 @@ run_case() {
    make init
    set_coredns
    # run test cases
-    FLUSH_ETCD=1 prove --timer -Itest-nginx/lib -I./ -r ${TEST_FILE_SUB_DIR} | tee /tmp/test.result
+    FLUSH_ETCD=1 TEST_EVENTS_MODULE=lua-resty-worker-events prove --timer -Itest-nginx/lib -I./ -r ${TEST_FILE_SUB_DIR} | tee /tmp/test.result


I don’t quite understand this part. I see that the code already uses lua-resty-event as the default event library. Why do I need to specify this variable?

First, this is the same logic executed in the other test scripts, with the difference that under ubuntu we are executing the tests for both event modules at the same time, where an environment variable controlled by GitHub workflow is used as input.

You can see the header of some of the test cases, some of the tests are related to the events library and because of the implementation of the library they have slightly different behaviors, such as proactive health checks, which use different test cases under different events modules.

If an events module is not explicitly configured, it will default to the value in config-default, which is lua-resty-events, so simultaneous testing is not possible.

But it looks like some of the logic can be ported to APISIX.pm, and I'll be making that change.

Moved to lua-resty-events as the default test events module

Sn0rt · 2023-12-08T07:45:47Z

t/APISIX.pm

@@ -413,6 +413,11 @@ _EOC_

        require "resty.core"

+        local events_sock_path = "$apisix_home/t/servroot/logs/stream_worker_events.sock"
+        if os.getenv("TEST_NGINX_USE_HUP") ~= "1" then


Why does the test case using the HUP signal need to remove the sock, and other cases do not need to remove the unix sock?

Theoretically they will process properly, I can try. Maybe it's not necessary.

Removed, it can work.

Sn0rt · 2023-12-08T07:46:53Z

t/node/healthcheck-discovery.t

@@ -153,8 +156,6 @@ qr/(create new checker|try to release checker): table/
 create new checker: table
 try to release checker: table
 create new checker: table
--- no_error_log


Why should it be deleted?

This is the cost of the lua-resty-events library, whose events are asynchronous and delayed, so when the health checker is first created, the events are not communicated in a timely manner, so these error logs must appear.

They should have no impact because the main use of the test is to test that when the service discovers a change in the node provided, the new checker is created correctly rather than as a result of a health check.

If you are concerned about this, we will have to follow the example of the passive health check tests by listing them as separate test files and skipping them when they are not needed.

bzp2010 mentioned this pull request Nov 28, 2023

feat: create new event module for decouple logic and specific library #10558

Merged

5 tasks

feat: move to apisix.events

7aea90c

bzp2010 force-pushed the feat-new-events-queue branch from f366245 to 7aea90c Compare December 4, 2023 03:15

bzp2010 added 27 commits December 4, 2023 14:11

test env

692feb8

update ngx template

a1d9c28

fix

11d35ed

fix ci env

bbb2fc1

mock event list implementation

df17f01

test

ecee33b

test patch

dcdb282

fix call

3ca211f

revert global rule

0ee5494

revert fault injection

06701ea

fix rh based test

827ff8c

clean

14c0117

try fix multiple worker health check

10999fa

fix mismatched debug log

76dc27b

try force resty events

1f68994

remove no error log on healthcheck discovery

2cc1fbc

fix healthcheck case

ee50b1a

fix lint

bd8af2f

fix cli test

7cf568b

fix lint

b7549bc

fix lint

9e2e58f

fix lint

6ed090a

fix lint

1f3e632

fix lint

db2da3a

ensure consul finish health check

af3b366

test multiple events module in ubuntu

6ffc4ab

fix

8a93fed

bzp2010 added 5 commits December 7, 2023 10:52

fix lint

a4141d8

recover original passive health check

4a1424b

add new passive healthcheck case for lua-resty-events

0e97a95

fix typo

b215d35

increase wait time

ec6ffc7

bzp2010 requested a review from monkeyDluffy6017 December 8, 2023 01:59

bzp2010 marked this pull request as ready for review December 8, 2023 01:59

Sn0rt reviewed Dec 8, 2023

View reviewed changes

bzp2010 added 2 commits December 8, 2023 12:43

rollback apisix runtime build script

87ede50

move to apisix-build-tools master

b772ff3

Sn0rt reviewed Dec 8, 2023

View reviewed changes

test new lib on centos and ubi

8955d39

Sn0rt reviewed Dec 8, 2023

View reviewed changes

bzp2010 added 3 commits December 8, 2023 16:18

clean

fa97305

clean

ac50b44

test clean

a3cdf11

bzp2010 requested a review from Sn0rt December 8, 2023 09:53

bzp2010 added 4 commits December 8, 2023 20:36

add default events module for test

7119cb1

test old lib in legacy os

2c20df4

fix healthcheck

8b4282e

fix healthcheck

b45bb9b

monkeyDluffy6017 approved these changes Dec 13, 2023

View reviewed changes

monkeyDluffy6017 added the approved label Dec 13, 2023

Sn0rt approved these changes Dec 13, 2023

View reviewed changes

moonming approved these changes Dec 14, 2023

View reviewed changes

moonming merged commit 553ac42 into apache:master Dec 14, 2023
41 of 42 checks passed

Vacant2333 mentioned this pull request Dec 21, 2023

bug: apisix doesn't work, 'resty.events.compat' not found #10684

Closed

bzp2010 mentioned this pull request Dec 29, 2023

chore: move events sock path to conf #10732

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add new lua-resty-events as events implementation #10550

feat: add new lua-resty-events as events implementation #10550

bzp2010 commented Nov 27, 2023 •

edited by moonming

Loading

Sn0rt Dec 8, 2023

bzp2010 Dec 8, 2023

Sn0rt Dec 8, 2023

bzp2010 Dec 8, 2023

Sn0rt Dec 8, 2023

Sn0rt Dec 8, 2023

bzp2010 Dec 8, 2023

bzp2010 Dec 8, 2023 •

edited

Loading

Sn0rt Dec 8, 2023

bzp2010 Dec 8, 2023

bzp2010 Dec 8, 2023

Sn0rt Dec 8, 2023

bzp2010 Dec 8, 2023

bzp2010 Dec 8, 2023

feat: add new lua-resty-events as events implementation #10550

feat: add new lua-resty-events as events implementation #10550

Conversation

bzp2010 commented Nov 27, 2023 • edited by moonming Loading

Description

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bzp2010 Dec 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bzp2010 commented Nov 27, 2023 •

edited by moonming

Loading

bzp2010 Dec 8, 2023 •

edited

Loading