TiDB 集群监控 API

    TiDB 提供了以下两种接口来监控集群状态：

    • 状态接口：通过 HTTP 接口对外汇报组件的信息。
    • ：通过 HTTP 接口对外汇报表的存储信息。
    • Metrics 接口：使用 Prometheus 记录组件中各种操作的详细信息，使用 Grafana 进行可视化展示。
    • TiDB API 地址：
    • 默认端口：10080

    运行状态

    以下示例中，通过访问 http://${host}:${port}/status 获取当前 TiDB Server 的状态，并判断该 TiDB Server 是否存活。结果以 JSON 格式返回：

    1. {
    2.     connections: 0,  # 当前 TiDB Server 上的客户端连接数
    3.     version: "5.7.25-TiDB-v4.0.0-rc-141-g7267747ae",  # TiDB 版本号
    4.     git_hash: "7267747ae0ec624dffc3fdedb00f1ed36e10284b"  # TiDB 当前代码的 Git Hash
    5. }

    存储信息

    1. {
    2.     "table_schema": "mysql", 
    3.     "table_name": "stats_histograms", 
    4.     "table_rows": 0, 
    5.     "avg_row_length": 0, 
    6.     "data_length": 0, 
    7.     "max_data_length": 0, 
    8.     "index_length": 0, 
    9. }
    1. [
    2.     {
    3.         "table_schema": "test", 
    4.         "table_name": "test", 
    6.         "avg_row_length": 0, 
    7.         "data_length": 0, 
    8.         "max_data_length": 0, 
    9.         "index_length": 0, 
    10.         "data_free": 0
    11.     }
    12. ]

    PD Server

    • PD API 地址：http://${host}:${port}/pd/api/v1/${api_name}
    • 默认端口：2379
    • 各类 api_name 详细信息：参见 PD API Doc

    通过该接口可以获取当前所有 TiKV 节点的状态以及负载均衡信息。下面以一个单节点的 TiKV 集群为例，说明用户需要了解的信息：

    1. {
    2.   "count": 1,  # TiKV 节点数量
    3.   "stores": [  # TiKV 节点的列表
    4.     # 集群中单个 TiKV 节点的信息
    5.     {
    6.       "store": {
    7.         "id": 1,
    8.         "address": "127.0.0.1:20160",
    9.         "status_address": "172.16.5.90:20382",
    10.         "git_hash": "2fdb2804bf8ffaab4b18c4996970e19906296497",
    11.         "start_timestamp": 1590029618,
    13.         "last_heartbeat": 1590030038949235439,
    14.         "state_name": "Up"
    15.       },
    16.       "status": {
    17.         "capacity": "3.581TiB",  # 存储总容量
    18.         "available": "3.552TiB",  # 存储剩余容量
    19.         "used_size": "31.77MiB",
    20.         "leader_count": 174,
    21.         "leader_weight": 1,
    22.         "leader_score": 174,
    23.         "leader_size": 174,
    24.         "region_count": 531,
    25.         "region_weight": 1,
    26.         "region_score": 531,
    27.         "region_size": 531,
    28.         "start_ts": "2020-05-21T10:53:38+08:00",
    29.         "last_heartbeat_ts": "2020-05-21T11:00:38.949235439+08:00",
    30.         "uptime": "7m0.949235439s"
    31.       }
    32.     }

    使用 metrics 接口

    成功部署 Prometheus 和 Grafana 之后，。