查看雲資料庫 Tair(相容 Redis)執行個體的效能監控資訊。
介面說明
該 API 對應的控制台操作請參見效能監控。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
kvstore:DescribeHistoryMonitorValues |
get |
*DBInstance
|
|
無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| InstanceId |
string |
是 |
執行個體 ID。 |
r-bp1zxszhcgatnx**** |
| StartTime |
string |
是 |
查詢歷史監控開始時間點,格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 |
2022-11-06T00:00:00Z |
| EndTime |
string |
是 |
查詢歷史監控結束時間點,須晚於歷史監控開始時間,格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 說明
支援查詢最近 1 個月的監控資料,且最大查詢範圍不能超過 7 天。 |
2022-11-06T00:30:00Z |
| IntervalForHistory |
string |
是 |
本參數已廢棄,固定取值為 實際會根據查詢的開始時間和結束時間自動決定查詢的時間間隔。以查詢時間範圍小於等於 10 分鐘為例,資料彙總頻率為 5s/次,查詢結果會按照 5s/次的頻率返回。 說明
|
01m |
| MonitorKeys |
string |
否 |
監控指標,如需傳入多個監控指標,需使用英文逗號(,)分隔。以 CpuUsage 為例:
更多資訊監控指標與詳細說明,請參見下方的MonitorKeys 參數補充說明。 說明
|
CpuUsage |
| NodeId |
string |
否 |
執行個體的中的節點 ID。傳入本參數可查詢指定節點的監控資訊。 說明
|
r-bp1zxszhcgatnx****-db-0#1679**** |
| NodeRole |
string |
否 |
若希望查詢雲原生版讀寫分離架構執行個體中唯讀節點的指標,您在傳入具體 NodeId 的同時,還需要在本參數傳入 READONLY。 說明
其餘情況請無需傳入(或傳入 MASTER)。 |
READONLY |
| Type |
string |
否 |
MonitorKeys 參數補充說明
調用 OpenAPI 時,請傳入下表MonitorKeys列參數,系統將返回子監控項。執行個體支援通用類監控項和命令統計類監控項。
通用類監控項
通用類監控項的使用說明如下,以 CpuUsage 為例。
-
叢集節點或讀寫分離架構:
查詢所有資料節點(DB)整體的 CPU 使用率:您需要傳入CpuUsage$db。
查詢所有 Proxy 節點整體的 CPU 使用率:您需要傳入CpuUsage$proxy。
查詢單個資料節點或 Proxy 節點的 CPU 使用率:您需要傳入CpuUsage,同時在 NodeId 參數指定 DB 節點或 Proxy 節點。
-
標準架構(主備):傳入 CpuUsage 即可。
MonitorKeys | 子監控項 | 單位 | 說明 | 支援範圍 |
CpuUsage | CpuUsage | % | CPU 使用率,範圍為 0~100。 說明 若您的執行個體原先傳入或返回 RedisCpuUsage 參數,您仍可以使用原參數。 |
|
MemoryUsage | memoryUsage | % | 記憶體使用量率。 |
|
quotaMemory | quotaMemory | Bytes | 當前分區的記憶體總量。 |
|
UsedMemory | UsedMemory | Bytes | 已使用記憶體量,包含資料和緩衝部分。 |
|
Tair_PmemUsage | PmemUsage | % | 分別為持久記憶體使用量率、持久記憶體已使用量和持久記憶體的記憶體總量。 僅持久記憶體型執行個體支援。 |
|
Tair_Pmem | PmemUsed | Bytes | ||
PmemQuota | Bytes | |||
Redis_DetailedSpaceUsage | ins_size | MB | 分別為執行個體佔用總磁碟空間、資料檔案佔用的磁碟空間(包括 AOF、RDB 檔案)和記錄檔佔用的磁碟空間(包含作業記錄)。 僅經典部署模式(原本地碟)的記憶體型執行個體支援。 |
|
data_size | MB | |||
log_size | MB | |||
Redis_Memory_Monitor | used_memory_rss | Bytes | 該進程所佔的實體記憶體,即作業系統分配給 Tair 服務的記憶體。 |
|
used_memory_lua | Bytes | Lua 指令碼使用記憶體量。 | ||
used_memory_startup | Bytes | Tair 啟動時消耗的記憶體。 | ||
lazyfree_pending_objects | Counts | Tair 執行 lazy free 操作,在等待被實際回收內容的鍵個數。 | ||
used_memory_overhead | Bytes | Tair 為維護資料集的內部機制所需的記憶體開銷,包括所有用戶端的輸出緩衝區、查詢緩衝區和 AOF。 | ||
used_memory_dataset | Bytes | 資料佔用的記憶體空間。 | ||
UsedQPS | TotalQps | Counts/s | 每秒總請求數,包含讀和寫命令。 |
|
GetQps | Counts/s | 分別代表每秒讀、寫命令的請求數。執行個體的相容版本需為 Redis 4.0 及以上。 | ||
PutQps | Counts/s | |||
OtherOps | Counts/s | 指 PING、INFO、SELECT 與 AUTH 等無讀寫屬性的請求。由於 Proxy 對請求存在特殊處理,若執行個體帶有 Proxy 節點,則 OtherOps 僅包含部分 INFO 請求。 | ||
ConnectionUsage | connectionUsage | % | 串連數使用率,計算方法:已串連數÷執行個體支援的總串連數。用戶端通過直連地址串連至Tair執行個體(叢集架構)時,此指標具備參考價值。 |
|
UsedConnection | ConnCount | Counts | 已使用串連數。 | |
IntranetIn | InFlow | KB/s | 入、出流量速率。 |
|
IntranetOut | OutFlow | KB/s | ||
IntranetInRatio | intranetInRatio | % | 入、出流量使用率。 |
|
IntranetOutRatio | intranetOutRatio | % | ||
Redis_Avg_Rt_Monitor | AvgRt | us | 平均時延,表示後端節點從接收命令到發出響應的時延平均值。
|
|
Redis_Max_Rt_Monitor | MaxRt | us | 最大時延,表示節點從接收命令到發出響應的時延最大值。
| |
Redis_Basic_Monitor | Keys | Counts | Key 總數量,即執行個體儲存的一級 Key 總數。 |
|
Expires | Counts | 執行個體中設定到期時間的 Key 數量,該指標展示的是採集資料時的瞬時值。 | ||
ExpiredKeys | Counts | 歷史累計淘汰的 Key 總數。 | ||
EvictedKeys | Counts | 歷史累計逐出的 Key 總數。 | ||
ExpiredKeysPerSecond | Counts/s | 每秒淘汰的 Key 數量。 | ||
EvictedKeysPerSecond | Counts/s | 每秒逐出的 Key 數量。 | ||
inmem_keys | Counts | 該參數僅混合儲存型執行個體(已停售)支援,可忽略。 | ||
swapped_keys | Counts | |||
Hit_Rate_Monitor | hit_rate | % | 命中率計算方法:Key 命中數÷(Key 命中數+Key 未命中數)。 |
|
hit | Counts | 每秒命中的 Key 數量。 | ||
miss | Counts | 每秒未命中的 key 數量。 | ||
evicted_keys_per_sec | Counts | 每秒被驅逐的 Key 數量。 | ||
DiskUsage | disk_usage | % | 分別為磁碟使用率、輸入緩衝區佔用大小、輸出緩衝區佔用大小和磁碟效能監控項,僅磁碟型執行個體支援。 |
|
RocksDBConn | Tair_Connection_Monitor | Bytes | ||
Tair_Connection_Monitor | Bytes | |||
Tair_Disk_Monitor | io_bandwidth_kbps、iops、iops_usage 等。 | %、ms、Counts 等。 | ||
UsedConnection | ConnectionUsage | % | 串連數使用率,計算方法:已使用串連數÷節點支援的最大串連數。用戶端通過 Proxy 節點串連至Tair執行個體(叢集或讀寫分離架構)時,此指標具備參考價值。 |
|
UsedConnection | Counts | 已使用串連數。 | ||
NewUserConnQps | Counts/s | 用戶端到 Proxy 節點每秒建立的串連數。 | ||
Redis_Package_Monitor | request | Byte | 單個請求的平均位元組數。 |
|
response | Byte | 單個響應的平均位元組數。 | ||
request_max | Byte | 單個請求的最大位元組數。 | ||
response_max | Byte | 單個響應的最大位元組數。 | ||
RedisProxyConn | RedisUsedConnection | Counts | Proxy 節點到資料節點的串連數。 | |
NewDBConnQps | Counts/s | Proxy 節點到資料節點每秒建立的串連數。 | ||
DisconnectDBConn | Counts | Proxy 節點到資料節點累計斷連次數。 | ||
DisconnectUserConn | Counts | 用戶端到 Proxy 節點的累計斷連次數。 | ||
TotalCalls | TotalRefusedCommands | Counts | 累計拒絕命令數。 | |
TotalCallsPerSecCalls | Counts/s | 每秒請求數。 | ||
TotalCallsPerSecRetryCalls | Counts/s | 每秒請求重試數。 | ||
TotalCallsPerSecRetryFailed | Counts/s | 每秒失敗請求數。 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| MonitorHistory |
string |
以 JSON 格式返回的監控資訊,更多資訊,請參見監控參數說明。 說明
為提高資料轉送效率,只有非 0 的監控資料才會返回,其餘未顯示的監控資料均為預設值 0。 |
"{\"2022-11-06T00:00:00Z\":{\"memoryUsage\":\"6.67\"},\"2022-11-06T00:00:05Z\":{\"memoryUsage\":\"6.67\"},\"2022-11-06T00:00:10Z\":{\"memoryUsage\":\"6.67\"},\"2022-11-06T00:00:15Z\":{\"memoryUsage\":\"6.67\"},\"2022-11-06T00:00:20Z\":{\"memoryUsage\":\"6.67\"},\"2022-11-06T00:00:25Z\":{\"memoryUsage\":\"6.67\"}}" |
| RequestId |
string |
請求 ID。 |
F0997EE8-F4C2-4503-9168-85177ED7**** |
樣本
正常返回樣本
JSON格式
{
"MonitorHistory": "\"{\\\"2022-11-06T00:00:00Z\\\":{\\\"memoryUsage\\\":\\\"6.67\\\"},\\\"2022-11-06T00:00:05Z\\\":{\\\"memoryUsage\\\":\\\"6.67\\\"},\\\"2022-11-06T00:00:10Z\\\":{\\\"memoryUsage\\\":\\\"6.67\\\"},\\\"2022-11-06T00:00:15Z\\\":{\\\"memoryUsage\\\":\\\"6.67\\\"},\\\"2022-11-06T00:00:20Z\\\":{\\\"memoryUsage\\\":\\\"6.67\\\"},\\\"2022-11-06T00:00:25Z\\\":{\\\"memoryUsage\\\":\\\"6.67\\\"}}\"",
"RequestId": "F0997EE8-F4C2-4503-9168-85177ED7****"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | The Specified parameter "StartTime" is not valid. | |
| 400 | InvalidEndTime.Malformed | The Specified parameter "EndTime" is not valid. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。