add discription for hot history command in pd-control.md

pingcap · Dec 26, 2021 · 3058eb1 · 3058eb1
1 parent ceba420
commit 3058eb1
Showing 1 changed file with 61 additions and 5 deletions.
diff --git a/pd-control.md b/pd-control.md
@@ -22,9 +22,9 @@ To use PD Control, execute the `tiup ctl:<cluster-version> pd -u http://<pd_ip>:
 
 If you want to download the latest version of `pd-ctl`, directly download the TiDB package, because `pd-ctl` is included in the TiDB package.
 
-| Package download link | OS | Architecture | SHA256 checksum |
-|:---|:---|:---|:---|
-| `https://download.pingcap.org/tidb-{version}-linux-amd64.tar.gz` (pd-ctl) | Linux | amd64 | `https://download.pingcap.org/tidb-{version}-linux-amd64.sha256` |
+| Package download link                                                     | OS    | Architecture | SHA256 checksum                                                  |
+| :------------------------------------------------------------------------ | :---- | :----------- | :--------------------------------------------------------------- |
+| `https://download.pingcap.org/tidb-{version}-linux-amd64.tar.gz` (pd-ctl) | Linux | amd64        | `https://download.pingcap.org/tidb-{version}-linux-amd64.sha256` |
 
 > **Note:**
 >
@@ -366,7 +366,7 @@ Usage:
 ]
 ```
 
-### `hot [read | write | store]`
+### `hot [read | write | store|  history <start_time> <end_time> [<key> <value>]]`
 
 Use this command to view the hot spot information of the cluster.
 
@@ -376,8 +376,64 @@ Usage:
 >> hot read                             // Display hot spot for the read operation
 >> hot write                            // Display hot spot for the write operation
 >> hot store                            // Display hot spot for all the read and write operations
+>> hot history 1634478065 1634650865    // Display history hot spot 
+[
+	{
+		UpdateTime    ...
+		RegionID      ...
+		PeerID        ... 
+		StoreID       ... 
+		IsLeader      ... 
+		IsLearner     ... 
+		HotRegionType ... 
+		HotDegree     ... 
+		FlowBytes     ... 
+		KeyRate       ... 
+		QueryRate     ... 
+		StartKey      ... 
+		EndKey        ... 
+		EncryptionMeta ...
+	}
+]
+>>hot history 1634478065 1634650865 hot_region_type read region_id [1,2,3] store_id [1,2,3] peer_id [1,2,3] is_leader true is_learner true
+[
+	{
+		UpdateTime    ...
+		RegionID      ...
+		PeerID        ... 
+		StoreID       ... 
+		IsLeader      ... 
+		IsLearner     ... 
+		HotRegionType ... 
+		HotDegree     ... 
+		FlowBytes     ... 
+		KeyRate       ... 
+		QueryRate     ... 
+		StartKey      ... 
+		EndKey        ... 
+		EncryptionMeta ...
+	}
+]
+>>hot history 1634478065 1634650865 hot_region_type write region_id [1,2,3] store_id [1,2,3] peer_id [1,2,3] is_leader false is_learner false
+[
+	{
+		UpdateTime    ...
+		RegionID      ...
+		PeerID        ... 
+		StoreID       ... 
+		IsLeader      ... 
+		IsLearner     ... 
+		HotRegionType ... 
+		HotDegree     ... 
+		FlowBytes     ... 
+		KeyRate       ... 
+		QueryRate     ... 
+		StartKey      ... 
+		EndKey        ... 
+		EncryptionMeta ...
+	}
+]
 ```
-
 ### `label [store <name> <value>]`
 
 Use this command to view the label information of the cluster.