【腾讯犀牛鸟计划】实现过载保护插件 - 滑动时间窗口 #144 #179

2549141519 · 2024-09-04T14:24:24Z

https://docs.qq.com/doc/DWHZPbXFNc0drZUtE 里边有实现思路和编译运行命令。
个人仓库链接为https://github.com/2549141519/trpc-cpp 代码在main分支下

我pr的分支仅仅添加了新文件夹smooth_filter 除此之外别无改动如果想测试example 和单元测试请去main分支具体步骤写在了文档里

如果有任何问题请你告诉我我将及时改动谢谢您的review

weimch · 2024-09-06T10:03:48Z

trpc/overload_control/smooth_filter/server_smooth_limit.h

+/// @var: Default number of time frames per second
+constexpr int32_t kDefaultNum = 100;
+
+class SmoothLimit : public ServerOverloadController


你这里可以直接用 trpc/overload_control/flow_control/smooth_limiter.h 吗？

框架已经实现了滑动窗口和固定窗口算法，都在flow_control文件夹里，你可以把他们与ServerOverloadController做一下集成吗？

谢谢您的回复！我已经作出改动

weimch · 2024-09-09T02:21:00Z

trpc/overload_control/smooth_filter/server_smooth_limit.h

+private:
+  std::string name_;
+
+  SmoothLimiter smooth_limit_;


可以将这个变量定义为一个智能指针，在Destroy里销毁，线程资源停止及销毁动作不太适合放在析构函数里。

weimch · 2024-09-09T02:32:40Z

trpc/overload_control/smooth_filter/server_smooth_limit.h

+/// @brief Default number of time frames per second
+static const int32_t kDefaultNumber = 100;
+
+class SmoothLimit : public ServerOverloadController


类名可以改成 SmoothLimitOverloadController

weimch · 2024-09-09T02:34:50Z

trpc/overload_control/smooth_filter/server_flow_controller_conf.h

+namespace trpc::overload_control {
+
+/// @brief The configuration of interface-level flow control
+struct Server_FuncLimiterConfig {


看到 flow_controller_conf、flow_controller_factory等的实现，基本是把 trpc/overload_control/flow_control 里文件内容给拷贝过来了；

这块代码不应该被重复拷贝，而是应该复用（使用函数、使用类）；

具体到过载保护来说，你需要在filter里调用OverloadController

1 .类名字我已修改
2. 封装smooth_filter地方我采用了智能指针 destroy的时候是否是调用reset我不太确定
3. conf文件我复用了flow_control的，并且运行结果没问题
4. generator文件不太好复用，里边其实是注册smooth_filter，这个地方的smooth_filter和原始的flow_control的多了一个变量，导致不能直接复用，只有两个func我感觉可以自己写

weimch · 2024-09-10T02:15:56Z

调整时候有遇到啥困难或者不确定的吗？

github-actions · 2024-09-10T05:51:54Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

weimch · 2024-09-10T08:01:43Z

trpc/overload_control/smooth_filter/server_flow_controller_generator.h

+
+/// @brief Register the flow controller object for the service.
+/// @param flow_conf Flow control conf.
+void Server_RegisterFlowController(const FlowControlLimiterConf& flow_conf);


方法名全驼峰式命名，你可以换一个名字

weimch · 2024-09-10T08:02:10Z

trpc/overload_control/smooth_filter/server_flow_controller_server_filter.h

+class Server_FlowControlServerFilter : public MessageServerFilter {
+ public:
+  /// @brief Name of filter
+  std::string Name() override { return "my_flow_control"; }


插件名定义成有意义的常量

weimch · 2024-09-10T08:11:13Z

trpc/overload_control/smooth_filter/server_smooth_limit.cc

+namespace trpc::overload_control {
+
+bool SmoothLimitOverloadController::Init() {
+  // nothing to do,The time thread automatically starts.


你的Controller类，可以在Init的时候，创建并管理一组SmoothLimit的map吧，只需要复用CreateFlowController就好了吧，也不用你自己实现一个xx_generator

在BeforeSchedule里，从这组SmoothLimit里取出对应配置的限流器，调用一下就好了吧

老师好，这块我没看懂，有两个问题：
1.CreateFlowController里面调用了限流器的构造函数，现在我自己实现的限流器变成了xxx_controller，那么这里也需要修改吧？怎么直接复用CreateFlowController呢？

2.现在要求不实现xx_generator,在controller中创建并管理一组map，是要在xxx_filter中加载配置文件，并把配置文件作为参数传入controller的构造函数?

创建并管理一组FlowController

weimch · 2024-09-10T08:12:03Z

trpc/overload_control/smooth_filter/server_smooth_limit.cc

+
+bool SmoothLimitOverloadController::Init() {
+  // nothing to do,The time thread automatically starts.
+  return true;


另外，文件名和类名应该更有意义，你可以想一下怎么改类名和文件名比较好

weimch · 2024-09-11T11:30:35Z

trpc/overload_control/smooth_filter/smooth_limit_overload_controller.cc

+namespace trpc::overload_control {
+
+bool SmoothLimitOverloadController::Init() {
+std::vector<FlowControlLimiterConf> flow_control_confs;


注意缩进，可以用clang-format工具格式化一遍提交的代码，格式化使用trpc-cpp下的.clang-format配置

weimch · 2024-09-11T11:31:01Z

trpc/overload_control/smooth_filter/filter_test.yaml

+      ip: 0.0.0.0                     # Service bind ip
+      port: 12345  
+      filter:
+        - my_flow_control         # Service bind port


my_flow_control换成有意义的插件名

weimch · 2024-09-11T11:32:15Z

trpc/overload_control/smooth_filter/smooth_limit_overload_controller.cc

+}
+
+bool SmoothLimitOverloadController::BeforeSchedule(const ServerContextPtr& context) {
+  auto service_controller = SmoothLimitOverloadController::GetInstance()->GetFlowController(context->GetCalleeName());


不需要使用单例，直接从map里获取就好了

weimch · 2024-09-11T11:35:58Z

trpc/overload_control/smooth_filter/smooth_limit_overload_controller.cc

+  for (const auto& func_conf : flow_conf.func_limiters) {
+    if (!func_conf.limiter.empty()) {
+      std::string service_func_name = fmt::format("/{}/{}", flow_conf.service_name, func_conf.name);
+      FlowControllerPtr func_controller =


这里是只创建了smooth滑动窗口限流器吗？defualt固定窗口限流器有创建吗？

defalut会创建固定窗口这个地方直接调用的flow_control的conf读取yaml配置 generator创建，map的value类型是父类可以的

weimch · 2024-09-11T11:37:01Z

trpc/overload_control/smooth_filter/smooth_limit_overload_controller.cc

+//
+//
+
+#ifdef TRPC_BUILD_INCLUDE_OVERLOAD_CONTROL


补充下单测，在docs/zh文档里补充下用法

老师我已经作出修改

clang-format工具格式化

my_flow_control替换成server_flow_control

直接从map里获取

补充下单测，在docs/zh文档里补充用法

weimch · 2024-09-13T06:14:36Z

docs/zh/window_limit_overload_control.md

+plugins:
+  prometheus:
+
+  window_limit_overload_control:


为啥不能是这样的配置？

plugins: overload_control: window_limiter: - xxxxx

weimch · 2024-09-13T06:15:01Z

docs/zh/window_limit_overload_control.md

+
+服务端流量控制配置如下（详细配置参考：[flow_test.yaml](../../trpc/overload_control/flow_control/flow_test.yaml)）：
+```
+global:


除了插件之外，其他的无关配置都删掉

weimch · 2024-09-13T06:17:02Z

trpc/overload_control/window_limit_control/window_limit_overload_controller_filter.h

+
+namespace trpc::overload_control {
+
+constexpr char WindowLimitOverloadControlFilterName[] = "window_limiter";


类型/变量名都换成WindowLimiter吧，名词更好

weimch · 2024-09-13T06:17:33Z

trpc/overload_control/window_limit_control/window_limit_overload_controller_filter.h

+
+namespace trpc::overload_control {
+
+constexpr char WindowLimitOverloadControlFilterName[] = "window_limiter";


常量名需要加上 kWindowxxxx

weimch · 2024-09-13T06:18:30Z

trpc/overload_control/window_limit_control/window_limit_overload_controller.h

+
+namespace trpc::overload_control {
+
+constexpr char WindowLimitOverloadControllerName[] = "WindowLimitOverloadController";


kWindowLimiterOverloadControllerName

weimch · 2024-09-13T06:19:13Z

trpc/overload_control/window_limit_control/window_limit_overload_controller.h

+constexpr char kWindowLimitControlName[] = "window_limiter";
+
+/// @brief Default number of time frames per second
+constexpr int32_t kDefaultNumber = 100;


这个没有被使用吧？是不是可以删掉

weimch · 2024-09-13T06:20:16Z

trpc/overload_control/window_limit_control/window_limit_overload_controller.h

+
+  void RegisterLimiter(const std::string& name, FlowControllerPtr limiter);
+
+  FlowControllerPtr GetLimiter(const std::string& name);


这个方法不需要定义成public的吧

weimch · 2024-09-13T06:25:42Z

trpc/overload_control/window_limit_control/window_limit_overload_controller.h

+
+constexpr char kWindowLimitOverloadCtrConfField[] = "window_limit_overload_control";
+
+constexpr char kWindowLimitControlName[] = "window_limiter";


限流器名字定义在这里：trpc/overload_control/overload_control_defs.h

docs/zh/window_limit_overload_control.md

helloopenworld · 2024-09-18T03:25:50Z

docs/zh/window_limit_overload_control.md

+- func_limiter：指定服务名 `service_name` 下的接口级流控策略；每个服务可以存在多个接口，每个接口可以选择不同的流量控制算法，介绍如下：
+  - `name`：接口名称，如：`SayHello` 和 `Route`
+  - `limiter`：指定接口流控算法，例如：`Route` 配置了滑动窗口（smooth）算法，最大 QPS 是 80000
+- is_report：是否上报监控数据到监控插件，**注意，该配置必须与监控插件一起使用(例如配置：plugins->metrics->prometheus，则会上报到 prometheus 上)，如果没有配置监控插件，该选项无意义**，不同流量控制算法监控数据分别如下：


默认设置成不上报

helloopenworld

approve

helloopenworld

approve

2549141519 added 2 commits September 4, 2024 22:21

添加滑动窗口过载保护插件以及集成测试

d1051d7

remove file profling

fb7dec1

weimch reviewed Sep 6, 2024

View reviewed changes

改用flow_control的smooth_limiter

54c9b69

weimch reviewed Sep 9, 2024

View reviewed changes

采用flowcontrol的conf配置修改smooth_limit class name 采用智能指针封装

526849a

weimch reviewed Sep 10, 2024

View reviewed changes

weimch mentioned this pull request Sep 10, 2024

Feature: add seconds limiter with unitest #168

Closed

2549141519 added 3 commits September 11, 2024 19:04

重新封装filter和smooth_limit_controller

0ed8749

给名字定义常量更直观

0f1442e

修改smoothlimit名字

7617bd6

weimch reviewed Sep 11, 2024

View reviewed changes

2549141519 added 7 commits September 11, 2024 19:37

修改GetLimiter RegisterLimiter为private

e108924

修改插件名字

1cd4461

添加单元测试

0b6b834

格式化文件

840f3c4

添加使用文档

2d46b9a

Merge branch 'trpc-group:main' into pr

4ae0be9

更改限流提示语

04ebebb

weimch reviewed Sep 13, 2024

View reviewed changes

2549141519 added 9 commits September 13, 2024 16:20

修改常量名字文档

9c46716

将常量定义在def文件

d6683be

修改常量名字

2ae80cb

修改注册插件的类名

0aa66f4

修改变量名字

d8dfff8

修改defs

021e319

改用windowlimits做变量名字

c774403

修改文件夹名字

bdddb9c

修改变量名字

2e6b88f

weimch reviewed Sep 13, 2024

View reviewed changes

docs/zh/window_limit_overload_control.md Show resolved Hide resolved

2549141519 added 3 commits September 13, 2024 20:20

修改文档

a9e357c

格式化

d39ef19

删除文件

036cbb7

helloopenworld reviewed Sep 18, 2024

View reviewed changes

helloopenworld approved these changes Sep 18, 2024

View reviewed changes

2549141519 added 3 commits September 18, 2024 11:32

修改文档默认设置成不上报

a950455

Merge branch 'main' into pr

d7f45f6

Update overload_control_defs.h

fc50dfd

helloopenworld approved these changes Sep 18, 2024

View reviewed changes

helloopenworld merged commit 05baf7e into trpc-group:main Sep 18, 2024
1 check passed

This was referenced Sep 19, 2024

【腾讯犀牛鸟计划】实现过载保护插件 - 固定时间窗口 #142

Closed

【腾讯犀牛鸟计划】实现过载保护插件 - 滑动时间窗口 #144

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

【腾讯犀牛鸟计划】实现过载保护插件 - 滑动时间窗口 #144 #179

【腾讯犀牛鸟计划】实现过载保护插件 - 滑动时间窗口 #144 #179

2549141519 commented Sep 4, 2024

weimch Sep 6, 2024

2549141519 Sep 6, 2024

weimch Sep 9, 2024

weimch Sep 9, 2024

weimch Sep 9, 2024

2549141519 Sep 10, 2024

weimch commented Sep 10, 2024

github-actions bot commented Sep 10, 2024 •

edited

Loading

weimch Sep 10, 2024

weimch Sep 10, 2024

weimch Sep 10, 2024

weimch Sep 10, 2024

shenh09 Sep 10, 2024

weimch Sep 11, 2024

weimch Sep 10, 2024

weimch Sep 11, 2024

weimch Sep 11, 2024 •

edited

Loading

weimch Sep 11, 2024

weimch Sep 11, 2024

2549141519 Sep 11, 2024

weimch Sep 11, 2024 •

edited

Loading

2549141519 Sep 11, 2024

weimch Sep 13, 2024

weimch Sep 13, 2024

weimch Sep 13, 2024

weimch Sep 13, 2024

weimch Sep 13, 2024

weimch Sep 13, 2024

weimch Sep 13, 2024

weimch Sep 13, 2024

helloopenworld Sep 18, 2024

helloopenworld left a comment

helloopenworld left a comment


		namespace trpc::overload_control {

		constexpr char WindowLimitOverloadControlFilterName[] = "window_limiter";


		void RegisterLimiter(const std::string& name, FlowControllerPtr limiter);

		FlowControllerPtr GetLimiter(const std::string& name);


		constexpr char kWindowLimitOverloadCtrConfField[] = "window_limit_overload_control";

		constexpr char kWindowLimitControlName[] = "window_limiter";

【腾讯犀牛鸟计划】实现过载保护插件 - 滑动时间窗口 #144 #179

【腾讯犀牛鸟计划】实现过载保护插件 - 滑动时间窗口 #144 #179

Conversation

2549141519 commented Sep 4, 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

weimch commented Sep 10, 2024

github-actions bot commented Sep 10, 2024 • 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

Choose a reason for hiding this comment

weimch Sep 11, 2024 • 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

weimch Sep 11, 2024 • 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

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

helloopenworld left a comment

Choose a reason for hiding this comment

helloopenworld left a comment

Choose a reason for hiding this comment

github-actions bot commented Sep 10, 2024 •

edited

Loading

weimch Sep 11, 2024 •

edited

Loading

weimch Sep 11, 2024 •

edited

Loading