request_user_limiter #

Description #

The request_user_limiter filter is used to control traffic by username.

Configuration Example #

A configuration example is as follows:

  - name: rate_limit_flow
      - request_user_limiter:
            - elastic
            - medcl
          max_requests: 256
#          max_bytes: 102400 #100k
          action: retry # retry or drop
#          max_retry_times: 1000
#          retry_interval: 500 #100ms
          message: "you reached our limit"

The above configuration controls the traffic of users medcl and elastic and the allowable maximum QPS is 256 per second.

Parameter Description #

userarrayUsers who will participate in traffic control. If this parameter is not set, all users will participate in traffic control.
intervalstringInterval for evaluating whether traffic control conditions are met. The default value is 1s.
max_requestsintMaximum request count limit in the interval
max_bytesintMaximum request traffic limit in the interval
actionstringProcessing action after traffic control is triggered. The value can be set as retry or drop and the default value is retry.
messagestringRejection message returned for a request, for which traffic control conditions are met
retry_intervalintInterval for traffic control retry, in milliseconds. The default value is 10.
max_retry_timesintMaximum retry count in the case of traffic control retries. The default value is 1000.