Reporting to Socket.IO Admin UI #1164

miguelgrinberg · 2023-03-30T11:42:50Z

Instrumentation for sync server
Instrumentation for async server
Unit tests
Documentation
Multi-server support
- Enter and leave room requests should go on the message queue
- Nodes should routinely report their connected clients to all admins
- All nodes should emit "server_stats" at regular intervals, regardless of admins connected or not

codecov-commenter · 2023-03-30T11:45:33Z

Codecov Report

Merging #1164 (58f35db) into main (6bdc498) will not change coverage.
Report is 1 commits behind head on main.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##              main     #1164    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           29        31     +2     
  Lines         2021      2405   +384     
  Branches       373       431    +58     
==========================================
+ Hits          2021      2405   +384

Files	Coverage Δ
src/socketio/admin.py	`100.00% <100.00%> (ø)`
src/socketio/async_admin.py	`100.00% <100.00%> (ø)`
src/socketio/async_manager.py	`100.00% <100.00%> (ø)`
src/socketio/async_server.py	`100.00% <100.00%> (ø)`
src/socketio/async_simple_client.py	`100.00% <100.00%> (ø)`
src/socketio/base_manager.py	`100.00% <100.00%> (ø)`
src/socketio/server.py	`100.00% <100.00%> (ø)`
src/socketio/simple_client.py	`100.00% <100.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Seluj78 · 2023-04-12T07:20:34Z

Amazing thank you ! Can't wait to implement and test this :D

Seluj78 · 2023-05-09T08:04:51Z

Hi @miguelgrinberg :)

Is there any news on this ? :)

miguelgrinberg · 2023-05-09T09:35:53Z

@Seluj78 I think this implementation is complete, so you are welcome to use it.

I will not merge it until I come up with a good testing strategy though.

Seluj78 · 2023-06-06T14:15:58Z

Hi @miguelgrinberg

I tried testing it with Flask-Socketio, and here's the error I'm getting

  File "/Users/seluj78/Projects/xxx/.venv/src/python-socketio/src/socketio/admin.py", line 47, in __init__
    self.sio.manager.host_id if hasattr(self.sio.manager, 'host_id')
                                        ^^^^^^^^^^^^^^^^
AttributeError: 'SocketIO' object has no attribute 'manager'

The code:

socketio = SocketIO(application)
socketio.init_app(application, cors_allowed_origins="*")
InstrumentedServer(socketio, auth=False)

miguelgrinberg · 2023-06-06T18:19:14Z

@Seluj78 for Flask-SocketIO use this:

InstrumentedServer(socketio.server, auth=False)

Seluj78 · 2023-06-07T07:01:48Z

The server started without a problem now, but when I enter connection details (http://127.0.0.1:5000/admin and no auth) on https://admin.socket.io/#/, I get this error

  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/python-engineio/src/engineio/async_drivers/threading.py", line 23, in __call__
    return self.app(self)
           ^^^^^^^^^^^^^^
TypeError: InstrumentedServer._eio_websocket_handler() missing 1 required positional argument: 'ws'
post request handler error
Traceback (most recent call last):
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/python-engineio/src/engineio/server.py", line 430, in handle_request
    socket.handle_post_request(environ)
TypeError: InstrumentedServer._eio_handle_post_request() missing 1 required positional argument: 'environ'

Let me know if you need the full error log

miguelgrinberg · 2023-06-07T18:56:10Z

I think this is likely a mistake on my part, not something you are doing wrong. I tested mostly websocket connections. Are you working with polling connections?

EDIT: actually I don't know, it seems to work well for me. I'm using the app.py example from the Flask-SocketIO repo, with these changes:

diff --git a/example/app.py b/example/app.py
index 24c464e..bd275da 100644
--- a/example/app.py
+++ b/example/app.py
@@ -11,10 +11,13 @@ async_mode = None

 app = Flask(__name__)
 app.config['SECRET_KEY'] = 'secret!'
-socketio = SocketIO(app, async_mode=async_mode)
+socketio = SocketIO(app, async_mode=async_mode, cors_allowed_origins="https://admin.socket.io")
 thread = None
 thread_lock = Lock()

+from socketio.admin import InstrumentedServer
+InstrumentedServer(socketio.server, auth=False)
+

 def background_thread():
     """Example of how to send server generated events to clients."""

Seluj78 · 2023-06-21T13:59:39Z

Weird...

My code:

socketio = SocketIO(application)
socketio.init_app(application, cors_allowed_origins="*")
InstrumentedServer(socketio.server, auth=False)

And the error:

21-06-2023:15:56:58,894 WARNING  [/Users/seluj78/Projects/Datascientest/hub-backend/.venv/lib/python3.11/site-packages/werkzeug/_internal.py:187 (_log()] 75927:  * Debugger is active!
post request handler error
Traceback (most recent call last):
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/python-engineio/src/engineio/server.py", line 430, in handle_request
    socket.handle_post_request(environ)
TypeError: InstrumentedServer._eio_handle_post_request() missing 1 required positional argument: 'environ'
21-06-2023:15:57:07,118 ERROR    [/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/python-engineio/src/engineio/server.py:439 (handle_request()] 75927: post request handler error
Traceback (most recent call last):
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/python-engineio/src/engineio/server.py", line 430, in handle_request
    socket.handle_post_request(environ)
TypeError: InstrumentedServer._eio_handle_post_request() missing 1 required positional argument: 'environ'
Traceback (most recent call last):
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/lib/python3.11/site-packages/sentry_sdk/integrations/flask.py", line 88, in sentry_patched_wsgi_app
    return SentryWsgiMiddleware(lambda *a, **kw: old_app(self, *a, **kw))(
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/lib/python3.11/site-packages/sentry_sdk/integrations/wsgi.py", line 140, in __call__
    reraise(*_capture_exception(hub))
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/lib/python3.11/site-packages/sentry_sdk/_compat.py", line 54, in reraise
    raise value
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/lib/python3.11/site-packages/sentry_sdk/integrations/wsgi.py", line 133, in __call__
    rv = self.app(
         ^^^^^^^^^
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/lib/python3.11/site-packages/sentry_sdk/integrations/flask.py", line 88, in <lambda>
    return SentryWsgiMiddleware(lambda *a, **kw: old_app(self, *a, **kw))(
                                                 ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/lib/python3.11/site-packages/flask/app.py", line 2551, in __call__
    return self.wsgi_app(environ, start_response)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/flask-socketio/src/flask_socketio/__init__.py", line 43, in __call__
    return super(_SocketIOMiddleware, self).__call__(environ,
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/python-engineio/src/engineio/middleware.py", line 63, in __call__
    return self.engineio_app.handle_request(environ, start_response)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/lib/python3.11/site-packages/socketio/server.py", line 607, in handle_request
    return self.eio.handle_request(environ, start_response)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/python-engineio/src/engineio/server.py", line 410, in handle_request
    packets = socket.handle_get_request(
              ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/python-engineio/src/engineio/socket.py", line 103, in handle_get_request
    return getattr(self, '_upgrade_' + transport)(environ,
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/python-engineio/src/engineio/socket.py", line 158, in _upgrade_websocket
    return ws(environ, start_response)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/python-engineio/src/engineio/async_drivers/threading.py", line 23, in __call__
    return self.app(self)
           ^^^^^^^^^^^^^^
TypeError: InstrumentedServer._eio_websocket_handler() missing 1 required positional argument: 'ws'
post request handler error
Traceback (most recent call last):
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/python-engineio/src/engineio/server.py", line 430, in handle_request
    socket.handle_post_request(environ)
TypeError: InstrumentedServer._eio_handle_post_request() missing 1 required positional argument: 'environ'
21-06-2023:15:57:32,138 ERROR    [/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/python-engineio/src/engineio/server.py:439 (handle_request()] 75927: post request handler error
Traceback (most recent call last):
  File "/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/python-engineio/src/engineio/server.py", line 430, in handle_request
    socket.handle_post_request(environ)
TypeError: InstrumentedServer._eio_handle_post_request() missing 1 required positional argument: 'environ'
Invalid session _RekZpUcl1pM90fPAAAA (further occurrences of this error will be logged with level INFO)
21-06-2023:15:58:07,133 ERROR    [/Users/seluj78/Projects/Datascientest/hub-backend/.venv/src/python-engineio/src/engineio/server.py:742 (_log_error_once()] 75927: Invalid session _RekZpUcl1pM90fPAAAA (further occurrences of this error will be logged with level INFO)

miguelgrinberg · 2023-06-21T18:47:48Z

@Seluj78 I have pushed some fixes into this branch. Let me know if they help.

Seluj78 · 2023-09-11T14:15:03Z

I haven't tried in a while but I just cloned this branch again and installed it and it seems like it's working ! I just added InstrumentedServer(socketio.server, auth=False) to test it with https://admin.socket.io :) Can't wait for it to be merged !

miguelgrinberg · 2023-09-11T14:26:06Z

@Seluj78 the app.py examples in examples/server/wsgi and examples/server/asgi (in this PR branch) have the code to add instrumentation in the recommended way.

Seluj78 · 2023-09-11T14:36:34Z

@Seluj78 the app.py examples in examples/server/wsgi and examples/server/asgi (in this PR branch) have the code to add instrumentation in the recommended way.

Great ! I will check these out, I was just testing quickly.

Once you've merged this I will test it more thoroughly and deploy it in production where we have about 500 active connections at the same time.
Do you have any idea/benchmark of the performance impact that the instrumentation have ? It might not be a great idea to have it running in production if it slows down the server by a substantial amount.

miguelgrinberg · 2023-09-11T15:23:46Z

@Seluj78 if full instrumentation affects performance you can instrument for production mode, which disables the most expensive monitoring features. This is all based on the JavaScript implementation.

Seluj78 · 2023-09-11T15:38:26Z

Indeed I've just seen that, thank you. I was wondering what the performance impact is, but idk how to benchmark it. I'll try and see :)

miguelgrinberg force-pushed the admin-ui branch from 8d3feae to 388752c Compare April 1, 2023 15:29

miguelgrinberg mentioned this pull request Apr 11, 2023

Flask-SocketIO Admin UI miguelgrinberg/Flask-SocketIO#1964

Closed

miguelgrinberg force-pushed the admin-ui branch from 388752c to 7724895 Compare April 14, 2023 11:52

miguelgrinberg force-pushed the main branch from 7c42280 to 14b9f4f Compare April 14, 2023 12:00

miguelgrinberg force-pushed the admin-ui branch from 7724895 to ae34cfd Compare April 14, 2023 12:01

miguelgrinberg force-pushed the admin-ui branch 4 times, most recently from 732cd2b to e84e3c5 Compare September 10, 2023 18:28

miguelgrinberg force-pushed the admin-ui branch 6 times, most recently from 9c4b5db to b8251c4 Compare September 11, 2023 13:45

miguelgrinberg force-pushed the admin-ui branch 9 times, most recently from ab72863 to 0948832 Compare September 17, 2023 18:08

miguelgrinberg force-pushed the main branch from ab33cb7 to 8e3460c Compare September 19, 2023 14:37

miguelgrinberg force-pushed the admin-ui branch 3 times, most recently from 26e728f to eec1cff Compare October 8, 2023 19:33

miguelgrinberg added 11 commits October 14, 2023 16:10

Reporting to Socket.IO Admin UI

50896b4

Make async client manager connect a coroutine

af68184

async server instrumentation

62a483f

Bug fixes

8423bec

Updates for recent changes in main

ee86b0e

tests

b374777

documentation

1db5ddc

Correct capability flags for production modes

d40d475

Changes following internal refactorings

e3fc32d

Support for multiple servers

93c8cb3

fix example code

7a1796c

miguelgrinberg force-pushed the admin-ui branch from eec1cff to 7a1796c Compare October 14, 2023 15:10

miguelgrinberg added 3 commits October 14, 2023 20:23

concurrency fine tuning

9cc4177

more fixes

b944b57

Adjust test timings

58f35db

miguelgrinberg merged commit 4bf4877 into main Oct 15, 2023
19 checks passed

miguelgrinberg deleted the admin-ui branch October 15, 2023 11:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reporting to Socket.IO Admin UI #1164

Reporting to Socket.IO Admin UI #1164

miguelgrinberg commented Mar 30, 2023 •

edited

Loading

codecov-commenter commented Mar 30, 2023 •

edited

Loading

Seluj78 commented Apr 12, 2023

Seluj78 commented May 9, 2023

miguelgrinberg commented May 9, 2023

Seluj78 commented Jun 6, 2023

miguelgrinberg commented Jun 6, 2023

Seluj78 commented Jun 7, 2023

miguelgrinberg commented Jun 7, 2023 •

edited

Loading

Seluj78 commented Jun 21, 2023

miguelgrinberg commented Jun 21, 2023

Seluj78 commented Sep 11, 2023

miguelgrinberg commented Sep 11, 2023

Seluj78 commented Sep 11, 2023 •

edited

Loading

miguelgrinberg commented Sep 11, 2023

Seluj78 commented Sep 11, 2023

Reporting to Socket.IO Admin UI #1164

Reporting to Socket.IO Admin UI #1164

Conversation

miguelgrinberg commented Mar 30, 2023 • edited Loading

codecov-commenter commented Mar 30, 2023 • edited Loading

Codecov Report

Seluj78 commented Apr 12, 2023

Seluj78 commented May 9, 2023

miguelgrinberg commented May 9, 2023

Seluj78 commented Jun 6, 2023

miguelgrinberg commented Jun 6, 2023

Seluj78 commented Jun 7, 2023

miguelgrinberg commented Jun 7, 2023 • edited Loading

Seluj78 commented Jun 21, 2023

miguelgrinberg commented Jun 21, 2023

Seluj78 commented Sep 11, 2023

miguelgrinberg commented Sep 11, 2023

Seluj78 commented Sep 11, 2023 • edited Loading

miguelgrinberg commented Sep 11, 2023

Seluj78 commented Sep 11, 2023

miguelgrinberg commented Mar 30, 2023 •

edited

Loading

codecov-commenter commented Mar 30, 2023 •

edited

Loading

miguelgrinberg commented Jun 7, 2023 •

edited

Loading

Seluj78 commented Sep 11, 2023 •

edited

Loading