perf: allow disabling websocket per-message-deflate (#28613)
With delta streaming most websocket frames are tiny per-token deltas, and per-message-deflate pays zlib work on every outgoing frame per subscriber for near-zero gain there; under heavy streaming that shows up as measurable server CPU. The frames that still benefit are the rare large ones (final message, sources), and even a 100k token message is only a few hundred KB uncompressed, which any network delivers without noticeable delay. UVICORN_WS_PER_MESSAGE_DEFLATE=false (default true, current behavior) disables the extension in every entry point: open-webui serve and dev, start.sh both invocations, start_windows.bat and dev.sh. Verified against a running instance: with the flag off the server declines the client-offered permessage-deflate extension, with defaults it still negotiates it.
This commit is contained in:
1 parent
97466deea1
commit
bf08835d6f
5 files changed
+13
-5
No files matched your search
+1
-1
@@ -1,3 +1,3 @@
|
|||||||
export CORS_ALLOW_ORIGIN="http://localhost:5173;http://localhost:8080"
|
export CORS_ALLOW_ORIGIN="http://localhost:5173;http://localhost:8080"
|
||||||
PORT="${PORT:-8080}"
|
PORT="${PORT:-8080}"
|
||||||
uvicorn open_webui.main:app --port $PORT --host 0.0.0.0 --forwarded-allow-ips "${FORWARDED_ALLOW_IPS:-*}" --reload
|
uvicorn open_webui.main:app --port $PORT --host 0.0.0.0 --forwarded-allow-ips "${FORWARDED_ALLOW_IPS:-*}" --ws-per-message-deflate "${UVICORN_WS_PER_MESSAGE_DEFLATE:-true}" --reload
|
||||||
@@ -74,7 +74,7 @@ def serve(
|
|||||||
os.environ['LD_LIBRARY_PATH'] = ':'.join(LD_LIBRARY_PATH)
|
os.environ['LD_LIBRARY_PATH'] = ':'.join(LD_LIBRARY_PATH)
|
||||||
|
|
||||||
import open_webui.main # noqa: F401
|
import open_webui.main # noqa: F401
|
||||||
from open_webui.env import UVICORN_WORKERS # Import the workers setting
|
from open_webui.env import UVICORN_WORKERS, UVICORN_WS_PER_MESSAGE_DEFLATE
|
||||||
|
|
||||||
# On Windows, uvicorn's default loop factory hardcodes ProactorEventLoop,
|
# On Windows, uvicorn's default loop factory hardcodes ProactorEventLoop,
|
||||||
# which is incompatible with psycopg v3 async. Setting loop='none' lets
|
# which is incompatible with psycopg v3 async. Setting loop='none' lets
|
||||||
@@ -87,6 +87,7 @@ def serve(
|
|||||||
port=port,
|
port=port,
|
||||||
forwarded_allow_ips='*',
|
forwarded_allow_ips='*',
|
||||||
workers=UVICORN_WORKERS,
|
workers=UVICORN_WORKERS,
|
||||||
|
ws_per_message_deflate=UVICORN_WS_PER_MESSAGE_DEFLATE,
|
||||||
loop=loop,
|
loop=loop,
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -97,12 +98,15 @@ def dev(
|
|||||||
port: int = 8080,
|
port: int = 8080,
|
||||||
reload: bool = True,
|
reload: bool = True,
|
||||||
):
|
):
|
||||||
|
from open_webui.env import UVICORN_WS_PER_MESSAGE_DEFLATE
|
||||||
|
|
||||||
uvicorn.run(
|
uvicorn.run(
|
||||||
'open_webui.main:app',
|
'open_webui.main:app',
|
||||||
host=host,
|
host=host,
|
||||||
port=port,
|
port=port,
|
||||||
reload=reload,
|
reload=reload,
|
||||||
forwarded_allow_ips='*',
|
forwarded_allow_ips='*',
|
||||||
|
ws_per_message_deflate=UVICORN_WS_PER_MESSAGE_DEFLATE,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -443,6 +443,9 @@ try:
|
|||||||
except (ValueError, TypeError):
|
except (ValueError, TypeError):
|
||||||
UVICORN_WORKERS = 1
|
UVICORN_WORKERS = 1
|
||||||
|
|
||||||
|
# tiny delta-stream frames make per-frame websocket compression CPU-bound, allow opting out (true/false)
|
||||||
|
UVICORN_WS_PER_MESSAGE_DEFLATE = os.getenv('UVICORN_WS_PER_MESSAGE_DEFLATE', 'True').lower() == 'true'
|
||||||
|
|
||||||
####################################
|
####################################
|
||||||
# WEBSOCKET SUPPORT
|
# WEBSOCKET SUPPORT
|
||||||
####################################
|
####################################
|
||||||
|
|||||||
+2
-2
@@ -72,7 +72,7 @@ if [[ -n "${SPACE_ID:-}" ]]; then
|
|||||||
if [[ -n "${ADMIN_USER_EMAIL:-}" && -n "${ADMIN_USER_PASSWORD:-}" ]]; then
|
if [[ -n "${ADMIN_USER_EMAIL:-}" && -n "${ADMIN_USER_PASSWORD:-}" ]]; then
|
||||||
echo "Creating admin user for Space..."
|
echo "Creating admin user for Space..."
|
||||||
WEBUI_SECRET_KEY="${WEBUI_SECRET_KEY:-}" \
|
WEBUI_SECRET_KEY="${WEBUI_SECRET_KEY:-}" \
|
||||||
uvicorn open_webui.main:app --host "$HOST" --port "$PORT" --forwarded-allow-ips "${FORWARDED_ALLOW_IPS:-*}" &
|
uvicorn open_webui.main:app --host "$HOST" --port "$PORT" --forwarded-allow-ips "${FORWARDED_ALLOW_IPS:-*}" --ws-per-message-deflate "${UVICORN_WS_PER_MESSAGE_DEFLATE:-true}" &
|
||||||
webui_pid=$!
|
webui_pid=$!
|
||||||
|
|
||||||
echo "Waiting for server to become healthy..."
|
echo "Waiting for server to become healthy..."
|
||||||
@@ -102,7 +102,7 @@ UVICORN_WORKERS="${UVICORN_WORKERS:-1}"
|
|||||||
if [[ "$#" -gt 0 ]]; then
|
if [[ "$#" -gt 0 ]]; then
|
||||||
ARGS=("$@")
|
ARGS=("$@")
|
||||||
else
|
else
|
||||||
ARGS=(--workers "$UVICORN_WORKERS")
|
ARGS=(--workers "$UVICORN_WORKERS" --ws-per-message-deflate "${UVICORN_WS_PER_MESSAGE_DEFLATE:-true}")
|
||||||
fi
|
fi
|
||||||
|
|
||||||
exec env WEBUI_SECRET_KEY="${WEBUI_SECRET_KEY:-}" \
|
exec env WEBUI_SECRET_KEY="${WEBUI_SECRET_KEY:-}" \
|
||||||
|
|||||||
@@ -55,5 +55,6 @@ IF "%WEBUI_SECRET_KEY% %WEBUI_JWT_SECRET_KEY%" == " " (
|
|||||||
:: Execute uvicorn
|
:: Execute uvicorn
|
||||||
SET "WEBUI_SECRET_KEY=%WEBUI_SECRET_KEY%"
|
SET "WEBUI_SECRET_KEY=%WEBUI_SECRET_KEY%"
|
||||||
IF "%UVICORN_WORKERS%"=="" SET UVICORN_WORKERS=1
|
IF "%UVICORN_WORKERS%"=="" SET UVICORN_WORKERS=1
|
||||||
uvicorn open_webui.main:app --host "%HOST%" --port "%PORT%" --forwarded-allow-ips %FORWARDED_ALLOW_IPS% --workers %UVICORN_WORKERS% --ws auto
|
if "%UVICORN_WS_PER_MESSAGE_DEFLATE%" == "" set "UVICORN_WS_PER_MESSAGE_DEFLATE=true"
|
||||||
|
uvicorn open_webui.main:app --host "%HOST%" --port "%PORT%" --forwarded-allow-ips %FORWARDED_ALLOW_IPS% --workers %UVICORN_WORKERS% --ws auto --ws-per-message-deflate %UVICORN_WS_PER_MESSAGE_DEFLATE%
|
||||||
:: For ssl user uvicorn open_webui.main:app --host "%HOST%" --port "%PORT%" --forwarded-allow-ips '*' --ssl-keyfile "key.pem" --ssl-certfile "cert.pem" --ws auto
|
:: For ssl user uvicorn open_webui.main:app --host "%HOST%" --port "%PORT%" --forwarded-allow-ips '*' --ssl-keyfile "key.pem" --ssl-certfile "cert.pem" --ws auto
|
||||||
Reference in new issue
Block a user