Redis 7.x 系列【30】集群管理命令

有道无术，术尚可求，有术无道，止于术。

本系列Redis 版本 7.2.5

源码地址：https://gitee.com/pearl-organization/study-redis-demo

1. 概述

集群管理命令是用于管理和维护 Redis 集群，允许用户执行如查看集群信息、添加或删除节点、重新分片等操作。

所有命令：

命名	描述
ASKING	用于 ASK 重定向
CLUSTER ADDSLOTS	将一个或多个槽指派给当前节点
CLUSTER ADDSLOTSRANGE	将指定范围内的槽指派给当前节点
CLUSTER BUMPEPOCH	提升集群的 config epoch
CLUSTER COUNT-FAILURE	返回指定节点当前未过期的失败报告的数量
CLUSTER COUNTKEYSINSLOT	返回指定槽中键的数量
CLUSTER DELSLOTS	移除一个或多个槽对当前节点的指派
CLUSTER DELSLOTSRANGE	移除范围内的槽对当前节点的指派
CLUSTER FAILOVER	手动触发故障转移
CLUSTER FLUSHSLOTS	移除指派给当前节点的所有槽，让当前节点变成一个没有指派任何槽的节点
CLUSTER FORGET	从集群中移除指定节点ID的节点
CLUSTER GETKEYSINSLOT	返回指定槽中的键
CLUSTER INFO	打印集群的详细信息，包括集群状态、节点数量、槽分配情况
CLUSTER KEYSLOT	返回指定键存储的哈希槽
CLUSTER LINKS	输出所有集群节点之间对等连接信息
CLUSTER MEET	将指定IP和端口的节点添加到集群中
CLUSTER MYID	查看当前节点的运行ID
CLUSTER MYSHARDID	查看当前节点的分片ID
CLUSTER NODES	列出集群当前已知的所有节点及其相关信息
CLUSTER REPLICAS	返回指定主节点进行复制的从节点列表
CLUSTER REPLICATE	将当前节点设置为指定节点ID的节点的从节点
CLUSTER RESET	重置集群节点的状态
CLUSTER SAVECONFIG	将节点的配置文件保存到硬盘上
CLUSTER SET-CONFIG-EPOCH	在新节点中设置特定的配置时期
CLUSTER SETSLOT	改变接收节点中哈希槽的状态
CLUSTER SHARDS	获取集群中所有分片信息
CLUSTER SLAVES	查看指定主节点的所有从节点列表
CLUSTER SLOTS	查询集群哈希槽与节点映射关系
READONLY	在从节点上开启只读模式，读取可能不是最新的数据
READWRITE	取消之前通过 READONLY 命令设置的只读模式

2. 集群信息

2.1 CLUSTER INFO

获取集群的当前状态和各种统计信息。

关键信息说明：

• cluster_state：表示集群的当前状态， ok 表示集群运行正常，其他值可能表示集群存在问题
• cluster_slots_assigned：已分配的槽位数量，理想情况下应为 16384，表示所有槽位都已被分配。
• cluster_slots_ok：正常运行的槽位数量，应与 cluster_slots_assigned 相同，除非有槽位因故障而无法正常工作。
• cluster_slots_pfail：疑似失败的槽位数量，这些槽位可能由于网络问题等原因暂时无法访问。
• cluster_slots_fail：运行失败的槽位数量，这些槽位由于某种原因（如节点故障）已经完全无法访问。
• cluster_known_nodes：集群中已知节点的数量，这个数量应等于集群中所有正常工作的节点数。

示例：

主节点(192.168.56.101:6381)>cluster info
"cluster_state:ok
cluster_slots_assigned:16384 
cluster_slots_ok:16384
cluster_slots_pfail:0
cluster_slots_fail:0
cluster_known_nodes:6 
cluster_size:3  
cluster_current_epoch:9
cluster_my_epoch:3
cluster_stats_messages_ping_sent:42283
cluster_stats_messages_pong_sent:42739
cluster_stats_messages_fail_sent:4
cluster_stats_messages_update_sent:3
cluster_stats_messages_sent:85029
cluster_stats_messages_ping_received:42739
cluster_stats_messages_pong_received:50471
cluster_stats_messages_fail_received:1
cluster_stats_messages_received:93211
total_cluster_links_buffer_limit_exceeded:0
"

3. 节点管理

3.1 CLUSTER MYID

查看当前节点的运行 ID （Run ID），运行 ID 是集群中每个节点唯一的标识符，用于集群内部的管理和通信。在节点重启后可能会改变，因此它不能作为节点的永久标识符。但在节点运行期间，运行 ID 是唯一的，并且不会改变。在进行集群管理操作时，如添加、删除节点或进行故障转移等会用到该 ID。

示例：

主节点(192.168.56.101:6381)>CLUSTER MYID
"9f9c30c3f73106e256fdec27264fc8129e1287fd"

3.2 CLUSTER NODES

查看集群当前已知的所有节点以及节点信息，对于集群的管理、监控和故障排查都非常重要。

示例：

主节点(192.168.56.101:6381)>CLUSTER NODES
"9f9c30c3f73106e256fdec27264fc8129e1287fd 192.168.56.101:6381@16381 myself,master - 0 1721405084000 3 connected 12288-16383
e909dc338f4c2fc7687cf4426d3b95956a90a8a8 192.168.56.101:6380@16380 master - 0 1721405088116 9 connected 0-1364 5461-12287
ce27fa445e987f75bddeeb68fc6fe440678ad1bb 192.168.56.101:6382@16382 master - 0 1721405087000 7 connected 1365-5460
0f1d8d6459ac4252636cb4b8e1764de9e277411c 192.168.56.101:6390@16390 slave 9f9c30c3f73106e256fdec27264fc8129e1287fd 0 1721405088000 3 connected
724c7b874dc0c37a462cd5ab59325203344f8008 192.168.56.101:6379@16379 slave ce27fa445e987f75bddeeb68fc6fe440678ad1bb 0 1721405090177 7 connected
b5bde236f14f21f530a7095aaef3a98109009324 192.168.56.101:6383@16383 slave e909dc338f4c2fc7687cf4426d3b95956a90a8a8 0 1721405089144 9 connected"

各部分信息说明：

• ce27fa445e987f75bddeeb68fc6fe440678ad1bb：节点ID，每个节点的唯一标识符
• 192.168.56.101:6382@16382：节点的IP地址、客户端连接端口号、集群总线端口号，用于节点间的通信
• master：节点在集群中的角色，可以是主节点（master）或从节点（slave）
• - 0：节点标记，- 0 表示没有特殊的标记，在某些情况下，这里可能会显示 fail、myself或其他状态标志
• 1721405087000 ：节点最后一次发送心跳消息到当前节点的时间戳（以毫秒为单位）
• 7：配置纪元（config epoch）的编号，是一个递增的计数器，用于在集群重新配置（如故障转移）时跟踪集群的状态
• connected ：节点的当前状态，如在线（connected）、疑似失败（pfail）、失败（fail）等
• 1365-5460：分配的哈希槽

3.3 CLUSTER REPLICAS

返回主节点进行复制的从节点列表。

示例：

主节点(192.168.56.101:6381)>CLUSTER REPLICAS 9f9c30c3f73106e256fdec27264fc8129e1287fd1)  "0f1d8d6459ac4252636cb4b8e1764de9e277411c 192.168.56.101:6390@16390 slave 9f9c30c3f73106e256fdec27264fc8129e1287fd 0 1721406870213 3 connected"

3.4 CLUSTER FORGET

从集群中移除指定的节点。

示例：

主节点(192.168.56.101:6381)>CLUSTER FORGET e909dc338f4c2fc7687cf4426d3b95956a90a8a8
"OK"

注意事项：

• 只是在集群中移除，并不会关闭该节点或停止其运行
• 请确保被移除的节点确实不再需要参与集群的运行，并且已经做好了相应的数据备份和迁移工作

查看集群信息：

3.5 CLUSTER MEET

用于将支持集群的不同 Redis 节点连接成一个工作集群。

节点默认情况下不相互信任，被视为未知节点，需要让其他节点接受并加入到集群，目前提供了两种方式：

• CLUSTER MEET ：强制一个节点与另一个节点建立联系
• Gossip：使用流言协议进行传播

示例，将上面被移除的节点重新加入到集群：

主节点(192.168.56.101:6381)>CLUSTER MEET 192.168.56.101 6380
"OK"

4. 哈希槽管理

4.1 CLUSTER SLOTS

获取集群中所有哈希槽的分配情况。返回值为嵌套数组，每个嵌套数组包含一个哈希槽的范围，以及负责该槽范围的节点的 IP 地址和端口号。

示例：

主节点(192.168.56.101:6381)>CLUSTER SLOTS1)    1)   "0"2)   "1364"3)      1)    "192.168.56.101"2)    "6380"3)    "e909dc338f4c2fc7687cf4426d3b95956a90a8a8"4)    4)      1)    "192.168.56.101"2)    "6383"3)    "b5bde236f14f21f530a7095aaef3a98109009324"4)    2)    1)   "1365"

4.2 CLUSTER KEYSLOT

返回给定 key 存储的哈希槽编号。

示例：

主节点(192.168.56.101:6381)>CLUSTER KEYSLOT aa
"1180"

4.3 CLUSTER COUNTKEYSINSLOT

返回指定哈希槽中 key 的数量。只查询连接节点的本地数据集，如果指定的 slot 被分配在别的节点上，就会返回 0。

示例：

主节点(192.168.56.101:6381)>CLUSTER COUNTKEYSINSLOT 1180
"1"

4.4 CLUSTER DELSLOTS

将接收命令的节点上的一组哈希槽进行移除。

示例：

主节点(192.168.56.101:6381)>CLUSTER DELSLOTS 12288 12299 12300 
"OK"

4.5 CLUSTER ADDSLOTS

将一组哈希槽分配给接收命令的节点。如果命令执行成功，该节点将指定的哈希槽映射到自己身上，并开始广播新的配置。

注意事项：

• 如果哈希槽已被分配给其他节点，会抛出异常
• 如果同一个槽位被多次指定，则该命令会失败

示例，将上面移除的哈希槽，重新分配给当前节点：

主节点(192.168.56.101:6381)>CLUSTER ADDSLOTS 12288 12299 12300
"OK"

4.6 CLUSTER SETSLOT

用于重新分片哈希槽，以不同的方式改变接收节点中哈希槽的状态。

命令格式：

CLUSTER SETSLOT slot <IMPORTING node-id | MIGRATING node-id |NODE node-id | STABLE>

子命令说明：

• MIGRATING：将哈希槽设置为迁移状态。通常用于在源节点上，表明该槽位的数据正在迁移到其他节点。
• IMPORTING：将哈希槽设置为导入状态。这通常用于在目标节点上设置槽位，表明该节点正在从其他节点导入数据。
• STABLE ：清除哈希槽上的任何导入/迁移状态。这通常用于在迁移过程完成后，将槽位状态重置为稳定状态。
• NODE ：将哈希槽分配到另一个节点。可能存在一些限制，建议使用 CLUSTER ADDSLOTS 命令来分配槽位。

4.7 CLUSTER FLUSHSLOTS

移除指派给当前节点的所有槽，让当前节点变成一个没有指派任何槽的节点。

示例：

5. 其他

5.1 CLUSTER FAILOVER

用于手动触发故障转移过程，强制将从节点升级为主节点。手动故障转移是一种特殊的故障转移方式，它通常在没有实际故障发生时执行，但我们希望以安全的方式（没有任何数据丢失的风险）将当前的主节点与其从节点之一进行交换。

命令格式：

CLUSTER FAILOVER [FORCE | TAKEOVER]

参数说明：

• 无参：尝试与当前的主节点进行协商，并遵循标准的故障转移流程
• FORCE：从节点会跳过与主节点的协商步骤，并尽快启动故障转移过程
• TAKEOVER：它允许从节点单方面地成为主节点，而不需要等待集群中其他主节点的授权或投票

注意事项：

• 只能在从节点上执行
• FORCE 和 TAKEOVER 参数会绕过正常的故障转移流程，可能会导致意外的后果
• 建议自动处理故障转移，而不是手动干预

示例，让从节点升级为主节点：