Skip to content

Data Streams: update ha mode behavior for rust#3844

Merged
dev-dist merged 1 commit into
mainfrom
ha-mode-rust
Jun 2, 2026
Merged

Data Streams: update ha mode behavior for rust#3844
dev-dist merged 1 commit into
mainfrom
ha-mode-rust

Conversation

@dev-dist
Copy link
Copy Markdown
Collaborator

@dev-dist dev-dist commented Jun 2, 2026

This pull request updates the Data Streams SDK documentation to clarify and improve guidance on enabling High Availability (HA) mode for WebSocket connections. The changes focus on simplifying HA configuration, emphasizing automatic origin discovery from a single endpoint, and updating example code and explanations throughout the documentation.

Key documentation improvements:

High Availability Mode Clarification & Usage:

  • Updated HA mode documentation to explain that enabling WebSocketHighAvailability::Enabled with a single WebSocket URL allows the SDK to automatically discover and connect to multiple origins for improved reliability. This replaces the previous method of manually specifying multiple endpoints. [1] [2]
  • Added detailed descriptions of HA mode behavior, including origin discovery, deduplication of reports, partial and full reconnects, and the requirement that HA mode is only available on mainnet endpoints. [1] [2]

Code Example & API Reference Updates:

  • Revised all Rust code samples to use a single WebSocket URL when enabling HA mode, and updated method descriptions to reflect the new automatic origin discovery mechanism. [1] [2] [3] [4]
  • Updated tutorials and usage examples to demonstrate the new HA configuration pattern, including explanatory notes on automatic origin discovery. [1] [2] [3] [4]

General Documentation Consistency:

  • Replaced outdated references to manual multi-endpoint configuration with links to the improved HA mode documentation and clarified language throughout. [1] [2]
  • Updated feature lists and overviews to refer to "WebSocket streaming with HA mode" instead of "Multiple WebSocket endpoints (HA)" for clarity. [1] [2]

These changes make it easier for developers to enable and understand HA mode in the Data Streams SDK, reducing configuration complexity and improving reliability in production environments.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 2, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview Jun 2, 2026 9:57pm

Request Review

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

👋 dev-dist, thanks for creating this pull request!

To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team.

Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks!

@dev-dist dev-dist merged commit 6e74130 into main Jun 2, 2026
27 checks passed
@dev-dist dev-dist deleted the ha-mode-rust branch June 2, 2026 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants