cluster-info.3valkey - Man Page

CLUSTER INFO

CLUSTER INFO provides valkey-info(7) INFO style information about Valkey Cluster vital parameters. The following fields are always present in the reply:

cluster_state:ok
cluster_slots_assigned:16384
cluster_slots_ok:16384
cluster_slots_pfail:0
cluster_slots_fail:0
cluster_nodes_pfail:0
cluster_nodes_fail:0
cluster_voting_nodes_pfail:0
cluster_voting_nodes_fail:0
cluster_known_nodes:6
cluster_size:3
cluster_current_epoch:6
cluster_my_epoch:2
cluster_stats_messages_sent:1483972
cluster_stats_messages_received:1483968
total_cluster_links_buffer_limit_exceeded:0

• cluster_state: State is ok if the node is able to receive queries. fail if there is at least one hash slot which is unbound (no node associated), in error state (node serving it is flagged with FAIL flag), or if the majority of primaries can’t be reached by this node.
• cluster_slots_assigned: Number of slots which are associated to some node (not unbound). This number should be 16384 for the node to work properly, which means that each hash slot should be mapped to a node.
• cluster_slots_ok: Number of hash slots mapping to a node not in FAIL or PFAIL state.
• cluster_slots_pfail: Number of hash slots mapping to a node in PFAIL state. Note that those hash slots still work correctly, as long as the PFAIL state is not promoted to FAIL by the failure detection algorithm. PFAIL only means that we are currently not able to talk with the node, but may be just a transient error.
• cluster_slots_fail: Number of hash slots mapping to a node in FAIL state. If this number is not zero the node is not able to serve queries unless cluster-require-full-coverage is set to no in the configuration.
• cluster_nodes_pfail: Number of nodes in PFAIL state. A non-zero value indicates one or more nodes have been detected as unreachable but have not yet been confirmed as failed by a quorum of voting nodes.
• cluster_nodes_fail: Number of nodes in FAIL state. A non-zero value indicates one or more nodes are unreachable and have been marked as failed by a quorum of voting nodes.
• cluster_voting_nodes_pfail: Number of voting nodes in PFAIL state. A non-zero value indicates one or more primary nodes serving at least one slot are unreachable but not yet confirmed as failed by a quorum of voting nodes.
• cluster_voting_nodes_fail: Number of voting nodes in FAIL state. A non-zero value indicates one or more primary nodes serving at least one slot have been marked as failed by a quorum of voting nodes.
• cluster_known_nodes: The total number of known nodes in the cluster, including nodes in valkey-cluster-spec(7) HANDSHAKE state that may not currently be proper members of the cluster.
• cluster_size: The number of primary nodes serving at least one hash slot in the cluster.
• cluster_current_epoch: The local valkey-cluster-spec(7) Current Epoch. This is used in order to create unique increasing version numbers during fail overs.
• cluster_my_epoch: The valkey-cluster-spec(7) Config Epoch of the node we are talking with. This is the current configuration version assigned to this node.
• cluster_stats_messages_sent: Number of messages sent via the cluster node-to-node binary bus.
• cluster_stats_messages_received: Number of messages received via the cluster node-to-node binary bus.
• total_cluster_links_buffer_limit_exceeded: Accumulated count of cluster links freed due to exceeding the cluster-link-sendbuf-limit configuration.

The following message-related fields may be included in the reply if the value is not 0: Each message type includes statistics on the number of messages sent and received. Here are the explanation of these fields: ] * cluster_stats_messages_ping_sent and cluster_stats_messages_ping_received: Cluster bus PING (not to be confused with the client command valkey-ping(7) PING. * cluster_stats_messages_pong_sent and cluster_stats_messages_pong_received: PONG (reply to PING). * cluster_stats_messages_meet_sent and cluster_stats_messages_meet_received: Handshake message sent to a new node, either through gossip or valkey-cluster-meet(7) CLUSTER MEET. * cluster_stats_messages_fail_sent and cluster_stats_messages_fail_received: Mark node xxx as failing. * cluster_stats_messages_publish_sent and cluster_stats_messages_publish_received: Pub/Sub Publish propagation, see valkey-pubsub(7) Pubsub. * cluster_stats_messages_auth-req_sent and cluster_stats_messages_auth-req_received: Replica initiated leader election to replace its primary. * cluster_stats_messages_auth-ack_sent and cluster_stats_messages_auth-ack_received: Message indicating a vote during leader election. * cluster_stats_messages_update_sent and cluster_stats_messages_update_received: Another node slots configuration. * cluster_stats_messages_mfstart_sent and cluster_stats_messages_mfstart_received: Pause clients for manual failover. * cluster_stats_messages_module_sent and cluster_stats_messages_module_received: Module cluster API message. * cluster_stats_messages_publishshard_sent and cluster_stats_messages_publishshard_received: Pub/Sub Publish shard propagation, see valkey-pubsub(7) Sharded Pubsub.

More information about the Current Epoch and Config Epoch variables are available in the valkey-cluster-spec(7) Valkey Cluster specification document.

valkey-protocol(7) Bulk string reply: A map between named fields and values in the form of <field>:<value> lines separated by newlines composed by the two bytes CRLF.

O(1)

@slow

• Available since: 3.0.0

asking(3valkey), cluster(3valkey), cluster-addslots(3valkey), cluster-addslotsrange(3valkey), cluster-bumpepoch(3valkey), cluster-cancelslotmigrations(3valkey), cluster-count-failure-reports(3valkey), cluster-countkeysinslot(3valkey), cluster-delslots(3valkey), cluster-delslotsrange(3valkey), cluster-failover(3valkey), cluster-flushslots(3valkey), cluster-forget(3valkey), cluster-getkeysinslot(3valkey), cluster-getslotmigrations(3valkey), cluster-help(3valkey), cluster-keyslot(3valkey), cluster-links(3valkey), cluster-meet(3valkey), cluster-migrateslots(3valkey), cluster-myid(3valkey), cluster-myshardid(3valkey), cluster-nodes(3valkey), cluster-replicas(3valkey), cluster-replicate(3valkey), cluster-reset(3valkey), cluster-saveconfig(3valkey), cluster-set-config-epoch(3valkey), cluster-setslot(3valkey), cluster-shards(3valkey), cluster-slot-stats(3valkey), cluster-slots(3valkey), cluster-syncslots(3valkey), readonly(3valkey), readwrite(3valkey)