CLUSTER-INFO(3valkey)
π CLUSTER-INFO π
okay bestie, this is a 3valkey manual page, and it's the one about CLUSTER INFO β literally the command that tells you how your whole Valkey Cluster is doing. vibe check for your entire cluster, no cap. π«Ά
β¨ NAME β¨
cluster-info β returns information about the state of a node. like, the whole tea on what your node is up to. π
πΈ SYNOPSIS πΈ
CLUSTER INFO
that's it. that's the whole thing. no args, no flags, just vibes. π
π¦ DESCRIPTION π¦
CLUSTER INFO gives you valkey-info(7) INFO-style information about the vital parameters of a Valkey Cluster. iconic. it's giving "doctor's chart but for your cluster."
these fields are always present in the reply, no exceptions, periodt:
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
now let's break down what each one is actually saying, bestie, because the numbers alone are lowkey cryptic:
cluster_stateβ State isokif the node is able to receive queries. It'sfailif there is at least one hash slot which is unbound (no node associated), in error state (the node serving it is flagged with theFAILflag), or if the majority of primaries can't be reached by this node. so if you see fail, something is genuinely not okay.cluster_slots_assignedβ Number of slots which are associated to some node (not unbound). This number should be16384for 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 inFAILorPFAILstate. the good ones. the slay ones. β¨cluster_slots_pfailβ Number of hash slots mapping to a node inPFAILstate. Note that those hash slots still work correctly, as long as thePFAILstate is not promoted toFAILby the failure detection algorithm.PFAILonly means that we are currently not able to talk with the node, but may be just a transient error. so like, don't panic yet? πcluster_slots_failβ Number of hash slots mapping to a node inFAILstate. If this number is not zero the node is not able to serve queries unlesscluster-require-full-coverageis set tonoin the configuration. πcluster_nodes_pfailβ Number of nodes inPFAILstate. 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 inFAILstate. 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 inPFAILstate. 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 inFAILstate. 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 invalkey-cluster-spec(7)HANDSHAKEstate that may not currently be proper members of the cluster. so like, the "we've met but we're not official yet" crowd. πcluster_sizeβ The number of primary nodes serving at least one hash slot in the cluster.cluster_current_epochβ The localvalkey-cluster-spec(7)Current Epoch. This is used in order to create unique increasing version numbers during fail overs.cluster_my_epochβ Thevalkey-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 thecluster-link-sendbuf-limitconfiguration.
π§ the message stats section (only shows up when it's not zero) π§
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_sentandcluster_stats_messages_ping_receivedβ Cluster busPING(not to be confused with the client commandvalkey-ping(7)PING). βcluster_stats_messages_pong_sentandcluster_stats_messages_pong_receivedβPONG(reply toPING).cluster_stats_messages_meet_sentandcluster_stats_messages_meet_receivedβ Handshake message sent to a new node, either through gossip orvalkey-cluster-meet(7)CLUSTER MEET.cluster_stats_messages_fail_sentandcluster_stats_messages_fail_receivedβ Mark nodexxxas failing.cluster_stats_messages_publish_sentandcluster_stats_messages_publish_receivedβ Pub/Sub Publish propagation, seevalkey-pubsub(7)Pubsub.cluster_stats_messages_auth-req_sentandcluster_stats_messages_auth-req_receivedβ Replica initiated leader election to replace its primary.cluster_stats_messages_auth-ack_sentandcluster_stats_messages_auth-ack_receivedβ Message indicating a vote during leader election. π³οΈcluster_stats_messages_update_sentandcluster_stats_messages_update_receivedβ Another node slots configuration.cluster_stats_messages_mfstart_sentandcluster_stats_messages_mfstart_receivedβ Pause clients for manual failover.cluster_stats_messages_module_sentandcluster_stats_messages_module_receivedβ Module cluster API message.cluster_stats_messages_publishshard_sentandcluster_stats_messages_publishshard_receivedβ Pub/Sub Publish shard propagation, seevalkey-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. π
π REPLY π
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. so like, a bunch of little lines, each one name:value, glued together with CRLF. clean. π
β‘ COMPLEXITY β‘
O(1) β constant time, bestie. instant. no waiting around. π₯
π ACL CATEGORIES π
@slow
ngl it's tagged @slow, so keep that in mind when you're thinking about permissions. the tag says what it says, I don't make the rules. π
π HISTORY π
- Available since:
3.0.0
π SEE ALSO π
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)
and that's the whole page, bestie. version 9.0.0, dated 2025-10-21 β go forth and read your cluster's aura. πβ¨π¦πΈπ«Ά
π¦ where this page comes from
- fedora 44: valkey-doc 9.0.3-2.fc44 Β· CC-BY-SA-4.0
- fedora 44: valkey-doc 9.0.6-1.fc44 Β· CC-BY-SA-4.0
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms