matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Warn on high latency and blocking heartbeat

Browse Source 
Add warnings for when the heartbeat is blocked for a long time and when
the websocket latency is excessively high.  These indicate problems with
blocking the event loop and/or insufficient computing resources to keep
up with the demand.
This commit is contained in:
Hornwitser 2019-01-26 23:46:32 +01:00 committed by Rapptz
parent 1f4940d171
commit ed76151c70
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
discord/gateway.py
View File

@ -26,6 +26,7 @@ DEALINGS IN THE SOFTWARE.
import asyncio import asyncio
from collections import namedtuple from collections import namedtuple
import concurrent.futures
import json import json
import logging import logging
import struct import struct
@ -64,6 +65,8 @@ class KeepAliveHandler(threading.Thread):
self.daemon = True self.daemon = True
self.shard_id = shard_id self.shard_id = shard_id
self.msg = 'Keeping websocket alive with sequence %s.' self.msg = 'Keeping websocket alive with sequence %s.'
self.block_msg = 'Heartbeat blocked for more than %s seconds.'
self.behind_msg = 'Can\'t keep up, websocket is %.1fs behind.'
self._stop_ev = threading.Event() self._stop_ev = threading.Event()
self._last_ack = time.perf_counter() self._last_ack = time.perf_counter()
self._last_send = time.perf_counter() self._last_send = time.perf_counter()
@ -91,7 +94,15 @@ class KeepAliveHandler(threading.Thread):
f = asyncio.run_coroutine_threadsafe(coro, loop=self.ws.loop) f = asyncio.run_coroutine_threadsafe(coro, loop=self.ws.loop)
try: try:
# block until sending is complete # block until sending is complete
f.result() total = 0
while True:
try:
f.result(5)
break
except concurrent.futures.TimeoutError:
total += 5
log.warning(self.block_msg, total)
except Exception: except Exception:
self.stop() self.stop()
else: else:
@ -110,11 +121,15 @@ class KeepAliveHandler(threading.Thread):
ack_time = time.perf_counter() ack_time = time.perf_counter()
self._last_ack = ack_time self._last_ack = ack_time
self.latency = ack_time - self._last_send self.latency = ack_time - self._last_send
if self.latency > 10:
log.warning(self.behind_msg, self.latency)
class VoiceKeepAliveHandler(KeepAliveHandler): class VoiceKeepAliveHandler(KeepAliveHandler):
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)
self.msg = 'Keeping voice websocket alive with timestamp %s.' self.msg = 'Keeping voice websocket alive with timestamp %s.'
self.block_msg = 'Voice heartbeat blocked for more than %s seconds'
self.behind_msg = 'Can\'t keep up, voice websocket is %.1fs behind'
def get_payload(self): def get_payload(self):
return { return {