Update time: 2021-03-06


  • rateLimiter is core implementation of gateway restrictions on network traffic.

  • You can set to the interface level or the parameter level. How to use it depends on your traffic configuration.

Technical Solution

  • Using redis token bucket algorithm to limit traffic.

  • Flow Diagram:

Plugin Setting

  • In soul-admin–> plugin management–> rate_limiter set to enable.

  • Configure redis in the plugin.

  • Currently, supporting redis patterns of single, sentinel, and cluster.

  • If it is a sentinel, cluster and other multi-node configuration in URL, please use ; for each instance; Division. For example,;。

  • If the user don’t use, please disable the plugin in the backgroud.

Plugin Detail

  • Introduce rateLimiter dependency in pom.xml file of the gateway.
  <!-- soul ratelimiter plugin start-->
  <!-- soul ratelimiter plugin end-->
  • Selectors and rules, please refer to: selector

  • Rate: It is how many requests you allow users to execute per second, while not discarding any requests. This is the filling rate of token bucket.

  • Capacity: it is the maximum number of requests that users are allowed to execute in one second. This is token bucket can save the number of token.