Add CLUSTER SLOT-STATS document.

commands/cluster-slot-stats.md

@@ -0,0 +1,99 @@
+`CLUSTER SLOT-STATS` returns an array of slot usage statistics for slots assigned to the current shard.
+The command is suitable for Valkey Cluster users aiming to assess general slot usage trends, identify hot / cold slots, migrate slots for a balanced cluster workload, and / or re-write application logic to better utilize slots.
+
+As of now, the following metrics are supported:
+* `key-count` - Number of keys residing in a given slot.
+* `cpu-usec` - Amount of cpu time (in micro-seconds) spent on a given slot.
+* `network-bytes-in` - Amount of network ingress (in bytes) received for given slot.
+* `network-bytes-out` - Amount of network egress (in bytes) sent out for given slot.
+
+## Supported arguments
+There exist two mutually exclusive arguments, namely;
+
+### SLOTSRANGE
+Returns slot statistics based on the slots range provided. The range is inclusive.
+The `SLOTSRANGE` argument allows for request pagination.
+The response is ordered in ascending slot number.
+
+##### Response in RESP2
+```
+> CLUSTER SLOT-STATS SLOTSRANGE 0 1
+1) 1) (integer) 0
+   2) 1) "key-count"
+      2) (integer) 0
+      3) "cpu-usec"
+      4) (integer) 0
+      5) "network-bytes-in"
+      6) (integer) 0
+      7) "network-bytes-out"
+      8) (integer) 0
+2) 1) (integer) 1
+   2) 1) "key-count"
+      2) (integer) 0
+      3) "cpu-usec"
+      4) (integer) 0
+      5) "network-bytes-in"
+      6) (integer) 0
+      7) "network-bytes-out"
+      8) (integer) 0
+```
+
+##### Response in RESP3
+```
+> CLUSTER SLOT-STATS SLOTSRANGE 0 1
+1) 1) (integer) 0
+   2) 1# "key-count" => (integer) 0
+      2# "cpu-usec" => (integer) 0
+      3# "network-bytes-in" => (integer) 0
+      4# "network-bytes-out" => (integer) 0
+2) 1) (integer) 1
+   2) 1# "key-count" => (integer) 0
+      2# "cpu-usec" => (integer) 0
+      3# "network-bytes-in" => (integer) 0
+      4# "network-bytes-out" => (integer) 0
+```
+
+### ORDERBY
+Orders slot statistics based on the provided metric.
+The `ORDERBY` argument allows for the user to identify hot / cold slots across the cluster.
+The response is ordered based on sort result.
+In the event of a tie in the provided metric value, ascending slot number is used as a tie breaker.
+
+
+##### Response in RESP2
+```
+> CLUSTER SLOT-STATS ORDERBY KEY-COUNT LIMIT 2 DESC
+1) 1) (integer) 12426
+   2) 1) "key-count"
+      2) (integer) 45
+      3) "cpu-usec"
+      4) (integer) 0
+      5) "network-bytes-in"
+      6) (integer) 0
+      7) "network-bytes-out"
+      8) (integer) 0
+2) 1) (integer) 13902
+   2) 1) "key-count"
+      2) (integer) 20
+      3) "cpu-usec"
+      4) (integer) 0
+      5) "network-bytes-in"
+      6) (integer) 0
+      7) "network-bytes-out"
+      8) (integer) 0
+```
+
+##### Response in RESP3
+```
+> CLUSTER SLOT-STATS ORDERBY KEY-COUNT LIMIT 2 DESC
+1) 1) (integer) 12426
+   2) 1# "key-count" => (integer) 45
+      2# "cpu-usec" => (integer) 0
+      3# "network-bytes-in" => (integer) 0
+      4# "network-bytes-out" => (integer) 0
+2) 1) (integer) 13902
+   2) 1# "key-count" => (integer) 20
+      2# "cpu-usec" => (integer) 0
+      3# "network-bytes-in" => (integer) 0
+      4# "network-bytes-out" => (integer) 0
+```