Skip to content

Commit a437979

Browse files
committed
More precise wording for the subscriptions RAM issue
modified: docs/sdk/reference/graphql-server/configuration/subscriptions.md modified: docs/sdk/reference/graphql-server/overview.md
1 parent 5c9bf8b commit a437979

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/sdk/reference/graphql-server/configuration/subscriptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Subscribe to updates over a websocket
77
# Subscriptions
88

99
:::danger
10-
Implementation of subscriptions by the SQD GraphQL server [leaks memory under load](/sdk/reference/graphql-server/overview/#known-issues). Do not use it in scenarios where more than a few users simultaneously maintain connections to the server. This includes most production usage scenarios.
10+
RAM usage of subscriptions scales poorly under high load, making the feature unsuitable for most production uses. There are currently no plans to fix this issue.
1111
:::
1212

1313
OpenReader supports [GraphQL subscriptions](https://www.apollographql.com/docs/react/data/subscriptions/) via live queries. To use these, a client opens a websocket connection to the server and sends a `subscription` query there. The query body is then repeatedly executed (every 5 seconds by default) and the results are sent to the client whenever they change.

docs/sdk/reference/graphql-server/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,6 @@ The OpenReader GraphQL API defines the following custom scalar types:
4444

4545
## Known issues
4646

47-
- [Subscriptions](/sdk/reference/graphql-server/configuration/subscriptions) leak memory under load and are thus unsuitable for use in production.
47+
- RAM usage of [subscriptions](/sdk/reference/graphql-server/configuration/subscriptions) scales poorly under high load, making the feature unsuitable for most production uses. There are currently no plans to fix this issue.
4848
- Setting up custom resolvers for subscriptions is unreasonably hard.
4949
- `@subsquid/graphql-server` depends on the deprecated Apollo Server v3.

0 commit comments

Comments
 (0)