Redis Cluster Compatibility Checker

Paste commands, one per line. Everything here works on a single instance. The point is what stops working the day the data is sharded, which is usually long after the code was written and always at the worst moment.

Paste below, or drop a file anywhere on this panel

Or drop a file anywhere on this panel. Nothing is uploaded: the analysis runs in this tab.

The answer appears here

Paste on the left and press Check. Nothing leaves this tab.

Examples

Real input you can load into the tool above. Each one shows a different thing going wrong, because that is what the tool is for.

Keys in different slots

A multi-key command that fails with CROSSSLOT once sharded

MGET user:1:name user:2:email

The same command, hash-tagged

The keys share a slot, so this one works on a cluster

MGET user:{42}:name user:{42}:email

Common mistakes

These are the ones that fail silently. The config is accepted, nothing raises an error, and the consequence arrives later.

  1. Assuming a multi-key command works because it works today

    On a single instance every key is in the same place. The failure appears only after sharding.

    Instead:Hash-tag keys that are read together.

  2. Keeping a database index in the connection string

    Cluster mode has only database 0 and SELECT fails on anything else.

    Instead:Remove the index and use key prefixes.

  3. Running KEYS or DBSIZE against one node for a cluster-wide answer

    Each node knows only its own slots, so the answer is a fraction.

    Instead:Query every primary and combine.

  4. Building key names inside a Lua script

    Routing uses the declared KEYS. A key built in the body is invisible to it.

    Instead:Pass every key through KEYS.

What cluster mode takes away

Cluster mode is not a transparent scale-out. Several things that worked before stop working, and they fail in ways that point at your application rather than at the cluster.

Multi-key commands need every key in one slot

MGET, MSET, SUNION, ZUNIONSTORE, RENAME and the rest fail with CROSSSLOT unless the keys share a slot. This works on a single instance, and on a cluster where the keys happen to collide, so it can pass every test you have and fail in production. A shared hash tag is what makes it reliable.

Only database 0 exists

SELECT on any other index fails. A connection URL carrying a database number cannot work at all, and the error surfaces at connect time rather than where the number was configured.

KEYS, SCAN, DBSIZE and FLUSHDB answer for one node

Each node knows only its own slots. Code that runs one of these against a single node and treats the answer as the keyspace silently sees a fraction of it, and the fraction changes as slots move.

Transactions and scripts are bound by the same rule

Every key touched between MULTI and EXEC must share a slot, and the failure arrives at EXEC rather than at the command that introduced the second slot. A Lua script is routed by its declared KEYS, so a key built inside the script body is invisible to routing and the script runs on a node that may not own it.

Pub/sub is broadcast unless it is sharded

An ordinary PUBLISH propagates across the whole cluster bus, so it reaches every subscriber on every node. That is convenient and it means pub/sub throughput does not improve as you add shards. SPUBLISH and SSUBSCRIBE, added in Redis 7.0, are routed by slot instead.

More redis tools

Redis Hash Slot Calculator Which of the 16,384 slots does this key land in? Redis Hash Tag Tester Will these keys survive a multi-key command? Redis RESP Protocol Decoder Read what the server actually sent Redis RESP2 vs RESP3 Reply Decoder What the same reply looks like on each protocol Redis Command to RESP Exactly what your client puts on the socket Redis Glob Pattern Tester Redis globs are not shell globs Redis Connection URL Parser The path is the database number Redis Memory Unit Converter 1g and 1gb are not the same number Redis TTL Converter -1 and -2 are not durations Redis Stream ID Parser The first half is a millisecond timestamp redis.conf Validator Will Redis start with this file? Redis Production Config Linter The settings that cause incidents redis.conf to CONFIG SET Which of these can you change without a restart? Redis ACL Rule Decoder What does this user actually get? Redis ACL Validator Find the rule that does nothing Redis INFO Analyzer The numbers INFO does not print Redis SLOWLOG Analyzer What blocked everyone else Redis CLUSTER NODES Parser Read the topology, and find the gap Redis Cluster Slot Distribution Who owns how much, and what is missing Redis Keyspace Notification Flags Why your events never arrive Redis Memory Calculator The encoding decides, not the data Redis Key Count to Memory The fixed cost per key Redis Encoding Threshold Calculator One field more, several times the memory Redis Bitmap Memory Calculator Sized by the highest bit, not the set ones Redis HyperLogLog Calculator 12 KB whether you count a thousand or a billion Redis Cluster Sizing Only 60% of each node is usable Redis RDB and AOF Size Calculator The fork needs memory, not disk Redis Replication Bandwidth Calculator How long the backlog actually covers Redis Connection Pool Calculator More connections is not more throughput Redis Pipeline Calculator It removes round trips, not work Redis Cache Hit Rate Calculator 99% to 90% is ten times the backend load Redis Eviction Policy Simulator volatile- with no TTLs is noeviction Redis Cost Estimator Your rates, so nothing goes stale Redis Config File Generator A redis.conf with the reasons in it Redis ACL Generator A user that can do exactly one job Redis Maxmemory Config Generator The limit, and the headroom it needs Redis Persistence Config Generator How much you can afford to lose Redis Lua Script Generator Atomic, and short enough to stay that way Redis TLS Config Generator Encrypted, and the old port actually closed Redis Sentinel Config Generator Failover that can actually be authorised Redis Cluster Config Generator Three primaries, and the bus port open Redis Docker Compose Generator Local Redis that is not on the internet Redis Client Config Generator Timeouts on both sides, and a sane pool Redis MEMORY STATS Analyzer Which number actually matters Redis Bigkeys Output Analyzer Elements are not bytes Redis CLIENT LIST Analyzer Find the connection hurting you Redis LATENCY Report Analyzer An empty report may mean nothing was recorded Redis Keyspace Prefix Analyzer Which key family is growing Redis SET Command Builder A plain SET clears the TTL Redis ZRANGE Query Builder REV reverses the argument order Redis SCAN Iteration Planner COUNT is a hint, not a page size Redis Key Name Validator Legal is not the same as workable

Elsewhere on the site