Skip to content

Commit

Permalink
Add warning log if MasterReplica(…, Iterable<RedisURI>) contains mult…
Browse files Browse the repository at this point in the history 
…iple Sentinel URIs #1165
  • Loading branch information
@mp911de
mp911de committed Oct 30, 2019
1 parent cc5ea23 commit 0eac6c1
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 38 deletions.
40 changes: 25 additions & 15 deletions src/main/java/io/lettuce/core/masterreplica/MasterReplica.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,19 @@
* Master-Replica topologies are either static or semi-static. Redis Standalone instances with attached replicas provide no
* failover/HA mechanism. Redis Sentinel managed instances are controlled by Redis Sentinel and allow failover (which include
* master promotion). The {@link MasterReplica} API supports both mechanisms. The topology is provided by a
* {@link TopologyProvider}:
* {@link io.lettuce.core.masterslave.TopologyProvider}:
*
* <ul>
* <li>{@link MasterSlaveTopologyProvider}: Dynamic topology lookup using the {@code INFO REPLICATION} output. Replicas are
* listed as {@code replicaN=...} entries. The initial connection can either point to a master or a replica and the topology
* provider will discover nodes. The connection needs to be re-established outside of lettuce in a case of Master/Replica
* failover or topology changes.</li>
* <li>{@link StaticMasterSlaveTopologyProvider}: Topology is defined by the list of {@link RedisURI URIs} and the {@code ROLE}
* output. MasterReplica uses only the supplied nodes and won't discover additional nodes in the setup. The connection needs to
* be re-established outside of lettuce in a case of Master/Replica failover or topology changes.</li>
* <li>{@link SentinelTopologyProvider}: Dynamic topology lookup using the Redis Sentinel API. In particular,
* {@code SENTINEL MASTER} and {@code SENTINEL SLAVES} output. Master/Replica failover is handled by lettuce.</li>
* <li>{@link io.lettuce.core.masterslave.MasterSlaveTopologyProvider}: Dynamic topology lookup using the
* {@code INFO REPLICATION} output. Replicas are listed as {@code replicaN=...} entries. The initial connection can either point
* to a master or a replica and the topology provider will discover nodes. The connection needs to be re-established outside of
* lettuce in a case of Master/Replica failover or topology changes.</li>
* <li>{@link io.lettuce.core.masterslave.StaticMasterSlaveTopologyProvider}: Topology is defined by the list of {@link RedisURI
* URIs} and the {@code ROLE} output. MasterReplica uses only the supplied nodes and won't discover additional nodes in the
* setup. The connection needs to be re-established outside of lettuce in a case of Master/Replica failover or topology
* changes.</li>
* <li>{@link io.lettuce.core.masterslave.SentinelTopologyProvider}: Dynamic topology lookup using the Redis Sentinel API. In
* particular, {@code SENTINEL MASTER} and {@code SENTINEL SLAVES} output. Master/Replica failover is handled by lettuce.</li>
* </ul>
*
* <h3>Topology Updates</h4>
Expand All @@ -69,9 +70,8 @@
* <li>Redis Sentinel: Subscribes to all Sentinels and listens for Pub/Sub messages to trigger topology refreshing</li>
* </ul>
*
* <h3>Connection Fault-Tolerance</h3>
* Connecting to Master/Replica bears the possibility that individual nodes are not reachable. {@link MasterReplica} can still
* connect to a partially-available set of nodes.
* <h3>Connection Fault-Tolerance</h3> Connecting to Master/Replica bears the possibility that individual nodes are not
* reachable. {@link MasterReplica} can still connect to a partially-available set of nodes.
*
* <ul>
* <li>Redis Sentinel: At least one Sentinel must be reachable, the masterId must be registered and at least one host must be
Expand Down Expand Up @@ -135,10 +135,15 @@ public static <K, V> CompletableFuture<StatefulRedisMasterReplicaConnection<K, V
* be treated as static topology and no additional hosts are discovered in such case. Redis Standalone Master/Replica will
* discover the roles of the supplied {@link RedisURI URIs} and issue commands to the appropriate node.
* </p>
* <p>
* When using Redis Sentinel, ensure that {@link Iterable redisURIs} contains only a single entry as only the first URI is
* considered. {@link RedisURI} pointing to multiple Sentinels can be configured through
* {@link RedisURI.Builder#withSentinel}.
* </p>
*
* @param redisClient the Redis client.
* @param codec Use this codec to encode/decode keys and values, must not be {@literal null}.
* @param redisURIs the Redis server to connect to, must not be {@literal null}.
* @param redisURIs the Redis server(s) to connect to, must not be {@literal null}.
* @param <K> Key type.
* @param <V> Value type.
* @return a new connection.
Expand All @@ -156,10 +161,15 @@ public static <K, V> StatefulRedisMasterReplicaConnection<K, V> connect(RedisCli
* be treated as static topology and no additional hosts are discovered in such case. Redis Standalone Master/Replica will
* discover the roles of the supplied {@link RedisURI URIs} and issue commands to the appropriate node.
* </p>
* <p>
* When using Redis Sentinel, ensure that {@link Iterable redisURIs} contains only a single entry as only the first URI is
* considered. {@link RedisURI} pointing to multiple Sentinels can be configured through
* {@link RedisURI.Builder#withSentinel}.
* </p>
*
* @param redisClient the Redis client.
* @param codec Use this codec to encode/decode keys and values, must not be {@literal null}.
* @param redisURIs the Redis server to connect to, must not be {@literal null}.
* @param redisURIs the Redis server(s) to connect to, must not be {@literal null}.
* @param <K> Key type.
* @param <V> Value type.
* @return {@link CompletableFuture} that is notified once the connect is finished.
Expand Down
63 changes: 40 additions & 23 deletions src/main/java/io/lettuce/core/masterslave/MasterSlave.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
import io.lettuce.core.internal.Futures;
import io.lettuce.core.internal.LettuceAssert;
import io.lettuce.core.internal.LettuceLists;
import io.netty.util.internal.logging.InternalLogger;
import io.netty.util.internal.logging.InternalLoggerFactory;

/**
* Master-Slave connection API.
Expand Down Expand Up @@ -60,9 +62,9 @@
*
* <ul>
* <li>{@link MasterSlaveTopologyProvider}: Dynamic topology lookup using the {@code INFO REPLICATION} output. Slaves are listed
* as {@code slaveN=...} entries. The initial connection can either point to a master or a replica and the topology provider will
* discover nodes. The connection needs to be re-established outside of lettuce in a case of Master/Slave failover or topology
* changes.</li>
* as {@code slaveN=...} entries. The initial connection can either point to a master or a replica and the topology provider
* will discover nodes. The connection needs to be re-established outside of lettuce in a case of Master/Slave failover or
* topology changes.</li>
* <li>{@link StaticMasterSlaveTopologyProvider}: Topology is defined by the list of {@link RedisURI URIs} and the {@code ROLE}
* output. MasterSlave uses only the supplied nodes and won't discover additional nodes in the setup. The connection needs to be
* re-established outside of lettuce in a case of Master/Slave failover or topology changes.</li>
Expand All @@ -76,9 +78,8 @@
* <li>Redis Sentinel: Subscribes to all Sentinels and listens for Pub/Sub messages to trigger topology refreshing</li>
* </ul>
*
* <h3>Connection Fault-Tolerance</h3>
* Connecting to Master/Slave bears the possibility that individual nodes are not reachable. {@link MasterSlave} can still
* connect to a partially-available set of nodes.
* <h3>Connection Fault-Tolerance</h3> Connecting to Master/Slave bears the possibility that individual nodes are not reachable.
* {@link MasterSlave} can still connect to a partially-available set of nodes.
*
* <ul>
* <li>Redis Sentinel: At least one Sentinel must be reachable, the masterId must be registered and at least one host must be
Expand Down Expand Up @@ -162,10 +163,15 @@ private static <K, V> CompletableFuture<StatefulRedisMasterSlaveConnection<K, V>
* treated as static topology and no additional hosts are discovered in such case. Redis Standalone Master/Slave will
* discover the roles of the supplied {@link RedisURI URIs} and issue commands to the appropriate node.
* </p>
* <p>
* When using Redis Sentinel, ensure that {@link Iterable redisURIs} contains only a single entry as only the first URI is
* considered. {@link RedisURI} pointing to multiple Sentinels can be configured through
* {@link RedisURI.Builder#withSentinel}.
* </p>
*
* @param redisClient the Redis client.
* @param codec Use this codec to encode/decode keys and values, must not be {@literal null}.
* @param redisURIs the Redis server to connect to, must not be {@literal null}.
* @param redisURIs the Redis server(s) to connect to, must not be {@literal null}.
* @param <K> Key type.
* @param <V> Value type.
* @return a new connection.
Expand All @@ -183,10 +189,15 @@ public static <K, V> StatefulRedisMasterSlaveConnection<K, V> connect(RedisClien
* treated as static topology and no additional hosts are discovered in such case. Redis Standalone Master/Slave will
* discover the roles of the supplied {@link RedisURI URIs} and issue commands to the appropriate node.
* </p>
* <p>
* When using Redis Sentinel, ensure that {@link Iterable redisURIs} contains only a single entry as only the first URI is
* considered. {@link RedisURI} pointing to multiple Sentinels can be configured through
* {@link RedisURI.Builder#withSentinel}.
* </p>
*
* @param redisClient the Redis client.
* @param codec Use this codec to encode/decode keys and values, must not be {@literal null}.
* @param redisURIs the Redis server to connect to, must not be {@literal null}.
* @param redisURIs the Redis server(s) to connect to, must not be {@literal null}.
* @param <K> Key type.
* @param <V> Value type.
* @return {@link CompletableFuture} that is notified once the connect is finished.
Expand All @@ -206,8 +217,16 @@ private static <K, V> CompletableFuture<StatefulRedisMasterSlaveConnection<K, V>
List<RedisURI> uriList = LettuceLists.newList(redisURIs);
LettuceAssert.isTrue(!uriList.isEmpty(), "RedisURIs must not be empty");

if (isSentinel(uriList.get(0))) {
return new SentinelConnector<>(redisClient, codec, uriList.get(0)).connectAsync();
RedisURI first = uriList.get(0);
if (isSentinel(first)) {

if (uriList.size() > 1) {
InternalLogger logger = InternalLoggerFactory.getInstance(MasterSlave.class);
logger.warn(
"RedisURIs contains multiple endpoints of which the first is configured for Sentinel usage. Using only the first {} without considering the remaining URIs. Make sure to include all Sentinel endpoints in a single RedisURI.",
first);
}
return new SentinelConnector<>(redisClient, codec, first).connectAsync();
}

return new StaticMasterSlaveConnector<>(redisClient, codec, uriList).connectAsync();
Expand Down Expand Up @@ -253,21 +272,19 @@ private static <T> T getConnection(CompletableFuture<T> connectionFuture, Object

private static <T> CompletableFuture<T> transformAsyncConnectionException(CompletionStage<T> future, Object context) {

return ConnectionFuture
.from(null, future.toCompletableFuture())
.thenCompose((v, e) -> {
return ConnectionFuture.from(null, future.toCompletableFuture()).thenCompose((v, e) -> {

if (e != null) {
if (e != null) {

// filter intermediate RedisConnectionException exceptions that bloat the stack trace
if (e.getCause() instanceof RedisConnectionException
&& e.getCause().getCause() instanceof RedisConnectionException) {
return Futures.failed(RedisConnectionException.create(context.toString(), e.getCause()));
}
return Futures.failed(RedisConnectionException.create(context.toString(), e));
}
// filter intermediate RedisConnectionException exceptions that bloat the stack trace
if (e.getCause() instanceof RedisConnectionException
&& e.getCause().getCause() instanceof RedisConnectionException) {
return Futures.failed(RedisConnectionException.create(context.toString(), e.getCause()));
}
return Futures.failed(RedisConnectionException.create(context.toString(), e));
}

return CompletableFuture.completedFuture(v);
}).toCompletableFuture();
return CompletableFuture.completedFuture(v);
}).toCompletableFuture();
}
}

0 comments on commit 0eac6c1

Please sign in to comment.