sentinel-cluster-client-redis #1226

binecy · 2019-12-26T13:04:38Z

Describe what this PR does / why we need it

使用redis作为集群流控的服务端，某些场景下可以减少部署集群流控服务端的工作，也可以充分利用redis的高可用特性。

Does this pull request fix one issue?

Describe how you did it

ClusterClientConfigManager管理redis的url，user，password等配置。
RedisProcessorFactoryManager实现了ServerChangeObserver接口，负责构建RedisProcessorFactory和RedisProcessor。RedisProcessor负责与redis交互，向redis请求token，推送rule到redis等。
RedisClusterFlowRuleManager负责将flowRule推送到reids
flowRule在redis中key为sentinel:config:{namespace-flowId}, 使用Map结构存放sampleCount，intervalInMs，windowLengthInMs，thresholdCount配置。
RedisProcessor.requestToken方法向redis请求token，通过lua脚步实现该功能
redis中统计数据的key为sentinel:token:{namespace-flowId}，使用Map结构存放所有的bucket，Map的key为time/windowLengthInMs，val为pass。
lua脚步统计数据步骤为：
使用sentinel:config:{namespace-flowId}查找对应的rule配置
使用time/windowLengthInMs计算bucket下标
如果bucket不存在，添加新的bucket同时删除过期的bucket
统计所有bucket中pass总数，计算qps
比较结果添加pass数据

5.RedisClusterFlowSlot处理由RedisClusterFlowRuleManager添加的flowRule，该类代码除了ruleProvider，其他代码与FlowSlot一致。
6.RedisClusterFlowSlotExtender将RedisClusterFlowSlot添加到slotChain

Describe how to verify it

可见ClusterJedisTokenServiceTest，ClusterJedisRuleManagerTest

Special notes for reviews

支持redis4.0+，支持redis单机，sentinel，cluster集群模式，客户端使用jedis。
现在只支持集群总阈值模式，requestToken请求，不支持prioritized参数

单机均摊模式，requestParamToken请求和Lettuce客户端正在开发中

RedisClusterTokenServiceTest && RedisClient adjust sentinel-cluster-client-redis

codecov-io · 2019-12-26T13:32:10Z

Codecov Report

Attention: Patch coverage is 0% with 511 lines in your changes missing coverage. Please review.

Project coverage is 41.64%. Comparing base (6a7ec70) to head (61625ab).
Report is 260 commits behind head on master.

Files with missing lines	Patch %	Lines
...ster/redis/config/RedisClusterFlowRuleManager.java	0.00%	129 Missing ⚠️
...uster/redis/config/ClusterClientConfigManager.java	0.00%	59 Missing ⚠️
...inel/cluster/redis/config/ClusterClientConfig.java	0.00%	52 Missing ⚠️
...libaba/csp/sentinel/cluster/redis/lua/LuaUtil.java	0.00%	49 Missing ⚠️
...p/sentinel/cluster/redis/jedis/JedisProcessor.java	0.00%	37 Missing ⚠️
...ntinel/cluster/redis/RedisClusterTokenService.java	0.00%	32 Missing ⚠️
...ter/redis/config/RedisProcessorFactoryManager.java	0.00%	28 Missing ⚠️
...nel/cluster/redis/jedis/JedisClusterProcessor.java	0.00%	28 Missing ⚠️
...p/sentinel/cluster/redis/RedisClusterFlowSlot.java	0.00%	16 Missing ⚠️
...ster/redis/jedis/JedisClusterProcessorFactory.java	0.00%	16 Missing ⚠️
... and 6 more

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #1226      +/-   ##
============================================
- Coverage     43.64%   41.64%   -2.01%     
+ Complexity     1688     1687       -1     
============================================
  Files           364      380      +16     
  Lines         10523    11034     +511     
  Branches       1416     1466      +50     
============================================
+ Hits           4593     4595       +2     
- Misses         5366     5876     +510     
+ Partials        564      563       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

sczyh30 · 2020-01-15T02:49:34Z

Nice, I'll take a review these days. Could you please add some details of the design in the PR description?

binecy · 2020-01-15T12:00:55Z

谢谢，PR description中已经添加了内容。

binecy · 2020-02-29T07:14:58Z

Nice, I'll take a review these days. Could you please add some details of the design in the PR description?

嗨，可以帮忙review一下代码吗
该功能后面还想继续做一些开发，希望你可以先帮忙review一下代码，谢谢

xiejiashuai · 2020-03-02T06:20:54Z

Nice, I'll take a review these days. Could you please add some details of the design in the PR description?

嗨，可以帮忙review一下代码吗
该功能后面还想继续做一些开发，希望你可以先帮忙review一下代码，谢谢

嗨，方便加个钉钉吗？

sczyh30 · 2020-03-02T15:32:30Z

Nice, I'll take a review these days. Could you please add some details of the design in the PR description?

嗨，可以帮忙review一下代码吗
该功能后面还想继续做一些开发，希望你可以先帮忙review一下代码，谢谢

Sorry for the late reply. We'll take a rapid review these days.

jasonjoo2010

There are some designing issues should be confirmed i think and i need your suggestions @sczyh30 @cdfive

I just left some proposals here and felt it is more complicated as what i expected.

sentinel-cluster/pom.xml

jasonjoo2010 · 2020-03-03T06:56:00Z

...er-client-redis/src/main/java/com/alibaba/csp/sentinel/cluster/redis/config/HostAndPort.java

@@ -0,0 +1,27 @@
+package com.alibaba.csp.sentinel.cluster.redis.config;
+


And i just want to question that why we created a suit of shadow configuration classes (HostAndPort, Client, Factory) but didn't use that in redisclient? We can handle different types of clients in RedisClientFactory (replacement of RedisClientFactoryManager) originally.

redisclient有歧义，该类负责调用redis执行requestToken等逻辑操作，而不是redis的客户类（已改成RedisProcessor），所以HostAndPort这些配置类没有用于redisclient，而用于负责生成它的RedisClientFactory（已改为RedisProcessorFactory）中，RedisClientFactoryManager（已改成RedisProcessorFactoryManager）则根据不同redis java客户端和redis集群方式生成对应的RedisClientFactory。你看这样是否合理

...t-redis/src/main/java/com/alibaba/csp/sentinel/cluster/redis/config/ClusterClientConfig.java

jasonjoo2010 · 2020-03-03T07:21:21Z

...l-cluster-client-redis/src/main/java/com/alibaba/csp/sentinel/cluster/redis/RedisClient.java

+
+import java.util.Set;
+
+public interface RedisClient {


I think the loading process should not be put in client (or we call it proxy or util) and load when needed. This may cause racing or latency, right?

Better put them in kinds of initializing codes like InitFunc, etc

And the name RedisClient will cause ambiguous with real client of Redis.

redis加载工作确实在RedisClusterClientInitFunc#initJedisClient方法中RedisProcessorFactoryManager.setClientType完成。
RedisClient已改为RedisProcessor。

...ent-redis/src/main/java/com/alibaba/csp/sentinel/cluster/redis/jedis/JedisClusterClient.java

jasonjoo2010 · 2020-03-03T07:59:18Z

...ent-redis/src/main/java/com/alibaba/csp/sentinel/cluster/redis/jedis/JedisClusterClient.java

+
+    @Override
+    public int requestToken(String luaId, RequestData requestData) {
+        final String flowId = String.valueOf(requestData.getFlowId());


How to separate the flowId in different projects sharing same redis/redis cluster?

添加了namespace，ClusterFlowRuleManager为flowRule指定所属的namespace，可以区分不同项目的flowId。

jasonjoo2010 · 2020-03-03T08:10:08Z

...ter-client-redis/src/main/java/com/alibaba/csp/sentinel/cluster/redis/jedis/JedisClient.java

+    @Override
+    public int requestToken(String luaId, RequestData requestData) {
+        String luaCode = LuaUtil.loadLuaCodeIfNeed(luaId);
+        String luaSha = LuaUtil.loadLuaShaIfNeed(luaCode, new Function<String, String>() {


Have you tested the scenario migration of redis cluster? Is the lua cache migrated or not? If not there it would fail then.

redis cluster迁移到新集群，要通过ClusterClientConfigManager.applyNewConfig更新配置，重新创建redis连接，这时也会清理所有的lua sha缓存

...-redis/src/main/java/com/alibaba/csp/sentinel/cluster/redis/config/RedisFlowRuleManager.java

jasonjoo2010 · 2020-03-03T08:32:26Z

.../src/main/java/com/alibaba/csp/sentinel/cluster/redis/config/ClusterClientConfigManager.java

@@ -0,0 +1,125 @@
+package com.alibaba.csp.sentinel.cluster.redis.config;


And all new files should prepend the license header please.

不好意思，不太理解这个问题，可以再解释一下吗

CLAassistant · 2020-03-04T07:25:44Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

code review

travis-ci.org err fix

binecy · 2020-03-05T15:24:40Z

Nice, I'll take a review these days. Could you please add some details of the design in the PR description?

嗨，可以帮忙review一下代码吗
该功能后面还想继续做一些开发，希望你可以先帮忙review一下代码，谢谢

嗨，方便加个钉钉吗？

钉钉binecy，欢迎交流

Dev

RedisClusterFlowRuleManager

sczyh30 · 2020-03-26T04:41:34Z

Please pay attention to #411 and #1308, where the design of slot and slot chain SPI has been refactored.

Dev

binecy · 2020-04-12T12:22:27Z

Please pay attention to #411 and #1308, where the design of slot and slot chain SPI has been refactored.

已合并master代码，并使用新的spi机制

Neil-Boyle · 2023-01-09T03:08:06Z

anything update？

binecy added 3 commits December 25, 2019 22:13

sentinel-cluster-client-redis

82c853a

RedisClusterTokenServiceTest && RedisClient adjust

a3269de

sentinel-cluster-client-redis

b183ab0

RedisClusterTokenServiceTest && RedisClient adjust sentinel-cluster-client-redis

sczyh30 added area/cluster-flow Issues or PRs related to cluster flow control kind/feature Category issues or prs related to feature request. size/XXL Indicate a PR that changes 1000+ lines. to-review To review labels Dec 26, 2019

remove fail test

62bd406

add RedisClusterFlowSlot

5b3b9ae

binecy force-pushed the master branch from 2a50a54 to 5b3b9ae Compare December 31, 2019 08:05

code arrange and add test in single redis

0538549

binecy closed this Jan 15, 2020

binecy reopened this Jan 15, 2020

lua adjust

de54ede

sczyh30 requested review from sczyh30, cdfive, jasonjoo2010 and linlinisme March 2, 2020 15:32

jasonjoo2010 mentioned this pull request Mar 3, 2020

Design of SlotChainBuilder #1308

Closed

jasonjoo2010 requested changes Mar 3, 2020

View reviewed changes

binecy added 3 commits March 5, 2020 19:01

code review

1e9b48b

Merge pull request #1 from binecy/dev

28de029

code review

travis-ci.org err fix

ad1d7ef

Merge pull request #2 from binecy/dev

5379777

travis-ci.org err fix

binecy closed this Mar 5, 2020

binecy reopened this Mar 5, 2020

binecy added 4 commits March 8, 2020 22:29

add namespace

00d6cfc

code review

7943940

Merge pull request #3 from binecy/dev

a3f6819

Dev

alibaba coding guide

6b7da81

binecy requested a review from jasonjoo2010 March 21, 2020 00:34

binecy added 2 commits March 22, 2020 13:44

RedisFlowRuleManager->RedisClusterFlowRuleManager

ad6a18d

Merge pull request #4 from binecy/dev

8beb5fe

RedisClusterFlowRuleManager

binecy added 3 commits April 11, 2020 16:21

Merge branch 'master' of https://github.com/alibaba/Sentinel into dev

eea40eb

use new spi

8ef9319

Merge pull request #5 from binecy/dev

61625ab

Dev

binecy closed this Oct 14, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sentinel-cluster-client-redis #1226

sentinel-cluster-client-redis #1226

binecy commented Dec 26, 2019 •

edited

Loading

codecov-io commented Dec 26, 2019 •

edited by codecov bot

Loading

sczyh30 commented Jan 15, 2020

binecy commented Jan 15, 2020

binecy commented Feb 29, 2020

xiejiashuai commented Mar 2, 2020 •

edited

Loading

sczyh30 commented Mar 2, 2020

jasonjoo2010 left a comment

jasonjoo2010 Mar 3, 2020

binecy Mar 5, 2020

jasonjoo2010 Mar 3, 2020

binecy Mar 5, 2020

jasonjoo2010 Mar 3, 2020

binecy Mar 15, 2020

jasonjoo2010 Mar 3, 2020

binecy Mar 21, 2020

jasonjoo2010 Mar 3, 2020

binecy Mar 15, 2020

CLAassistant commented Mar 4, 2020 •

edited

Loading

binecy commented Mar 5, 2020

sczyh30 commented Mar 26, 2020

binecy commented Apr 12, 2020

Neil-Boyle commented Jan 9, 2023

		@@ -0,0 +1,27 @@
		package com.alibaba.csp.sentinel.cluster.redis.config;

		@@ -0,0 +1,125 @@
		package com.alibaba.csp.sentinel.cluster.redis.config;

sentinel-cluster-client-redis #1226

sentinel-cluster-client-redis #1226

Conversation

binecy commented Dec 26, 2019 • edited Loading

Describe what this PR does / why we need it

Does this pull request fix one issue?

Describe how you did it

Describe how to verify it

Special notes for reviews

codecov-io commented Dec 26, 2019 • edited by codecov bot Loading

Codecov Report

sczyh30 commented Jan 15, 2020

binecy commented Jan 15, 2020

binecy commented Feb 29, 2020

xiejiashuai commented Mar 2, 2020 • edited Loading

sczyh30 commented Mar 2, 2020

jasonjoo2010 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

CLAassistant commented Mar 4, 2020 • edited Loading

binecy commented Mar 5, 2020

sczyh30 commented Mar 26, 2020

binecy commented Apr 12, 2020

Neil-Boyle commented Jan 9, 2023

binecy commented Dec 26, 2019 •

edited

Loading

codecov-io commented Dec 26, 2019 •

edited by codecov bot

Loading

xiejiashuai commented Mar 2, 2020 •

edited

Loading

CLAassistant commented Mar 4, 2020 •

edited

Loading