diff --git a/dashboard/dashboard-cluster-info.md b/dashboard/dashboard-cluster-info.md index 8e9a9158cbaa..85b21f05d666 100644 --- a/dashboard/dashboard-cluster-info.md +++ b/dashboard/dashboard-cluster-info.md @@ -12,28 +12,28 @@ aliases: ['/docs-cn/dev/dashboard/dashboard-cluster-info/'] 可以通过以下两种方法访问集群信息页面: -- 登录后,左侧导航条点击**集群信息**: +- 登录后,左侧导航条点击**集群信息** (Cluster Info): - ![访问](/media/dashboard/dashboard-cluster-info-access.png) + ![访问](/media/dashboard/dashboard-cluster-info-access-v650.png) - 在浏览器中访问 (将 `127.0.0.1:2379` 替换为实际 PD 实例地址和端口)。 ## 实例列表 -点击**实例**可查看实例列表: +点击**实例** (Instances) 可查看实例列表: -![实例](/media/dashboard/dashboard-cluster-info-instances.png) +![实例](/media/dashboard/dashboard-cluster-info-instances-v650.png) 实例列表列出了该集群中 TiDB、TiKV、PD 和 TiFlash 组件所有实例的概况信息。 表格包含以下列: -- 地址:实例地址 -- 状态:实例的运行状态 -- 启动时间:实例的启动时间 -- 版本:实例版本号 -- 部署路径:实例二进制文件所在目录路径 -- Git 哈希值:实例二进制对应的 Git 哈希值 +- 地址 (Address):实例地址 +- 状态 (Status):实例的运行状态 +- 启动时间 (Up Time):实例的启动时间 +- 版本 (Version):实例版本号 +- Git 哈希值 (Git Hash):实例二进制对应的 Git 哈希值 +- 部署路径 (Deployment Directory):实例二进制文件所在目录路径 实例的运行状态有: @@ -49,22 +49,37 @@ aliases: ['/docs-cn/dev/dashboard/dashboard-cluster-info/'] ## 主机列表 -点击**主机**可查看主机列表: +点击**主机** (Hosts) 可查看主机列表: -![主机](/media/dashboard/dashboard-cluster-info-hosts.png) +![主机](/media/dashboard/dashboard-cluster-info-hosts-v650.png) 主机列表列出了该集群中 TiDB、TiKV、PD 和 TiFlash 组件所有实例对应主机的运行情况。 表格包含以下列: -- 地址:主机 IP 地址 +- 主机地址 (Host Address):主机 IP 地址 - CPU:主机 CPU 逻辑核心数 -- CPU 使用率:主机当前 1 秒的用户态和内核态 CPU 使用率 -- 物理内存:主机总计的物理内存大小 -- 内存使用率:主机当前内存使用率 -- 部署磁盘:主机上运行实例所在磁盘的文件系统和磁盘挂载路径 -- 磁盘使用率:主机上运行实例所在磁盘的空间使用率 +- CPU 使用率 (CPU Usage):主机当前 1 秒的用户态和内核态 CPU 使用率 +- 物理内存 (Memory):主机总计的物理内存大小 +- 内存使用率 (Memory Usage):主机当前内存使用率 > **注意:** > > 主机列表信息由各个实例进程给出,因此当主机上所有实例都处于离线状态时,该主机信息将无法显示。 + +## 磁盘列表 + +点击**磁盘** (Disks) 可查看磁盘列表: + +![磁盘](/media/dashboard/dashboard-cluster-info-disks-v650.png) + +磁盘列表列出了该集群中 TiDB、TiKV、PD 和 TiFlash 组件所有实例对应主机磁盘的情况。 + +表格包含以下列: + +- 主机地址 (Host Address):主机 IP 地址 +- 磁盘挂载点 (Mount Directory):主机上运行实例所在磁盘的挂载路径 +- 文件系统 (File System):主机上运行实例所在磁盘的文件系统类型 +- 磁盘容量 (Disk Capacity):主机上运行实例所在磁盘的总空间大小 +- 磁盘使用率 (Disk Usage):主机上运行实例所在磁盘的空间使用率 +- 实例 (Instance):主机上运行的示例 diff --git a/dashboard/dashboard-diagnostics-access.md b/dashboard/dashboard-diagnostics-access.md index 5b453d80bd1c..5e6e3c3c5abf 100644 --- a/dashboard/dashboard-diagnostics-access.md +++ b/dashboard/dashboard-diagnostics-access.md @@ -15,9 +15,9 @@ aliases: ['/docs-cn/dev/dashboard/dashboard-diagnostics-access/'] 可以通过以下两种方法访问集群诊断页面: -* 登录后,左侧导航条点击**集群诊断** (Cluster Diagnose): +* 登录后,左侧导航条点击**集群诊断** (Cluster Diagnostics): - ![访问](/media/dashboard/dashboard-diagnostics-access.png) + ![访问](/media/dashboard/dashboard-diagnostics-access-v650.png) * 在浏览器中访问 [http://127.0.0.1:2379/dashboard/#/diagnose](http://127.0.0.1:2379/dashboard/#/diagnose)(将 `127.0.0.1:2379` 替换为任意实际 PD 地址和端口)。 @@ -25,36 +25,36 @@ aliases: ['/docs-cn/dev/dashboard/dashboard-diagnostics-access/'] 如果想对一个时间范围内的集群进行诊断,查看集群的负载等情况,可以使用以下步骤来生成一段时间范围的诊断报告: -1. 设置区间的开始时间,例如 2020-05-21 14:40:00。 -2. 设置区间长度。例如 10 min 。 -3. 点击开始。 +1. 设置区间的开始时间,例如 2022-05-21 14:40:00。 +2. 设置区间长度。例如 10 min。 +3. 点击开始 (Start)。 -![生成单个时间段的诊断报告](/media/dashboard/dashboard-diagnostics-gen-report.png) +![生成单个时间段的诊断报告](/media/dashboard/dashboard-diagnostics-gen-report-v650.png) > **注意:** > > 建议生成报告的时间范围在 1 min ~ 60 min 内,目前不建议生成超过 1 小时范围的报告。 -以上操作会生成 2020-05-21 14:40:00 至 2020-05-21 14:50:00 时间范围的诊断报告。点击**开始** (start) 后,会看到以下界面,**生成进度** (progress) 是生成报告的进度条,生成报告完成后,点击**查看报告** (View Full Report) 即可。 +以上操作会生成 2022-05-21 14:40:00 至 2022-05-21 14:50:00 时间范围的诊断报告。点击**开始** (start) 后,会看到以下界面,**生成进度** (Progress) 是生成报告的进度条,生成报告完成后,点击**查看报告** (View Full Report) 即可。 -![生成报告的进度](/media/dashboard/dashboard-diagnostics-gen-process.png) +![生成报告的进度](/media/dashboard/dashboard-diagnostics-gen-process-v650.png) ## 生成对比诊断报告 如果系统在某个时间点发生异常,如 QPS 抖动或者延迟变高,可以生成一份异常时间范围和正常时间范围的对比报告,例如: -* 系统异常时间段:2020-05-21 14:40:00 ~ 2020-05-21 14:45:00,系统异常时间。 -* 系统正常时间段:2020-05-21 14:30:00 ~ 2020-05-21 14:35:00,系统正常时间。 +* 系统异常时间段:2022-05-21 14:40:00 ~ 2022-05-21 14:45:00,系统异常时间。 +* 系统正常时间段:2022-05-21 14:30:00 ~ 2022-05-21 14:35:00,系统正常时间。 生成以上两个时间范围的对比报告的步骤如下: -1. 设置区间的开始时间,即异常时间段的开始时间,如 2020-05-21 14:40:00。 -2. 设置区间长度。一般只系统异常的持续时间,例如 5 min。 -3. 开启与基线区间对比开关。 -4. 设置基线开始时间,即想要对比的系统正常时段的开始时间,如 2020-05-21 14:30:00。 -5. 点击开始。 +1. 设置区间的开始时间,即异常时间段的开始时间,如 2022-05-21 14:40:00。 +2. 设置区间长度 (Range Duration)。一般指系统异常的持续时间,例如 5 min。 +3. 开启与基线区间对比开关 (Compare by Baseline)。 +4. 设置基线开始时间 (Baseline Range Start Time),即想要对比的系统正常时段的开始时间,如 2022-05-21 14:30:00。 +5. 点击开始 (Start)。 -![生成对比报告](/media/dashboard/dashboard-diagnostics-gen-compare-report.png) +![生成对比报告](/media/dashboard/dashboard-diagnostics-gen-compare-report-v650.png) 然后同样等报告生成完成后点击**查看报告** (View Full Report) 即可。 diff --git a/dashboard/dashboard-key-visualizer.md b/dashboard/dashboard-key-visualizer.md index ee1ee190aa12..9b8d3f3f565a 100644 --- a/dashboard/dashboard-key-visualizer.md +++ b/dashboard/dashboard-key-visualizer.md @@ -11,9 +11,9 @@ aliases: ['/docs-cn/dev/dashboard/dashboard-key-visualizer/','/docs-cn/dev/how-t 可以通过以下两种方法访问 Key Visualizer 流量可视化页面: -* 登录 TiDB Dashboard 后,点击左侧导航条的 **Key Visualizer**(流量可视化): +* 登录 TiDB Dashboard 后,点击左侧导航条的**流量可视化** (Key Visualizer): -![访问](/media/dashboard/dashboard-keyviz-access.png) + ![访问](/media/dashboard/dashboard-keyviz-access-v650.png) * 在浏览器中访问 `http://127.0.0.1:2379/dashboard/#/keyviz`(将 `127.0.0.1:2379` 替换为实际 PD 实例地址和端口)。 @@ -63,7 +63,7 @@ aliases: ['/docs-cn/dev/dashboard/dashboard-key-visualizer/','/docs-cn/dev/how-t ### 设置 -首次使用流量可视化页面需要先通过**设置**页面手动开启此功能。参考页面指引,点击 **Open Settings**(打开设置)即可打开设置页面: +首次使用流量可视化页面需要先通过**设置**页面手动开启此功能。参考页面指引,点击**打开设置** (Open Settings) 即可打开设置页面: ![功能未开启](/media/dashboard/dashboard-keyviz-not-enabled.png) @@ -75,7 +75,7 @@ aliases: ['/docs-cn/dev/dashboard/dashboard-key-visualizer/','/docs-cn/dev/how-t ![设置页面](/media/dashboard/dashboard-keyviz-settings.png) -通过开关设定好是否开启收集,并点击 **Save**(保存)后生效。开启后,在界面上观察到工具栏已经可以使用: +通过开关设定好是否开启收集,并点击**保存** (Save) 后生效。开启后,在界面上观察到工具栏已经可以使用: ![工具栏](/media/dashboard/dashboard-keyviz-toolbar.png) @@ -86,12 +86,12 @@ aliases: ['/docs-cn/dev/dashboard/dashboard-key-visualizer/','/docs-cn/dev/how-t 打开流量可视化页面时,默认会显示最近六小时整个数据库内的热力图。其中,越靠近右侧(当前时间)时,每列 Bucket 对应的时间间隔会越小。如果你想观察某个特定时间段或者特定的 Region 范围,则可以通过放大来获得更多细节。具体操作描述如下: * 在热力图中向上或向下滚动。 -* 点击 **Select & Zoom**(框选)按钮,然后点击并拖动以选择要放大的区域。 +* 点击**框选** (Select & Zoom) 按钮,然后点击并拖动以选择要放大的区域。 ![框选](/media/dashboard/dashboard-keyviz-select-zoom.gif) -* 点击 **Reset**(重置)按钮,将 Region 范围重置为整个数据库。 -* 点击「时间选择框」(界面的 **6 hours** 处),重新选择观察时间段。 +* 点击**重置** (Reset) 按钮,将 Region 范围重置为整个数据库。 +* 点击「时间选择框」(界面的 **6 hour** 处),重新选择观察时间段。 ![时间选择](/media/dashboard/dashboard-keyviz-select-time.png) @@ -101,7 +101,7 @@ aliases: ['/docs-cn/dev/dashboard/dashboard-key-visualizer/','/docs-cn/dev/how-t ### 调整亮度 -热力图使用颜色的明暗来表达一个 Bucket 的流量高低,颜色越暗 (cold) 表示该区域的 Region 在这个时间段上读写流量较低,颜色越亮 (hot) 表示读写流量越高,即越热。如果热力图中的颜色太亮或太暗,则可能很难观察到细节。此时,可以点击 **Brightness**(调整亮度)按钮,然后通过滑块来调节页面的亮度。 +热力图使用颜色的明暗来表达一个 Bucket 的流量高低,颜色越暗 (cold) 表示该区域的 Region 在这个时间段上读写流量较低,颜色越亮 (hot) 表示读写流量越高,即越热。如果热力图中的颜色太亮或太暗,则可能很难观察到细节。此时,可以点击**调整亮度** (Brightness) 按钮,然后通过滑块来调节页面的亮度。 > **注意:** > @@ -121,7 +121,7 @@ aliases: ['/docs-cn/dev/dashboard/dashboard-key-visualizer/','/docs-cn/dev/how-t ### 刷新与自动刷新 -可以通过点击 **Refresh**(刷新)按钮来重新获得基于当前时间的热力图。当需要实时观察数据库的流量分布情况时,可以点击按钮右侧的向下箭头,选择一个固定的时间间隔让热力图按此间隔自动刷新。 +可以通过点击**刷新** (Refresh) 按钮来重新获得基于当前时间的热力图。当需要实时观察数据库的流量分布情况时,可以点击按钮右侧的向下箭头,选择一个固定的时间间隔让热力图按此间隔自动刷新。 > **注意:** > diff --git a/dashboard/dashboard-metrics-relation.md b/dashboard/dashboard-metrics-relation.md index 5d323c425bcd..4f90513e22c7 100644 --- a/dashboard/dashboard-metrics-relation.md +++ b/dashboard/dashboard-metrics-relation.md @@ -9,11 +9,11 @@ TiDB Dashboard 监控关系图是 TiDB v4.0.7 起提供的新功能,可以将 ## 访问关系图 -登录 TiDB Dashboard 后点击左侧导航的**集群诊断**可以进入此功能页面: +登录 TiDB Dashboard 后点击左侧导航的**集群诊断** (Cluster Diagnostics) 可以进入此功能页面: -![生成监控关系图首页](/media/dashboard/dashboard-metrics-relation-home.png) +![生成监控关系图首页](/media/dashboard/dashboard-metrics-relation-home-v650.png) -设置**区间起始时间**和**区间长度**参数后,点击**生成监控关系图**按钮后,会进入监控关系图页面。 +设置**区间起始时间** (Range Start Time) 和**区间长度** (Range Duration) 参数后,点击**生成监控关系图** (Generate Metrics Relation) 按钮后,会进入监控关系图页面。 ## 关系图解读 diff --git a/dashboard/dashboard-overview.md b/dashboard/dashboard-overview.md index 8b01639846a8..739e9eddcaa2 100644 --- a/dashboard/dashboard-overview.md +++ b/dashboard/dashboard-overview.md @@ -18,7 +18,7 @@ aliases: ['/docs-cn/dev/dashboard/dashboard-overview/'] 登录 TiDB Dashboard 后默认进入该页面,也可以左侧导航条点击**概况** (Overview) 进入: -![访问](/media/dashboard/dashboard-overview-access.png) +![访问](/media/dashboard/dashboard-overview-access-v650.png) ## QPS diff --git a/dashboard/dashboard-session-share.md b/dashboard/dashboard-session-share.md index b24f2e5a8a67..83bde2297e9d 100644 --- a/dashboard/dashboard-session-share.md +++ b/dashboard/dashboard-session-share.md @@ -15,7 +15,7 @@ summary: 了解如何将当前的 TiDB Dashboard 会话分享给其他用户访 3. 点击**分享当前会话** (Share Current Session)。 - ![操作示例](/media/dashboard/dashboard-session-share-settings-1.png) + ![操作示例](/media/dashboard/dashboard-session-share-settings-1-v650.png) > **注意:** > @@ -29,11 +29,11 @@ summary: 了解如何将当前的 TiDB Dashboard 会话分享给其他用户访 5. 点击**生成授权码** (Generate Authorization Code)。 - ![操作示例](/media/dashboard/dashboard-session-share-settings-2.png) + ![操作示例](/media/dashboard/dashboard-session-share-settings-2-v650.png) 6. 将生成出来的**授权码**提供给要分享的用户。 - ![操作示例](/media/dashboard/dashboard-session-share-settings-3.png) + ![操作示例](/media/dashboard/dashboard-session-share-settings-3-v650.png) > **警告:** > @@ -43,14 +43,14 @@ summary: 了解如何将当前的 TiDB Dashboard 会话分享给其他用户访 1. 在 TiDB Dashboard 登录界面上,点击**使用其他登录方式** (Use Alternative Authentication)。 - ![操作示例](/media/dashboard/dashboard-session-share-signin-1.png) + ![操作示例](/media/dashboard/dashboard-session-share-signin-1-v650.png) 2. 选择使用**授权码** (Authorization Code) 登录。 - ![操作示例](/media/dashboard/dashboard-session-share-signin-2.png) + ![操作示例](/media/dashboard/dashboard-session-share-signin-2-v650.png) 3. 输入从分享者取得的授权码。 4. 点击**登录** (Sign In)。 - ![操作示例](/media/dashboard/dashboard-session-share-signin-3.png) + ![操作示例](/media/dashboard/dashboard-session-share-signin-3-v650.png) diff --git a/media/dashboard/dashboard-cluster-info-access-v650.png b/media/dashboard/dashboard-cluster-info-access-v650.png new file mode 100644 index 000000000000..63afacf5a233 Binary files /dev/null and b/media/dashboard/dashboard-cluster-info-access-v650.png differ diff --git a/media/dashboard/dashboard-cluster-info-disks-v650.png b/media/dashboard/dashboard-cluster-info-disks-v650.png new file mode 100644 index 000000000000..79f23625eba3 Binary files /dev/null and b/media/dashboard/dashboard-cluster-info-disks-v650.png differ diff --git a/media/dashboard/dashboard-cluster-info-hosts-v650.png b/media/dashboard/dashboard-cluster-info-hosts-v650.png new file mode 100644 index 000000000000..dafa0a10f2c0 Binary files /dev/null and b/media/dashboard/dashboard-cluster-info-hosts-v650.png differ diff --git a/media/dashboard/dashboard-cluster-info-instances-v650.png b/media/dashboard/dashboard-cluster-info-instances-v650.png new file mode 100644 index 000000000000..8ade85d7f79f Binary files /dev/null and b/media/dashboard/dashboard-cluster-info-instances-v650.png differ diff --git a/media/dashboard/dashboard-diagnostics-access-v650.png b/media/dashboard/dashboard-diagnostics-access-v650.png new file mode 100644 index 000000000000..5c9d6a534d73 Binary files /dev/null and b/media/dashboard/dashboard-diagnostics-access-v650.png differ diff --git a/media/dashboard/dashboard-diagnostics-gen-compare-report-v650.png b/media/dashboard/dashboard-diagnostics-gen-compare-report-v650.png new file mode 100644 index 000000000000..8674cf01b3ab Binary files /dev/null and b/media/dashboard/dashboard-diagnostics-gen-compare-report-v650.png differ diff --git a/media/dashboard/dashboard-diagnostics-gen-process-v650.png b/media/dashboard/dashboard-diagnostics-gen-process-v650.png new file mode 100644 index 000000000000..372045114b27 Binary files /dev/null and b/media/dashboard/dashboard-diagnostics-gen-process-v650.png differ diff --git a/media/dashboard/dashboard-diagnostics-gen-report-v650.png b/media/dashboard/dashboard-diagnostics-gen-report-v650.png new file mode 100644 index 000000000000..27b57063d4b5 Binary files /dev/null and b/media/dashboard/dashboard-diagnostics-gen-report-v650.png differ diff --git a/media/dashboard/dashboard-keyviz-access-v650.png b/media/dashboard/dashboard-keyviz-access-v650.png new file mode 100644 index 000000000000..1c0ac8d6b313 Binary files /dev/null and b/media/dashboard/dashboard-keyviz-access-v650.png differ diff --git a/media/dashboard/dashboard-metrics-relation-home-v650.png b/media/dashboard/dashboard-metrics-relation-home-v650.png new file mode 100644 index 000000000000..c8962948ffc2 Binary files /dev/null and b/media/dashboard/dashboard-metrics-relation-home-v650.png differ diff --git a/media/dashboard/dashboard-overview-access-v650.png b/media/dashboard/dashboard-overview-access-v650.png new file mode 100644 index 000000000000..c1993fb8b0e7 Binary files /dev/null and b/media/dashboard/dashboard-overview-access-v650.png differ diff --git a/media/dashboard/dashboard-session-share-settings-1-v650.png b/media/dashboard/dashboard-session-share-settings-1-v650.png new file mode 100644 index 000000000000..f0ebba02066f Binary files /dev/null and b/media/dashboard/dashboard-session-share-settings-1-v650.png differ diff --git a/media/dashboard/dashboard-session-share-settings-2-v650.png b/media/dashboard/dashboard-session-share-settings-2-v650.png new file mode 100644 index 000000000000..c2ec85621134 Binary files /dev/null and b/media/dashboard/dashboard-session-share-settings-2-v650.png differ diff --git a/media/dashboard/dashboard-session-share-settings-3-v650.png b/media/dashboard/dashboard-session-share-settings-3-v650.png new file mode 100644 index 000000000000..448912340ba6 Binary files /dev/null and b/media/dashboard/dashboard-session-share-settings-3-v650.png differ diff --git a/media/dashboard/dashboard-session-share-signin-1-v650.png b/media/dashboard/dashboard-session-share-signin-1-v650.png new file mode 100644 index 000000000000..cfc7070c1fac Binary files /dev/null and b/media/dashboard/dashboard-session-share-signin-1-v650.png differ diff --git a/media/dashboard/dashboard-session-share-signin-2-v650.png b/media/dashboard/dashboard-session-share-signin-2-v650.png new file mode 100644 index 000000000000..1e8ed40dc70d Binary files /dev/null and b/media/dashboard/dashboard-session-share-signin-2-v650.png differ diff --git a/media/dashboard/dashboard-session-share-signin-3-v650.png b/media/dashboard/dashboard-session-share-signin-3-v650.png new file mode 100644 index 000000000000..81787087bd16 Binary files /dev/null and b/media/dashboard/dashboard-session-share-signin-3-v650.png differ