feature: add single server rate limit #6756

xjlgod · 2024-08-14T13:13:52Z

I have registered the PR changes.

Ⅰ. Describe what this PR did

Support flow limiting control for a single server：

Flow limiting components: Select Bucket4j components to implement flow limit control.
Processing flow limit control: Process flow limiting at the top level in DefaultCordinator, and perform flow limiting checks in the onRequest method. Only GlobalBegin request will be limited.
Transaction end identity: All transaction ends need to be able to correctly identify flow limit control and throw corresponding exceptions.
Metrics: Use a new metrics record events when current limiting is triggered

Ⅱ. Does this pull request fix one issue?

Ⅲ. Why don't you add test cases (unit test/integration test)?

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

# Conflicts: # common/src/main/java/org/apache/seata/common/ConfigurationKeys.java # server/pom.xml

…ture/flow-limit-xjl

codecov · 2024-08-24T15:54:44Z

Codecov Report

Attention: Patch coverage is 14.58333% with 164 lines in your changes missing coverage. Please review.

Project coverage is 52.47%. Comparing base (5b31862) to head (54d93dc).

Files with missing lines	Patch %	Lines
...ata/server/limit/ratelimit/RateLimiterHandler.java	9.09%	37 Missing and 3 partials ⚠️
...ata/server/limit/ratelimit/TokenBucketLimiter.java	36.95%	29 Missing ⚠️
...va/org/apache/seata/core/event/RateLimitEvent.java	0.00%	23 Missing ⚠️
...he/seata/server/limit/ratelimit/RateLimitInfo.java	0.00%	23 Missing ⚠️
...e/properties/server/ServerRateLimitProperties.java	7.69%	12 Missing ⚠️
...rver/limit/ratelimit/RateLimiterHandlerConfig.java	7.69%	12 Missing ⚠️
...ache/seata/server/limit/LimitRequestDecorator.java	0.00%	8 Missing ⚠️
...apache/seata/server/metrics/MetricsSubscriber.java	0.00%	6 Missing ⚠️
...erver/limit/AbstractTransactionRequestHandler.java	28.57%	5 Missing ⚠️
.../apache/seata/server/metrics/MetricsPublisher.java	0.00%	3 Missing ⚠️
... and 2 more

Additional details and impacted files

@@             Coverage Diff              @@
##                2.x    #6756      +/-   ##
============================================
- Coverage     52.66%   52.47%   -0.19%     
- Complexity     6688     6699      +11     
============================================
  Files          1132     1140       +8     
  Lines         40286    40477     +191     
  Branches       4724     4734      +10     
============================================
+ Hits          21215    21240      +25     
- Misses        17039    17201     +162     
- Partials       2032     2036       +4

Files with missing lines	Coverage Δ
...ava/org/apache/seata/common/ConfigurationKeys.java	`0.00% <ø> (ø)`
...in/java/org/apache/seata/common/DefaultValues.java	`0.00% <ø> (ø)`
...ava/io/seata/tm/api/DefaultFailureHandlerImpl.java	`64.86% <ø> (ø)`
...seata/core/exception/TransactionExceptionCode.java	`100.00% <ø> (ø)`
...handler/GlobalTransactionalInterceptorHandler.java	`29.68% <ø> (ø)`
...ga/engine/tm/DefaultSagaTransactionalTemplate.java	`61.76% <ø> (ø)`
...ta/spring/boot/autoconfigure/StarterConstants.java	`100.00% <ø> (ø)`
.../apache/seata/server/metrics/MeterIdConstants.java	`100.00% <100.00%> (ø)`
...configure/SeataServerEnvironmentPostProcessor.java	`0.00% <0.00%> (ø)`
...e/seata/server/coordinator/DefaultCoordinator.java	`42.31% <0.00%> (-0.14%)`	⬇️
... and 10 more

... and 1 file with indirect coverage changes

l81893521 · 2024-11-16T12:56:12Z

common/src/main/java/org/apache/seata/common/ConfigurationKeys.java

+    /**
+     * The constant RATE_LIMIT_BUCKET_TOKEN_SECOND_NUM.
+     */
+    String RATE_LIMIT_BUCKET_TOKEN_SECOND_NUM = RATE_LIMIT_PREFIX + "bucketTokenSecondNum";


bucketTokenNumPerSecond

l81893521

The rate limit has to immediate effect when it enable or change.

…ture/flow-limit-xjl

funky-eyes · 2024-12-23T01:49:14Z

compatible/src/main/java/io/seata/tm/api/DefaultFailureHandlerImpl.java

@@ -28,6 +26,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

+import java.util.concurrent.TimeUnit;


Suggested change

import java.util.concurrent.TimeUnit;

funky-eyes · 2024-12-23T01:49:23Z

compatible/src/main/java/io/seata/tm/api/DefaultFailureHandlerImpl.java

@@ -16,8 +16,6 @@
 */
 package io.seata.tm.api;

-import java.util.concurrent.TimeUnit;
-
 import io.netty.util.HashedWheelTimer;


Suggested change

import io.netty.util.HashedWheelTimer;

import java.util.concurrent.TimeUnit;

import io.netty.util.HashedWheelTimer;

funky-eyes · 2024-12-23T02:12:11Z

...ache/seata/integration/tx/api/interceptor/handler/GlobalTransactionalInterceptorHandler.java

+import java.lang.reflect.Method;
+import java.util.LinkedHashSet;
+import java.util.Set;
+import java.util.concurrent.ScheduledThreadPoolExecutor;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicBoolean;
+


Suggested change

import java.lang.reflect.Method;

import java.util.LinkedHashSet;

import java.util.Set;

import java.util.concurrent.ScheduledThreadPoolExecutor;

import java.util.concurrent.TimeUnit;

import java.util.concurrent.atomic.AtomicBoolean;

funky-eyes · 2024-12-23T02:12:24Z

...ache/seata/integration/tx/api/interceptor/handler/GlobalTransactionalInterceptorHandler.java

-import java.util.concurrent.ScheduledThreadPoolExecutor;
-import java.util.concurrent.TimeUnit;
-import java.util.concurrent.atomic.AtomicBoolean;
-
 import com.google.common.eventbus.Subscribe;


Suggested change

import com.google.common.eventbus.Subscribe;

import java.lang.reflect.Method;

import java.util.LinkedHashSet;

import java.util.Set;

import java.util.concurrent.ScheduledThreadPoolExecutor;

import java.util.concurrent.TimeUnit;

import java.util.concurrent.atomic.AtomicBoolean;

import com.google.common.eventbus.Subscribe;

funky-eyes · 2024-12-23T02:13:55Z

metrics/seata-metrics-api/src/main/java/org/apache/seata/metrics/IdConstants.java

+
+    String CLIENT_ID_KEY = "clientId";
+
+    String SERVER_IP_ADDRESS_AND_PORT_KEY = "serverIpAddressAndPort";


Isn't 'hostAndPort' more concise?

funky-eyes · 2024-12-23T02:14:48Z

script/config-center/config.txt

+server.ratelimit.bucketTokenMaxNum = 1
+server.ratelimit.bucketTokenInitialNum = 1



Some users may blindly copy this configuration, so it's better to set the threshold to a larger value

funky-eyes · 2024-12-23T02:15:16Z

server/src/main/java/org/apache/seata/server/coordinator/DefaultCoordinator.java

-import java.util.concurrent.ScheduledThreadPoolExecutor;
-import java.util.concurrent.ThreadPoolExecutor;
-import java.util.concurrent.TimeUnit;
-
 import io.netty.channel.Channel;


Suggested change

import io.netty.channel.Channel;

import java.util.ArrayList;

import java.util.Collection;

import java.util.Comparator;

import java.util.List;

import java.util.Map;

import java.util.Objects;

import java.util.concurrent.ArrayBlockingQueue;

import java.util.concurrent.ScheduledThreadPoolExecutor;

import java.util.concurrent.ThreadPoolExecutor;

import java.util.concurrent.TimeUnit;

import io.netty.channel.Channel;

funky-eyes · 2024-12-23T02:15:28Z

server/src/main/java/org/apache/seata/server/coordinator/DefaultCoordinator.java

+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Comparator;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.ArrayBlockingQueue;
+import java.util.concurrent.ScheduledThreadPoolExecutor;
+import java.util.concurrent.ThreadPoolExecutor;
+import java.util.concurrent.TimeUnit;


Suggested change

import java.util.ArrayList;

import java.util.Collection;

import java.util.Comparator;

import java.util.List;

import java.util.Map;

import java.util.Objects;

import java.util.concurrent.ArrayBlockingQueue;

import java.util.concurrent.ScheduledThreadPoolExecutor;

import java.util.concurrent.ThreadPoolExecutor;

import java.util.concurrent.TimeUnit;

xjlgod · 2024-12-24T04:14:01Z

The rate limit has to immediate effect when it enable or change.

Had added hot config.

funky-eyes · 2024-12-24T13:18:04Z

server/src/main/java/org/apache/seata/server/ratelimit/RateLimiterHandler.java

+                GlobalBeginResponse response = new GlobalBeginResponse();
+                response.setTransactionExceptionCode(TransactionExceptionCode.BeginFailed);
+                response.setResultCode(ResultCode.Failed);
+                RateLimitInfo rateLimitInfo = RateLimitInfo.generateRateLimitInfo(rpcContext.getApplicationId(),
+                        RateLimitInfo.GLOBAL_BEGIN_FAILED, rpcContext.getClientId(), XID.getIpAddressAndPort());
+                MetricsPublisher.postRateLimitEvent(rateLimitInfo);
+                response.setMsg(String.format("TransactionException[rate limit exception, rate limit info: %s]", rateLimitInfo));


限流器应该只是限流作用,为什么要跟业务逻辑耦合在一起?
The role of limited viewership should only be limited viewership, why should it be coupled with business logic?

funky-eyes · 2024-12-24T13:21:10Z

server/src/main/resources/file.conf

funky-eyes · 2024-12-24T13:22:53Z

server/src/main/java/org/apache/seata/server/ratelimit/RateLimiterHandler.java

+            return null;
+        }
+
+        if (request instanceof GlobalBeginRequest) {


为什么不使用MessageType来判断,未来是否限流器可以作用于更多的request?只要对外提供一个配置项,允许用户配置一个需要限流request的集合,这里只要判断MessageType是否包含在其中即可
Why not use MessageType to determine whether the limit viewership of requests can be used in the future? Just provide a configuration item to allow users to configure a collection that needs to limit viewership of requests. Here, just determine whether MessageType is included in it

这个当时是说的后面来优化，限流request的集合是指的比如是分支开始？如果是配置集合，我理解那就必须在客户端也看看是否做对应修改，以免不兼容？
This was the later optimization. Is the collection of current restriction Request refers to the start of the branch? If it is a configuration collection, you must also see the corresponding modification on the client, so as not to be incompatible?

…ture/flow-limit-xjl

funky-eyes

pr需要登记

funky-eyes · 2024-12-28T13:55:02Z

server/src/main/resources/application.example.yml

@@ -159,6 +159,11 @@ seata:
    session:
      branch-async-queue-size: 5000 #branch async remove queue size
      enable-branch-async-remove: false #enable to asynchronous remove branchSession
+    ratelimit:


默认值调大
Default value up

funky-eyes · 2024-12-28T13:55:07Z

server/src/main/resources/application.raft.example.yml

@@ -131,6 +131,11 @@ seata:
    session:
      branch-async-queue-size: 5000 #branch async remove queue size
      enable-branch-async-remove: false #enable to asynchronous remove branchSession
+    ratelimit:


默认值调大
Default value up

funky-eyes · 2024-12-28T13:56:04Z

server/src/main/java/org/apache/seata/server/limit/ratelimit/RateLimiterHandlerAbstract.java

+        if (ConfigurationKeys.RATE_LIMIT_BUCKET_TOKEN_INITIAL_NUM.equals(dataId)) {
+            config.setBucketTokenInitialNum(NumberUtils.toInt(newValue, config.getBucketTokenInitialNum()));
+        }
+        rateLimiter.reInit(config);


为什么不直接在TokenBucketLimiter中进行监听?
Why not listen directly in TokenBucketLimiter?

因为想的是ratelimithandler下面可以通过spi加载不同的限流器，然后具体的限流器重新加载由具体的限流器实现
By ratelimithandler, you can load different current limiter through spi, and then the specific current limiter reloads by the new config from Ratelimithandler

# Conflicts: # changes/en-us/2.x.md # changes/zh-cn/2.x.md # common/src/main/java/org/apache/seata/common/ConfigurationKeys.java

funky-eyes

LGTM

xjlgod and others added 13 commits August 14, 2024 20:50

feature: add single server rale limit

e67bbe3

Merge branch '2.x' into feature/flow-limit-xjl

850a8d1

# Conflicts: # common/src/main/java/org/apache/seata/common/ConfigurationKeys.java # server/pom.xml

Merge branch '2.x' into feature/flow-limit-xjl

33e574c

Merge branch '2.x' into feature/flow-limit-xjl

f5c2945

Merge branch '2.x' into feature/flow-limit-xjl

512bcb8

fix: fix RateLimitInfo

6a6abc5

Merge remote-tracking branch 'origin/feature/flow-limit-xjl' into fea…

3c11c5e

…ture/flow-limit-xjl

fix: fix ResultCodeTest

3a8a385

fix: fix TokenBucketLimiterTest

4f1731f

fix: fix pmd output

e62bc8f

fix: fix pmd output

60346cd

fix: fix pmd output

85e9101

fix: fix pmd

da1f952

slievrly self-requested a review August 31, 2024 14:51

Merge branch '2.x' into feature/flow-limit-xjl

c01b24f

slievrly added this to the 2.3.0 milestone Aug 31, 2024

funky-eyes added type: feature Category issues or prs related to feature request. module/server server module labels Sep 3, 2024

funky-eyes and others added 4 commits September 23, 2024 16:07

Merge branch '2.x' into feature/flow-limit-xjl

8c5b916

fix: add relate config

973ec5c

Merge branch '2.x' into feature/flow-limit-xjl

900fe59

Merge branch '2.x' into feature/flow-limit-xjl

aa37e27

l81893521 reviewed Nov 16, 2024

View reviewed changes

xjlgod added 5 commits November 17, 2024 20:46

fix: fix bucketTokenNumPerSecond config

da4261e

feat: add ratelimit hot config and del counter metrics

5567c3f

Merge branch '2.x' into feature/flow-limit-xjl

4bae944

feat: add ratelimit hot config and del counter metrics

dda9f88

Merge branch '2.x' into feature/flow-limit-xjl

7555517

xjlgod added 8 commits November 27, 2024 22:27

Merge branch '2.x' into feature/flow-limit-xjl

15c3bc5

fix: fix pmd check

ce28681

fix: fix pmd check

cf30cb8

Merge branch '2.x' into feature/flow-limit-xjl

037d8b2

fix: fix errer code in client

24bb0b1

Merge remote-tracking branch 'origin/feature/flow-limit-xjl' into fea…

8d258fa

…ture/flow-limit-xjl

Merge branch '2.x' into feature/flow-limit-xjl

1a1ddb8

fix: fix tm modify

c1a587e

xjlgod changed the title ~~feature: add single server rale limit~~ feature: add single server rate limit Nov 30, 2024

fix: fix tm modify

05d6cd5

xjlgod requested a review from l81893521 December 1, 2024 04:10

slievrly modified the milestones: 2.3.0, 2.4.0 Dec 1, 2024

Merge branch '2.x' into feature/flow-limit-xjl

11f31de

funky-eyes reviewed Dec 23, 2024

View reviewed changes

xjlgod added 2 commits December 24, 2024 11:58

Merge branch '2.x' into feature/flow-limit-xjl

139a688

fix: fix as review by funky

83632a0

funky-eyes reviewed Dec 24, 2024

View reviewed changes

xjlgod added 6 commits December 26, 2024 22:01

fix: add limit chain

0282825

style: fix import code style

d2a4787

Merge branch '2.x' into feature/flow-limit-xjl

313da85

style: fix import code style

901a660

Merge remote-tracking branch 'origin/feature/flow-limit-xjl' into fea…

475411b

…ture/flow-limit-xjl

style: fix pmd check

a669fc9

funky-eyes reviewed Dec 28, 2024

View reviewed changes

xjlgod added 2 commits December 29, 2024 18:31

fix: fix as code review

0c4e5ee

Merge remote-tracking branch 'upstream/2.x' into feature/flow-limit-xjl

dad819c

# Conflicts: # changes/en-us/2.x.md # changes/zh-cn/2.x.md # common/src/main/java/org/apache/seata/common/ConfigurationKeys.java

funky-eyes approved these changes Dec 31, 2024

View reviewed changes

Merge branch '2.x' into feature/flow-limit-xjl

54d93dc


		String CLIENT_ID_KEY = "clientId";

		String SERVER_IP_ADDRESS_AND_PORT_KEY = "serverIpAddressAndPort";

		server.ratelimit.bucketTokenMaxNum = 1
		server.ratelimit.bucketTokenInitialNum = 1

feature: add single server rate limit #6756

Are you sure you want to change the base?

feature: add single server rate limit #6756

Conversation

xjlgod commented Aug 14, 2024

Ⅰ. Describe what this PR did

Ⅱ. Does this pull request fix one issue?

Ⅲ. Why don't you add test cases (unit test/integration test)?

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

codecov bot commented Aug 24, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

l81893521 left a 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xjlgod commented Dec 24, 2024

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

funky-eyes left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

funky-eyes left a comment

Choose a reason for hiding this comment

codecov bot commented Aug 24, 2024 •

edited

Loading