Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
Signed-off-by: husharp <[email protected]>
  • Loading branch information
HuSharp committed May 10, 2023
1 parent 6f550ab commit 1b9f989
Show file tree
Hide file tree
Showing 9 changed files with 94 additions and 3 deletions.
7 changes: 7 additions & 0 deletions dashboard/dashboard-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,13 @@ TiDB Dashboard 在 GitHub 上[开源](https://github.com/pingcap-incubator/tidb-

参阅[日志搜索页面](/dashboard/dashboard-log-search.md)了解详情。

## 资源管控容量预估

[使用资源管控 (Resource Control) 实现资源隔离](/tidb-resource-control.md),集群管理员可以定义资源组 (Resource Group),通过资源组限定读写的配额。在进行资源规划之前,你需要了解集群的整体容量。

参阅[资源管控页面](/dashboard/dashboard-resource-control.md)了解详情。


## 收集分析各个组件的性能数据

高级调试功能:无需第三方工具,在线地对各个组件进行性能分析,剖析组件实例在分析时间段内执行的各种内部操作及比例。
Expand Down
82 changes: 82 additions & 0 deletions dashboard/dashboard-resource-control.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: TiDB Dashboard 资源管控页面
summary: 在集群中搜索所有节点上的日志
aliases: ['/docs-cn/dev/dashboard/dashboard-resource-control/']
---

# TiDB Dashboard 资源管控页面

[使用资源管控 (Resource Control) 实现资源隔离](/tidb-resource-control.md),集群管理员可以定义资源组 (Resource Group),通过资源组限定读写的配额。在进行资源规划之前,你需要了解集群的整体容量。该页面帮助用户查看资源管控相关信息,以便预估集群容量更好地进行资源配额。

## 访问

可以通过以下两种方法访问资源管控页面:

* 登录后,左侧导航条点击**资源管控** (**Resource Control**):

![访问](/media/dashboard/dashboard-resource-manager-access-v710.png)

* 在浏览器中访问 <http://127.0.0.1:2379/dashboard/#/resource_manager>(将 `127.0.0.1:2379` 替换为任意实际 PD 地址和端口)。

## 资源管控页面详情

资源管控页面详情页面如下图所示:

![详情页面](/media/dashboard/dashboard-resource-manager-info.png)

整个页面分为三个部分:

- 配置:数据来自于 TiDB 的 [RESOURCE_GROUPS](/information-schema/information-schema-resource-groups#resource_groups) 表中所有资源组 (resource group) 的信息,参见 [RESOURCE_GROUPS](/information-schema/information-schema-resource-groups.md) 文档了解详细情况。

- 容量估算:在进行资源规划之前,你需要了解集群的整体容量。目前提供两种估算方式:

- [基于硬件部署估算容量](/sql-statements/sql-statement-calibrate-resource.md#基于硬件部署估算容量)
- [根据实际负载估算容量](/sql-statements/sql-statement-calibrate-resource.md#根据实际负载估算容量)

- 监控指标:通过观察面板上的指标,可以了解当前集群整体的资源消耗状态。

### 容量估算

在进行资源规划之前,你需要了解集群的整体容量。目前提供两种估算方式预估当前集群的 [`Request Unit (RU)`](https://docs.pingcap.com/zh/tidb/dev/tidb-resource-control#什么是-request-unit-ru) 的容量:

- [基于硬件部署估算容量](/sql-statements/sql-statement-calibrate-resource.md#基于硬件部署估算容量)

目前提供了以下不同的负载类型供选择:TPCC、OLTP_WRITE_ONLY、OLTP_READ_WRITE、OLTP_READ_ONLY。

![基于硬件部署估算容量](/media/dashboard/dashboard-resource-manager-calibrate-by-hardware.png)

用户资源分组总请求单元为当前除 default 用户外的 RU 总量,当小于容量估算值时,会进行提醒。

> 系统预定义的 `default` 资源组默认拥有无限用量。当所有用户都属于 `default` 资源组时,资源分配方式与关闭资源管控时相同。
- [根据实际负载估算容量](/sql-statements/sql-statement-calibrate-resource#根据实际负载估算容量)

![根据实际负载估算容量](/media/dashboard/dashboard-resource-manager-calibrate-by-workload.png)

可以选定时间范围:

- 当时间窗口范围 `DURATION` 不满足 10 分钟至 24 小时的条件,会导致报错提醒:`the duration of calibration is too short/long, which could lead to inaccurate output. Please make the duration between 10m0s and 24h0m0s`

- 当时间窗口范围内的负载过低,会导致报错提醒:`The workload in selected time window is too low, with which TiDB is unable to reach a capacity estimation; please select another time window with higher workload, or calibrate resource by hardware instead`

可以通过监控指标中的 CPU Usage 来选定合适负载。

### 监控指标

可以选定时间范围,时区与前端用户所处时区相同。

- Total RU Consumed:实时统计的 [Request Unit (RU)](/tidb-resource-control#什么是-request-unit-ru) 总消耗量
- RU Consumed by Resource Groups:以 Resource Group(资源组)为单位进行实时统计的 [Request Unit (RU)](/tidb-resource-control.md#什么是-request-unit-ru) 消耗信息
- TiDB CPU Usage
- CPU Quota: TiDB 最大 CPU 占用率
- avg:所有 TiDB 实例平均 CPU 利用率
- delta:所有 TiDB 实例中最大 CPU 利用率减去所有 TiDB 实例中最小 CPU 利用率
- max:所有 TiDB 实例中最大 CPU 利用率
- TiKV CPU/IO MBps
- CPU Quota: TiKV 最大 CPU 占用率
- CPU-Avg:所有 TiKV 实例平均 CPU 利用率
- CPU-Delta:所有 TiKV 实例中最大 CPU 利用率减去所有 TiKV 实例中最小 CPU 利用率
- CPU-MAX:所有 TiKV 实例中最大 CPU 利用率
- IO MBps:所有 TiKV 实例 MBps
- IO-Delta:所有 TiKV 实例中最大 MBps 减去所有 TiKV 实例中最小 MBps
- IO-MAX:所有 TiKV 实例中最大 MBps
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/resource-control-search-home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/resource-control-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 5 additions & 3 deletions tidb-resource-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Request Unit (RU) 是 TiDB 对 CPU、IO 等系统资源的统一抽象的单位,
- [根据实际负载估算容量](/sql-statements/sql-statement-calibrate-resource.md#根据实际负载估算容量)
- [基于硬件部署估算容量](/sql-statements/sql-statement-calibrate-resource.md#基于硬件部署估算容量)

详情请参考 [`CALIBRATE RESOURCE` 预估方式](/sql-statements/sql-statement-calibrate-resource.md#预估方式)
可通过 [Dashboard 资源管控页面](/dashboard/dashboard-resource-control.md) 进行查看,详情请参考 [`CALIBRATE RESOURCE` 预估方式](/sql-statements/sql-statement-calibrate-resource.md#预估方式)

### 管理资源组

Expand Down Expand Up @@ -172,9 +172,11 @@ SELECT /*+ RESOURCE_GROUP(rg1) */ * FROM t limit 10;

## 监控与图表

TiDB 会定时采集资源管控的运行时信息,并在 Grafana 的 **Resource Control Dashboard** 中提供了相关指标的可视化图表。指标详情参见 [Resource Control 监控指标详解](/grafana-resource-control-dashboard.md) 。
TiDB 会定时采集资源管控的运行时信息,并在 Grafana 的 **Resource Control Dashboard** 中提供了相关指标的可视化图表,详见 [Resource Control 监控指标详解](/grafana-resource-control-dashboard.md) 。

TiKV 中也记录了来自于不同资源组的请求 QPS,详见 [TiKV监控指标详解](/grafana-tikv-dashboard.md#grpc)
TiKV 中也记录了来自于不同资源组的请求 QPS,详见 [TiKV 监控指标详解](/grafana-tikv-dashboard.md#grpc)

Dashboard 中可以查看当前 [RESOURCE_GROUPS](/information-schema/information-schema-resource-groups#resource_groups) 表,详见 [Dashboard 资源管控页面](/dashboard/dashboard-resource-control.md) 。

## 工具兼容性

Expand Down

0 comments on commit 1b9f989

Please sign in to comment.