How to setup websocket for Superset?

[Neang-Rothmny]

Please can u help me to setup websocket for my superset.

For superset, I clone from github of superset and git checkout tag 4.1.2. And I use "docker compose -f docker-compose-image-tag.yml up" to create container for my superset.

Thank you!!

[dosubot[bot]]

To set up a WebSocket for Superset after cloning the repository and checking out tag 4.1.2, you need to ensure that your docker-compose.yml file includes a service definition for superset-websocket. Here's a configuration snippet that should be included:

superset-websocket:
    container_name: superset_websocket
    build: ./superset-websocket
    ports:
      - 8080:8080
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on:
      - redis
    volumes:
      - ./superset-websocket:/home/superset-websocket
      - /home/superset-websocket/node_modules
      - /home/superset-websocket/dist
      - ./docker/superset-websocket/config.json:/home/superset-websocket/config.json
    environment:
      - PORT=8080
      - REDIS_HOST=redis
      - REDIS_PORT=6379
      - REDIS_SSL=false

Make sure the superset-websocket directory and the config.json file exist in the specified paths. The config.json should include necessary configurations like port, logging, Redis settings, and JWT configurations. Here's an example of what the config.json might look like:

{
  "port": 8080,
  "logLevel": "info",
  "logToFile": false,
  "logFilename": "app.log",
  "statsd": {
    "host": "127.0.0.1",
    "port": 8125,
    "globalTags": []
  },
  "redis": {
    "port": 6379,
    "host": "127.0.0.1",
    "password": "",
    "db": 0,
    "ssl": false
  },
  "redisStreamPrefix": "async-events-",
  "jwtAlgorithms": ["HS256"],
  "jwtSecret": "CHANGE-ME-IN-PRODUCTION-GOTTA-BE-LONG-AND-SECRET",
  "jwtCookieName": "async-token",
  "pingSocketsIntervalMs": 30000,
  "socketResponseTimeoutMs": 10000,
  "gcChannelsIntervalMs": 60000
}

Ensure that your environment meets the requirements for Node.js and Redis as specified in the package.json and README files ^[1][2].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}

[Neang-Rothmny]

I cannot find necessary configurations like port, logging, Redis settings, and JWT configurations in config.py under superset directory for tag4.1.2.

Another thing, what should I change in superset_config.py?

[dosubot[bot]]

The configurations for WebSocket support, such as port, logging, Redis settings, and JWT configurations, are not found in config.py under the Superset directory. Instead, these settings are typically defined in the config.json file for the superset-websocket service. You should ensure that this file is correctly set up as per the example provided in the previous response.

For changes in superset_config.py, you need to enable WebSocket support by setting the following configurations:

FEATURE_FLAGS = {
    "GLOBAL_ASYNC_QUERIES": True
}

GLOBAL_ASYNC_QUERIES_TRANSPORT = "ws"
GLOBAL_ASYNC_QUERIES_WEBSOCKET_URL = "ws://<host>:<port>/"

Replace <host> and <port> with the appropriate values for your setup. These settings enable global asynchronous queries and specify the WebSocket transport and URL ^[1].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}

[Neang-Rothmny]

In superset_config.py.
"ws://:/" what should I change this?