From aed296660f0a732adff1467656e712de26115669 Mon Sep 17 00:00:00 2001 From: Adam Skalicky Date: Mon, 10 Nov 2025 17:34:02 -0800 Subject: [PATCH 1/3] Added logging for WEBSOCKET_REDIS_OPTIONS, WEBSOCKET_SERVER_LOGGING, WEBSOCKET_SERVER_ENGINEIO_LOGGING, WEBSOCKET_SERVER_PING_TIMEOUT, WEBSOCKET_SERVER_PING_INTERVAL --- docs/getting-started/env-configuration.mdx | 40 ++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/docs/getting-started/env-configuration.mdx b/docs/getting-started/env-configuration.mdx index 769ad647e..1af1ff07d 100644 --- a/docs/getting-started/env-configuration.mdx +++ b/docs/getting-started/env-configuration.mdx @@ -4466,6 +4466,46 @@ This option has no effect if `WEBSOCKET_SENTINEL_HOSTS` is defined. ::: +#### `WEBSOCKET_REDIS_OPTIONS` + +- Type: `str` +- Default: `{}` +- Description: A string representation of a dictionary containing additional Redis connection options for the websocket Redis client. This allows you to specify advanced connection parameters such as SSL settings, timeouts, or other Redis client configurations that are not covered by the standard `WEBSOCKET_REDIS_URL`. The string should be formatted as a valid Python dictionary. For example: `{"retry_on_timeout": true, "socket_connect_timeout": 5, "socket_timeout": 5, "max_connections": 8}`. All JSON encodable options listed [here] (https://redis.readthedocs.io/en/stable/connections.html) can be used. + +#### `WEBSOCKET_SERVER_LOGGING` + +- Type: `bool` +- Default: `false` +- Description: Controls logging for SocketIO server related to websocket operations. + +:::warning + +**This can be very verbose, it is only recommended to use this flag when debugging Redis related issues.** + +#### `WEBSOCKET_SERVER_ENGINEIO_LOGGING` + +- Type: `bool` +- Default: `false` +- Description: Controls logging for EngineIO server related to websocket operations. + +:::warning + +**This can be very verbose, it is only recommended to use this flag when debugging Redis related issues.** + + +#### `WEBSOCKET_SERVER_PING_TIMEOUT` + +- Type: `int` +- Default: `20` +- Description: The timeout for a ping to Redis in seconds. + +#### `WEBSOCKET_SERVER_PING_INTERVAL` + +- Type: `int` +- Default: `25` +- Description: The frequency for a ping to Redis in seconds. + + #### `ENABLE_STAR_SESSIONS_MIDDLEWARE` - Type: `bool` - Default: `False` From 9341e92b47c337de8f6576bfc2fa6f7fa5382a86 Mon Sep 17 00:00:00 2001 From: Adam Skalicky Date: Tue, 18 Nov 2025 12:58:10 -0800 Subject: [PATCH 2/3] Update env-configuration.mdx Added note about SSM and Compose escaping the quotes. --- docs/getting-started/env-configuration.mdx | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/getting-started/env-configuration.mdx b/docs/getting-started/env-configuration.mdx index 1af1ff07d..277cb718a 100644 --- a/docs/getting-started/env-configuration.mdx +++ b/docs/getting-started/env-configuration.mdx @@ -4472,6 +4472,11 @@ This option has no effect if `WEBSOCKET_SENTINEL_HOSTS` is defined. - Default: `{}` - Description: A string representation of a dictionary containing additional Redis connection options for the websocket Redis client. This allows you to specify advanced connection parameters such as SSL settings, timeouts, or other Redis client configurations that are not covered by the standard `WEBSOCKET_REDIS_URL`. The string should be formatted as a valid Python dictionary. For example: `{"retry_on_timeout": true, "socket_connect_timeout": 5, "socket_timeout": 5, "max_connections": 8}`. All JSON encodable options listed [here] (https://redis.readthedocs.io/en/stable/connections.html) can be used. +:::warning + +**AWS SSM and Docker compose cannot ingest raw JSON, as such you need top escape any double quotes like the following:** +`{\"retry_on_timeout\": true, \"socket_connect_timeout\": 5, \"socket_timeout\": 5, \"max_connections\": 8}` + #### `WEBSOCKET_SERVER_LOGGING` - Type: `bool` From 591a027a04f18a6787ec9a5dcf6ed13466df994b Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Wed, 19 Nov 2025 11:23:20 +0100 Subject: [PATCH 3/3] Update env-configuration.mdx --- docs/getting-started/env-configuration.mdx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/env-configuration.mdx b/docs/getting-started/env-configuration.mdx index 277cb718a..d493df880 100644 --- a/docs/getting-started/env-configuration.mdx +++ b/docs/getting-started/env-configuration.mdx @@ -4477,6 +4477,8 @@ This option has no effect if `WEBSOCKET_SENTINEL_HOSTS` is defined. **AWS SSM and Docker compose cannot ingest raw JSON, as such you need top escape any double quotes like the following:** `{\"retry_on_timeout\": true, \"socket_connect_timeout\": 5, \"socket_timeout\": 5, \"max_connections\": 8}` +::: + #### `WEBSOCKET_SERVER_LOGGING` - Type: `bool` @@ -4487,6 +4489,8 @@ This option has no effect if `WEBSOCKET_SENTINEL_HOSTS` is defined. **This can be very verbose, it is only recommended to use this flag when debugging Redis related issues.** +::: + #### `WEBSOCKET_SERVER_ENGINEIO_LOGGING` - Type: `bool` @@ -4497,6 +4501,7 @@ This option has no effect if `WEBSOCKET_SENTINEL_HOSTS` is defined. **This can be very verbose, it is only recommended to use this flag when debugging Redis related issues.** +::: #### `WEBSOCKET_SERVER_PING_TIMEOUT` @@ -4510,7 +4515,6 @@ This option has no effect if `WEBSOCKET_SENTINEL_HOSTS` is defined. - Default: `25` - Description: The frequency for a ping to Redis in seconds. - #### `ENABLE_STAR_SESSIONS_MIDDLEWARE` - Type: `bool` - Default: `False`