Skip to content

Commit e16828b

Browse files
authored
Add CLUSTER INFO fields (redis#1798)
1 parent 3075e7a commit e16828b

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

commands/cluster-info.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
`CLUSTER INFO` provides `INFO` style information about Redis Cluster
2-
vital parameters. The following is a sample output, followed by the
3-
description of each field reported.
1+
`CLUSTER INFO` provides `INFO` style information about Redis Cluster vital parameters.
2+
The following fields are always present in the reply:
43

54
```
65
cluster_state:ok
@@ -30,7 +29,23 @@ total_cluster_links_buffer_limit_exceeded:0
3029
* `cluster_stats_messages_received`: Number of messages received via the cluster node-to-node binary bus.
3130
* `total_cluster_links_buffer_limit_exceeded`: Accumulated count of cluster links freed due to exceeding the `cluster-link-sendbuf-limit` configuration.
3231

33-
More information about the Current Epoch and Config Epoch variables are available in the Redis Cluster specification document.
32+
The following message-related fields may be included in the reply if the value is not 0:
33+
Each message type includes statistics on the number of messages sent and received.
34+
Here are the explanation of these fields:
35+
36+
* `cluster_stats_messages_ping_sent` and `cluster_stats_messages_ping_received`: Cluster bus PING (not to be confused with the client command `PING`).
37+
* `cluster_stats_messages_pong_sent` and `cluster_stats_messages_pong_received`: PONG (reply to PING).
38+
* `cluster_stats_messages_meet_sent` and `cluster_stats_messages_meet_received`: Handshake message sent to a new node, either through gossip or `CLUSTER MEET`.
39+
* `cluster_stats_messages_fail_sent` and `cluster_stats_messages_fail_received`: Mark node xxx as failing.
40+
* `cluster_stats_messages_publish_sent` and `cluster_stats_messages_publish_received`: Pub/Sub Publish propagation, see [Pubsub](/topics/pubsub#pubsub).
41+
* `cluster_stats_messages_auth-req_sent` and `cluster_stats_messages_auth-req_received`: Replica initiated leader election to replace its master.
42+
* `cluster_stats_messages_auth-ack_sent` and `cluster_stats_messages_auth-ack_received`: Message indicating a vote during leader election.
43+
* `cluster_stats_messages_update_sent` and `cluster_stats_messages_update_received`: Another node slots configuration.
44+
* `cluster_stats_messages_mfstart_sent` and `cluster_stats_messages_mfstart_received`: Pause clients for manual failover.
45+
* `cluster_stats_messages_module_sent` and `cluster_stats_messages_module_received`: Module cluster API message.
46+
* `cluster_stats_messages_publishshard_sent` and `cluster_stats_messages_publishshard_received`: Pub/Sub Publish shard propagation, see [Sharded Pubsub](/topics/pubsub#sharded-pubsub).
47+
48+
More information about the Current Epoch and Config Epoch variables are available in the [Redis Cluster specification document](/topics/cluster-spec#cluster-current-epoch).
3449

3550
@return
3651

0 commit comments

Comments
 (0)