MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-14 03:43:47 +01:00
Code Issues Projects Releases Wiki Activity

Document FederationRateLimiter

Browse source
This commit is contained in:
Erik Johnston 2015-02-27 15:16:47 +00:00
parent 93d90765c4
commit 9dc9118e55
1 changed files with 51 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
synapse/federation/transport/server.py
View file

@ -32,6 +32,21 @@ logger = logging.getLogger(__name__)
class FederationRateLimiter(object): class FederationRateLimiter(object):
def __init__(self, clock, window_size, sleep_limit, sleep_msec, def __init__(self, clock, window_size, sleep_limit, sleep_msec,
reject_limit, concurrent_requests): reject_limit, concurrent_requests):
"""
Args:
clock (Clock)
window_size (int): The window size in milliseconds.
sleep_limit (int): The number of requests received in the last
`window_size` milliseconds before we artificially start
delaying processing of requests.
sleep_msec (int): The number of milliseconds to delay processing
of incoming requests by.
reject_limit (int): The maximum number of requests that are can be
queued for processing before we start rejecting requests with
a 429 Too Many Requests response.
concurrent_requests (int): The number of concurrent requests to
process.
"""
self.clock = clock self.clock = clock
self.window_size = window_size self.window_size = window_size
@ -43,9 +58,23 @@ class FederationRateLimiter(object):
self.ratelimiters = {} self.ratelimiters = {}
def ratelimit(self, host): def ratelimit(self, host):
"""Used to ratelimit an incoming request from given host
Example usage:
with rate_limiter.ratelimit(origin) as wait_deferred:
yield wait_deferred
# Handle request ...
Args:
host (str): Origin of incoming request.
Returns:
_PerHostRatelimiter
"""
return self.ratelimiters.setdefault( return self.ratelimiters.setdefault(
host, host,
PerHostRatelimiter( _PerHostRatelimiter(
clock=self.clock, clock=self.clock,
window_size=self.window_size, window_size=self.window_size,
sleep_limit=self.sleep_limit, sleep_limit=self.sleep_limit,
@ -56,7 +85,7 @@ class FederationRateLimiter(object):
).ratelimit() ).ratelimit()
class PerHostRatelimiter(object): class _PerHostRatelimiter(object):
def __init__(self, clock, window_size, sleep_limit, sleep_msec, def __init__(self, clock, window_size, sleep_limit, sleep_msec,
reject_limit, concurrent_requests): reject_limit, concurrent_requests):
self.clock = clock self.clock = clock
@ -123,17 +152,25 @@ class PerHostRatelimiter(object):
else: else:
return defer.succeed(None) return defer.succeed(None)
logger.debug("Ratelimit [%s]: len(self.request_times)=%d", id(request_id), len(self.request_times)) logger.debug(
logger.debug("Ratelimit [%s]: len(self.request_times)=%d", id(request_id), len(self.request_times)) "Ratelimit [%s]: len(self.request_times)=%d",
id(request_id), len(self.request_times),
)
if len(self.request_times) > self.sleep_limit: if len(self.request_times) > self.sleep_limit:
logger.debug("Ratelimit [%s]: sleeping req", id(request_id)) logger.debug(
"Ratelimit [%s]: sleeping req",
id(request_id),
)
ret_defer = sleep(self.sleep_msec/1000.0) ret_defer = sleep(self.sleep_msec/1000.0)
self.sleeping_requests.add(request_id) self.sleeping_requests.add(request_id)
def on_wait_finished(_): def on_wait_finished(_):
logger.debug("Ratelimit [%s]: Finished sleeping", id(request_id)) logger.debug(
"Ratelimit [%s]: Finished sleeping",
id(request_id),
)
self.sleeping_requests.discard(request_id) self.sleeping_requests.discard(request_id)
queue_defer = queue_request() queue_defer = queue_request()
return queue_defer return queue_defer
@ -143,7 +180,10 @@ class PerHostRatelimiter(object):
ret_defer = queue_request() ret_defer = queue_request()
def on_start(r): def on_start(r):
logger.debug("Ratelimit [%s]: Processing req", id(request_id)) logger.debug(
"Ratelimit [%s]: Processing req",
id(request_id),
)
self.current_processing.add(request_id) self.current_processing.add(request_id)
return r return r
@ -162,7 +202,10 @@ class PerHostRatelimiter(object):
return ret_defer return ret_defer
def _on_exit(self, request_id): def _on_exit(self, request_id):
logger.debug("Ratelimit [%s]: Processed req", id(request_id)) logger.debug(
"Ratelimit [%s]: Processed req",
id(request_id),
)
self.current_processing.discard(request_id) self.current_processing.discard(request_id)
try: try:
request_id, deferred = self.ready_request_queue.popitem() request_id, deferred = self.ready_request_queue.popitem()