WebSocket

Install

cargo install faucet-cli --features source-websocket
faucet init --source websocket

# Cargo.toml — use it as a library
cargo add faucet-source-websocket

Starter config

source:
  type: websocket
  config:
    url: ""    # REQUIRED — WebSocket endpoint, `ws://` or `wss://`.
    # auth: { type: none }    # one of: none, bearer, custom
      # --- Alternative variants — replace the block above with one of these ---
      # type: bearer
      # config:
        # token: ""    # REQUIRED
      #
      # type: custom
      # config:
        # headers: {}    # REQUIRED
    # subscribe_messages: []    # Subscription frames sent (in order) immediately after every (re)connect.
    # message_format: null    # How each incoming frame is converted into a record.
    # on_parse_error: null    # What to do when a `Json`-mode frame is not valid JSON.
    # envelope: false    # `false` (default) emits the record raw; `true` wraps it as `{ data, received_at, url }`.
    # ping_interval: 0    # If set, send a WebSocket Ping frame on this interval (seconds) to keep the connection alive through proxies/load balance…
    # max_messages: 0    # Stop after this many messages.
    # idle_timeout: 0    # Stop after this many seconds with no message.
    # reconnect: false    # Reconnect on transport error / non-1000 close.
    # reconnect_backoff: 1    # Base wait (seconds) for reconnect backoff.
    # reconnect_max_attempts: 0    # Cap on *consecutive* failed reconnects (resets on a received data frame — a handshake the server accepts and then closes still counts).
    # max_message_bytes: 0    # Bound the max WebSocket message/frame size (bytes) to prevent runaway memory.
    # batch_size: 1000    # Records per emitted `StreamPage`.
    # connect_timeout: 30    # Seconds allowed for the TCP connect + upgrade handshake and for sending the subscribe frames (default 30).

Capabilities

Config fields