Zeema
New design
Catalogue / realtime-gateway

Liveblocks

Real-time gatewayliveblocks

Hosted realtime collaboration infrastructure with per-room presence and storage.

Provider
default
Kind
Real-time gateway
Category
Edge
Official docs
https://liveblocks.io/docs/platform/limits
Properties · 4 set by this component
propertytypevaluesrequiredkind defaultthis component
ackIntervalSeconds · advancedinteger—no—inherited
autoscalingboolean—nofalse▸ true
broadcastMessageSizeMb · component propertyinteger—no32inherited
channelAssignment · advancedenumrandom | hash | stickynorandominherited
drainOnScaleIn · advancedboolean—nofalseinherited
liveObjectSizeMb · component propertyinteger—no2inherited
managedboolean—nofalse▸ true
plan · component propertyenumfree | pro | enterprisenofreeinherited
protocolenumwebsocket | sse | long-poll | grpc-stream | udp-multicastnowebsocket▸ websocket
pushFallback · advancedboolean—nofalseinherited
roomIdMaxLength · component propertyinteger—no128inherited
sequenceNumbers · advancedboolean—nofalseinherited
stampedeGuard · advancedboolean—nofalseinherited
statefulboolean—notrue▸ true
subscriptionsPerUser · advancedinteger—no—inherited
Rules that apply · 3

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

Reconnect stampede without guarderror
reconnect-stampede-without-guard

When a gateway holding millions of sockets restarts, every client reconnects at once and the gateway asks the coordination service about each of them. Without a stampede guard that lookup storm takes the coordination service down too.

  • — all of these hold:
  • — the node has at least one synchronous outgoing edge to a coordination-service
  • — the node's `stampedeGuard` is false
Random channel placement under heavy-tail trafficerror
shared-host-per-channel-without-isolation

With heavy-tail traffic a few channels carry most of the load. Assigning channels at random lands those hot channels on arbitrary hosts, and every tenant sharing a host suffers for it.

  • — all of these hold:
  • — the node's `channelAssignment` is "random"
  • — the design requirement `traffic.skew` is "heavy-tail"
Stateful WebSocket scale-in without drainwarning
stateful-websocket-scale-in-without-drain

Scaling a gateway down kills every live WebSocket on the removed instance at once. Without a drain step those clients all reconnect together.

  • — all of these hold:
  • — the node's `autoscaling` is true
  • — the node's `drainOnScaleIn` is false
Use it in a design
nodes:
  - { id: "liveblocks", component: "liveblocks" }
Other Real-time gateway products · 19
API Gateway WebSocket APIaws-api-gateway-websocketawsrealtime-gatewayAWS AppSync Events APIaws-appsync-eventsawsrealtime-gatewayAmazon IVS Chataws-ivs-chatawsrealtime-gatewayAzure Fluid Relayazure-fluid-relayazurerealtime-gatewayAzure SignalR Serviceazure-signalrazurerealtime-gatewayAzure Web PubSubazure-web-pubsubazurerealtime-gatewayAblyablyrealtime-gatewayCentrifugocentrifugorealtime-gatewayMercuremercurerealtime-gatewayMulticast market-data feedmulticast-feedrealtime-gatewayPartyKitpartykitrealtime-gatewayPhoenix Channelsphoenix-channelsrealtime-gatewayPusher Channelspusherrealtime-gatewayPushpinpushpinrealtime-gatewayGeneric real-time gatewayrealtime-gatewayrealtime-gatewayASP.NET Core SignalRsignalrrealtime-gatewaySocket.IO serversocket-io-serverrealtime-gatewaySoketisoketirealtime-gatewayWebSocket gatewaywebsocket-gatewayrealtime-gateway
Source
# yaml-language-server: $schema=../../schema/component.schema.json
# Liveblocks: hosted realtime collaboration infrastructure. "WebSocket infrastructure" describes a
# managed WebSocket edge network on Cloudflare Workers that scales on its own and whose connection
# engine handles offline and reconnection automatically; "Limits" gives the 32 MB broadcast message
# size, the 2 MB per LiveObject and the 128 character room id.
schemaVersion: "1"
type: "component"
id: "liveblocks"
kind: "realtime-gateway"
provider: "default"
docs: "https://liveblocks.io/docs/platform/limits"
defaults:
  managed: true
  protocol: "websocket"
  stateful: true
  autoscaling: true
properties:
  plan:
    type: "enum"
    values: ["free", "pro", "enterprise"]
    default: "free"
  broadcastMessageSizeMb:
    type: "integer"
    default: 32
  liveObjectSizeMb:
    type: "integer"
    default: 2
  roomIdMaxLength:
    type: "integer"
    default: 128

The same page as markdown, for an agent: /catalogue/components/liveblocks.md