diff --git a/src/socketio/admin.py b/src/socketio/admin.py
new file mode 100644
index 0000000..4871ade
--- /dev/null
+++ b/src/socketio/admin.py
@@ -0,0 +1,333 @@
+from datetime import datetime
+import functools
+import os
+import socket
+import time
+from urllib.parse import parse_qs
+
+HOSTNAME = socket.gethostname()
+PID = os.getpid()
+
+
+class EventBuffer:
+ def __init__(self):
+ self.buffer = {}
+
+ def push(self, type, count=1):
+ timestamp = int(time.time()) * 1000
+ key = '{};{}'.format(timestamp, type)
+ if key not in self.buffer:
+ self.buffer[key] = {
+ 'timestamp': timestamp,
+ 'type': type,
+ 'count': count,
+ }
+ else:
+ self.buffer[key]['count'] += count
+
+ def get_and_clear(self):
+ buffer = self.buffer
+ self.buffer = {}
+ return [value for value in buffer.values()]
+
+
+class InstrumentedServer:
+ def __init__(self, sio, auth=None, namespace='/admin', read_only=False,
+ server_id=None, mode='development'):
+ """Instrument the Socket.IO server for monitoring with the `Socket.IO
+ Admin UI `_.
+ """
+ if auth is None:
+ raise ValueError('auth must be specified')
+ self.sio = sio
+ self.auth = auth
+ self.admin_namespace = namespace
+ self.read_only = read_only
+ self.server_id = server_id or (
+ self.sio.manager.host_id if hasattr(self.sio.manager, 'host_id')
+ else HOSTNAME
+ )
+ self.mode = mode
+ self.event_buffer = EventBuffer()
+
+ # monkey-patch the server to report metrics to the admin UI
+ if sio.is_asyncio_based():
+ self.instrument_async()
+ else:
+ self.instrument_sync()
+
+ def admin_connect(self, sid, environ, client_auth):
+ if self.auth:
+ if client_auth['username'] != self.auth[0] or \
+ client_auth['password'] != self.auth[1]:
+ raise ConnectionRefusedError('Invalid credentials')
+
+ def config(sid):
+ self.sio.sleep(0.1)
+
+ # supported features
+ features = ['EMIT', 'JOIN', 'LEAVE', 'DISCONNECT', 'MJOIN',
+ 'MLEAVE', 'MDISCONNECT', 'AGGREGATED_EVENTS']
+ if self.mode == 'development':
+ features.append('ALL_EVENTS')
+ self.sio.emit('config', {'supportedFeatures': features},
+ to=sid, namespace=self.admin_namespace)
+
+ # send current sockets
+ if self.mode == 'development':
+ all_sockets = []
+ for nsp in self.sio.manager.get_namespaces():
+ for sid, eio_sid in self.sio.manager.get_participants(
+ nsp, None):
+ all_sockets.append(
+ self.serialize_socket(sid, nsp, eio_sid))
+ self.sio.emit('all_sockets', all_sockets, to=sid,
+ namespace=self.admin_namespace)
+
+ self.sio.start_background_task(config, sid)
+
+ def admin_emit(self, _, namespace, room_filter, event, *data):
+ self.sio.emit(event, data, to=room_filter, namespace=namespace)
+
+ def admin_enter_room(self, _, namespace, room, room_filter=None):
+ for sid, _ in self.sio.manager.get_participants(
+ namespace, room_filter):
+ self.sio.enter_room(sid, room, namespace=namespace)
+
+ def admin_leave_room(self, _, namespace, room, room_filter=None):
+ for sid, _ in self.sio.manager.get_participants(
+ namespace, room_filter):
+ self.sio.leave_room(sid, room, namespace=namespace)
+
+ def admin_disconnect(self, _, namespace, close, room_filter=None):
+ for sid, _ in self.sio.manager.get_participants(
+ namespace, room_filter):
+ self.sio.disconnect(sid, namespace=namespace)
+
+ def instrument_sync(self):
+ self.sio.on('connect', self.admin_connect,
+ namespace=self.admin_namespace)
+
+ if self.mode == 'development':
+ if not self.read_only:
+ self.sio.on('emit', self.admin_emit,
+ namespace=self.admin_namespace)
+ self.sio.on('join', self.admin_enter_room,
+ namespace=self.admin_namespace)
+ self.sio.on('leave', self.admin_leave_room,
+ namespace=self.admin_namespace)
+ self.sio.on('_disconnect', self.admin_disconnect,
+ namespace=self.admin_namespace)
+
+ # track socket connection times
+ self.sio.manager._timestamps = {}
+
+ # report socket.io connections
+ self.sio.manager.__connect = self.sio.manager.connect
+ self.sio.manager.connect = self._connect
+
+ # report socket.io disconnection
+ self.sio.manager.__disconnect = self.sio.manager.disconnect
+ self.sio.manager.disconnect = self._disconnect
+
+ # report join rooms
+ self.sio.manager.__enter_room = self.sio.manager.enter_room
+ self.sio.manager.enter_room = self._enter_room
+
+ # report leave rooms
+ self.sio.manager.__leave_room = self.sio.manager.leave_room
+ self.sio.manager.leave_room = self._leave_room
+
+ # report emit events
+ self.sio.__emit_internal = self.sio._emit_internal
+ self.sio._emit_internal = self._emit_internal
+
+ # report receive events
+ self.sio.__handle_event_internal = self.sio._handle_event_internal
+ self.sio._handle_event_internal = self._handle_event_internal
+
+ # report engine.io connections
+ self.sio.eio.on('connect', self._handle_eio_connect)
+ self.sio.eio.on('disconnect', self._handle_eio_disconnect)
+
+ # report polling packets
+ from engineio.socket import Socket
+ self.sio.eio.__ok = self.sio.eio._ok
+ self.sio.eio._ok = self._eio_http_response
+ Socket.__handle_post_request = functools.partialmethod(
+ self._eio_handle_post_request)
+
+ # report websocket packets
+ Socket.__websocket_handler = Socket._websocket_handler
+ Socket._websocket_handler = functools.partialmethod(
+ self._eio_websocket_handler)
+
+ # start thread that emits "server_stats" every 2 seconds
+ self.sio.start_background_task(self._emit_server_stats)
+
+ def _connect(self, eio_sid, namespace):
+ sid = self.sio.manager.__connect(eio_sid, namespace)
+ t = time.time()
+ self.sio.manager._timestamps[sid] = t
+ serialized_socket = self.serialize_socket(sid, namespace, eio_sid)
+ self.sio.emit('socket_connected', (
+ serialized_socket,
+ datetime.utcfromtimestamp(t).isoformat() + 'Z',
+ ), namespace=self.admin_namespace)
+
+ def check_for_upgrade():
+ for _ in range(5):
+ self.sio.sleep(5)
+ if self.sio.eio._get_socket(eio_sid).upgraded:
+ self.sio.emit('socket_updated', {
+ 'id': sid,
+ 'nsp': namespace,
+ 'transport': 'websocket',
+ }, namespace=self.admin_namespace)
+ break
+
+ if serialized_socket['transport'] == 'polling':
+ self.sio.start_background_task(check_for_upgrade)
+ return sid
+
+ def _disconnect(self, sid, namespace, **kwargs):
+ del self.sio.manager._timestamps[sid]
+ self.sio.emit('socket_disconnected', (
+ namespace,
+ sid,
+ 'N/A',
+ datetime.utcnow().isoformat() + 'Z',
+ ), namespace=self.admin_namespace)
+ return self.sio.manager.__disconnect(sid, namespace, **kwargs)
+
+ def _enter_room(self, sid, namespace, room, eio_sid=None):
+ ret = self.sio.manager.__enter_room(sid, namespace, room, eio_sid)
+ if room:
+ self.sio.emit('room_joined', (
+ namespace,
+ room,
+ sid,
+ datetime.utcnow().isoformat() + 'Z',
+ ), namespace=self.admin_namespace)
+ return ret
+
+ def _leave_room(self, sid, namespace, room):
+ if room:
+ self.sio.emit('room_left', (
+ namespace,
+ room,
+ sid,
+ datetime.utcnow().isoformat() + 'Z',
+ ), namespace=self.admin_namespace)
+ return self.sio.manager.__leave_room(sid, namespace, room)
+
+ def _emit_internal(self, eio_sid, event, data, namespace=None, id=None):
+ ret = self.sio.__emit_internal(eio_sid, event, data,
+ namespace=namespace, id=id)
+ if namespace != self.admin_namespace:
+ sid = self.sio.manager.sid_from_eio_sid(eio_sid, namespace)
+ self.sio.emit('event_sent', (
+ namespace,
+ sid,
+ [event] + list(data) if isinstance(data, tuple) else [data],
+ datetime.utcnow().isoformat() + 'Z',
+ ), namespace=self.admin_namespace)
+ return ret
+
+ def _handle_event_internal(self, server, sid, eio_sid, data, namespace,
+ id):
+ ret = self.sio.__handle_event_internal(server, sid, eio_sid, data,
+ namespace, id)
+ self.sio.emit('event_received', (
+ namespace,
+ sid,
+ data,
+ datetime.utcnow().isoformat() + 'Z',
+ ), namespace=self.admin_namespace)
+ return ret
+
+ def _handle_eio_connect(self, eio_sid, environ):
+ self.event_buffer.push('rawConnection')
+ return self.sio._handle_eio_connect(eio_sid, environ)
+
+ def _handle_eio_disconnect(self, eio_sid):
+ self.event_buffer.push('rawDisconnection')
+ return self.sio._handle_eio_disconnect(eio_sid)
+
+ def _eio_http_response(self, packets=None, headers=None, jsonp_index=None):
+ ret = self.sio.eio.__ok(packets=packets, headers=headers,
+ jsonp_index=jsonp_index)
+ self.event_buffer.push('packetsOut')
+ self.event_buffer.push('bytesOut', len(ret['response']))
+ return ret
+
+ def _eio_handle_post_request(self, socket, environ):
+ ret = socket._original_handle_post_request(environ)
+ self.event_buffer.push('packetsIn')
+ self.event_buffer.push(
+ 'bytesIn', int(environ.get('CONTENT_LENGTH', 0)))
+ return ret
+
+ def _eio_websocket_handler(self, socket, ws):
+ def _send(ws, data, control_code=None):
+ self.event_buffer.push('packetsOut')
+ self.event_buffer.push('bytesOut', len(data))
+ return ws.__send(data, control_code=control_code)
+
+ def _wait(ws):
+ ret = ws.__wait()
+ self.event_buffer.push('packetsIn')
+ self.event_buffer.push('bytesIn', len(ret))
+ return ret
+
+ ws.__send = ws.send
+ ws.send = functools.partial(_send, ws)
+ ws.__wait = ws.wait
+ ws.wait = functools.partial(_wait, ws)
+ return socket.__websocket_handler(ws)
+
+ def _emit_server_stats(self):
+ start_time = time.time()
+ while True:
+ self.sio.sleep(2)
+ self.sio.emit('server_stats', {
+ 'serverId': self.server_id,
+ 'hostname': HOSTNAME,
+ 'pid': PID,
+ 'uptime': time.time() - start_time,
+ 'clientsCount': len(self.sio.eio.sockets),
+ 'pollingClientsCount': len(
+ [s for s in self.sio.eio.sockets.values()
+ if not s.upgraded]),
+ 'aggregatedEvents': self.event_buffer.get_and_clear(),
+ 'namespaces': [{
+ 'name': nsp,
+ 'socketsCount': len(self.sio.manager.rooms[nsp][None])
+ } for nsp in self.sio.manager.get_namespaces()],
+ }, namespace=self.admin_namespace)
+
+ def serialize_socket(self, sid, namespace, eio_sid=None):
+ if eio_sid is None:
+ eio_sid = self.sio.manager.eio_sid_from_sid(sid)
+ socket = self.sio.eio._get_socket(eio_sid)
+ environ = self.sio.environ.get(eio_sid, {})
+ return {
+ 'id': sid,
+ 'clientId': eio_sid,
+ 'transport': 'websocket' if socket.upgraded else 'polling',
+ 'nsp': namespace,
+ 'data': {},
+ 'handshake': {
+ 'address': environ.get('REMOTE_ADDR', ''),
+ 'headers': {k[5:].lower(): v for k, v in environ.items()
+ if k.startswith('HTTP_')},
+ 'query': {k: v[0] if len(v) == 1 else v for k, v in parse_qs(
+ environ.get('QUERY_STRING', '')).items()},
+ 'secure': environ.get('wsgi.url_scheme', '') == 'https',
+ 'url': environ.get('PATH_INFO', ''),
+ 'issued': self.sio.manager._timestamps[sid] * 1000,
+ 'time': datetime.utcfromtimestamp(
+ self.sio.manager._timestamps[sid]).isoformat() + 'Z',
+ },
+ 'rooms': self.sio.manager.get_rooms(sid, namespace),
+ }
diff --git a/src/socketio/server.py b/src/socketio/server.py
index 275e530..041dbe7 100644
--- a/src/socketio/server.py
+++ b/src/socketio/server.py
@@ -454,6 +454,35 @@ class Server(base_server.BaseServer):
"""
return self.eio.sleep(seconds)
+ def instrument(self, auth=None, mode='development', read_only=False,
+ server_id=None, namespace='/admin'):
+ """Instrument the Socket.IO server for monitoring with the `Socket.IO
+ Admin UI `_.
+
+ :param auth: A function that receives a dictionary with the credentials
+ provided by the client (usually ``username`` and
+ ``password``) and returns ``True`` if the user is allowed.
+ To disable authentication, set this argument to ``False``
+ (not recommended, never do this on a production server).
+ :param mode: The reporting mode. The default is ``'development'``,
+ which is best used while debugging, as it may have a
+ significant performance effect. Set to ``'production'`` to
+ reduce the amount of information that is reported to the
+ admin UI.
+ :param read_only: If set to ``True``, the admin interface will be
+ read-only, with no option to modify room assignments
+ or disconnect clients. The default is ``False``.
+ :param server_id: The server name to use for this server. If this
+ argument is omitted, the server generates its own
+ name.
+ :param namespace: The Socket.IO namespace to use for the admin
+ interface. The default is ``/admin``.
+ """
+ from .admin import InstrumentedServer
+ return InstrumentedServer(self, auth=auth, mode=mode,
+ read_only=read_only, server_id=server_id,
+ namespace=namespace)
+
def _send_packet(self, eio_sid, pkt):
"""Send a Socket.IO packet to a client."""
encoded_packet = pkt.encode()