lua-resty-limit-req - Limit the request processing rate between multiple NGINX instances
Ready for testing. Probably production ready in most cases, though not yet proven in the wild. Please check the issues list and let me know if you have any problems / questions.
This lua library is a request processing rate limit module for ngx_lua:
http://wiki.nginx.org/HttpLuaModule
It is used to limit the request processing rate per a defined key between multiple NGINX instances. The limitation is done using the "leaky bucket" method.
This module use redis (>= 2.6.0) as the backend storage, so you also need the lua-resty-redis library work with it.
lua_package_path "/path/to/lua-resty-limit-req/lib/?.lua;;";
server {
listen 9090;
location /t {
access_by_lua '
local req = require "resty.limit.req"
local ok = req.limit{ key = ngx.var.remote_addr, zone = "one",
rate = "2r/s", interval = 2, log_level = ngx.NOTICE,
rds = { host = "127.0.0.1", port = 6379 }}
if not ok then
return ngx.exit(503)
end
';
echo Logged in;
}
}syntax: ok = req.limit(cfg)
Available limit configurations are listed as follows:
key
The key is any non-empty value of the specified variable.
zone
Sets the namespace, in particular, we use <zone>:<key> string as a unique state identifier inside redis.
rate
The rate is specified in requests per second (r/s). If a rate of less than one request per second is desired, it is specified in request per minute (r/m). For example, half-request per second is 30r/m.
interval
The time delay (in s) before back to normal state, default 0.
log_level
Sets the desired logging level for cases when the server refuses to process requests due to rate exceeding, default ngx.NOTICE.
rds
Sets the redis host and port, default 127.0.0.1 and 6379.
conn
Instead of the specific redis configuration (aka. rds), sets the connected redis object directly.
Monkey Zhang timebug.info@gmail.com, UPYUN Inc.
Inspired from http://nginx.org/en/docs/http/ngx_http_limit_req_module.html.
This module is licensed under the 2-clause BSD license.
Copyright (c) 2014, Monkey Zhang timebug.info@gmail.com, UPYUN Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.