Skip to content

Commit 1e17378

Browse files
Improve SignalR Redis Cluster section (dotnet#28310)
1 parent 45b969f commit 1e17378

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

aspnetcore/signalr/redis-backplane.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ This article explains SignalR-specific aspects of setting up a [Redis](https://r
104104

105105
* Configure options as needed:
106106

107-
Most options can be set in the connection string or in the [ConfigurationOptions](https://stackexchange.github.io/StackExchange.Redis/Configuration#configuration-options) object. Options specified in `ConfigurationOptions` override the ones set in the connection string.
107+
Most options can be set in the connection string or in the [`ConfigurationOptions`](https://stackexchange.github.io/StackExchange.Redis/Configuration#configuration-options) object. Options specified in `ConfigurationOptions` override the ones set in the connection string.
108108

109109
The following example shows how to set options in the `ConfigurationOptions` object. This example adds a channel prefix so that multiple apps can share the same Redis instance, as explained in the following step.
110110

@@ -212,9 +212,16 @@ services.AddSignalR()
212212

213213
:::moniker-end
214214

215-
## Redis Clustering
215+
## Redis Cluster
216+
217+
[Redis Cluster](https://redis.io/topics/cluster-spec) utilizes multiple simultaneously active Redis servers to achieve high availability. When Redis Cluster is used as the backplane for SignalR, messages are delivered to all of the nodes of the cluster without code modifications to the app.
218+
219+
There's a tradeoff between the number of nodes in the cluster and the throughput of the backplane. Increasing the number of nodes increases the availability of the cluster but decreases the throughput because messages must be transmitted to all of the nodes in the cluster.
220+
221+
In the SignalR app, include all of the possible Redis nodes using either of the following approaches:
216222

217-
[Redis Clustering](https://redis.io/topics/cluster-spec) is a method for achieving high availability by using multiple Redis servers. Clustering is supported without any code modifications to the app.
223+
* List the nodes in the connection string delimited with commas.
224+
* If using custom behavior for connection failures, add the nodes to [`ConfigurationOptions.Endpoints`](https://stackexchange.github.io/StackExchange.Redis/Configuration#configuration-options).
218225

219226
## Next steps
220227

0 commit comments

Comments
 (0)