Skip to content

Commit eb0cd67

Browse files
ENG-12238: document Reflex app scaling and recovery (#7570)
* ENG-12238: document Reflex app scaling and recovery * ENG-12238: illustrate scaling architecture and job recovery * ENG-12238: address scaling guide review and test job recovery * ENG-12238: reset report selection on authentication changes * ENG-12238: require explicit report requests and isolate docs tests --------- Co-authored-by: Farhan Ali Raza <62690310+FarhanAliRaza@users.noreply.github.com>
1 parent 05329d0 commit eb0cd67

10 files changed

Lines changed: 1006 additions & 5 deletions

File tree

β€Ždocs/advanced_onboarding/performance_and_execution.mdβ€Ž

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ meta_description: Compare Reflex performance with Streamlit and Dash using publi
55

66
# Performance and execution
77

8+
For deployment-level capacity and recovery, see [Scaling Reflex Apps](/docs/hosting/scaling/),
9+
including shared state, independent job workers, and Redis diagnostics.
10+
811
Reflex combines a customizable React interface with explicit Python state and event handlers. Published comparisons show concrete performance gains over Streamlit and Dash: faster initial data visibility in an NBA dashboard and faster bulk updates in a component-heavy form. The measurements below explain where those gains appeared and how to apply the same rendering and state-management techniques in your app.
912

1013
## Reflex vs Streamlit: faster time to visible data

β€Ždocs/ai_builder/integrations/mcp_overview.mdβ€Ž

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,16 @@ The hosted server is available at:
1212
https://build.reflex.dev/mcp
1313
```
1414

15-
## Available tool
15+
## Documentation tools
1616

17-
The server currently exposes one read-only tool:
17+
Check your server's `tools/list` response for the tools available in its deployed version. Releases with the knowledge tools provide two read-only documentation operations:
1818

19-
- `search_docs(query)` searches the Reflex documentation index and returns the relevant documentation sections and their source paths.
19+
- `search_reflex_knowledge(queries)` accepts up to five short keyword queries and returns candidate keys, summaries, and source labels from the bundled documentation and curated knowledge.
20+
- `get_reflex_knowledge(keys)` fetches the full text for the exact keys returned by search. Fetch the relevant entries before relying on a summary; the server reports unknown keys separately.
21+
22+
For example, search with `{"queries": ["horizontal scaling", "durable jobs", "Redis Sentinel"]}`, then pass the relevant returned key to `get_reflex_knowledge`. The [scaling guide](/docs/hosting/scaling/) explains version compatibility, regional session state, and recovery assumptions. Split more than five topics into separate search calls.
23+
24+
Older deployments may expose `search_docs` instead. Follow the tool schema advertised by the connected server. The knowledge tools use a packaged documentation snapshot, so a website update alone does not refresh the server's corpus; the server release must also update its locked documentation bundle.
2025

2126
Use it for questions about Reflex APIs, components, configuration, and development workflows. Review the returned source before applying a change that depends on version-specific behavior.
2227

Lines changed: 121 additions & 0 deletions
Loading
Lines changed: 75 additions & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add a scaling guide with production architecture and job lifecycle diagrams and a Reflex report-job example, covering horizontal backends, state-store version compatibility, durable jobs, regional data routing, telemetry, and Redis recovery checks.

β€Ždocs/app/reflex_docs/templates/docpage/sidebar/sidebar_items/learn.pyβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,7 @@ def get_sidebar_items_hosting():
260260
"Self Hosting",
261261
children=[
262262
hosting.self_hosting,
263+
hosting.scaling,
263264
hosting.databricks,
264265
hosting.cloud_providers,
265266
hosting.bring_your_own_cloud,

0 commit comments

Comments
Β (0)