From 6fcc4120e62e682dd564ea7dcad2a6023aacc44d Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 22 Sep 2022 11:41:13 +0800 Subject: [PATCH] dashboard community add overview --- .../4.cluster-operator/2.monitor.md | 4 +- docs-2.0/nebula-dashboard/4.use-dashboard.md | 127 +++++++++++------- 2 files changed, 80 insertions(+), 51 deletions(-) diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md index 5b0ecd74937..bc8a575377a 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md @@ -6,7 +6,7 @@ ## 节点监控 -单击**集群监控**->**节点监控**进入节点监控页面。 +单击**集群监控**->**节点监控**->**总览**进入节点监控总览页面。 用户可快速查看 CPU、Memory、Load、Disk 和 Network In/Out 变化情况。 @@ -23,7 +23,7 @@ ## 服务监控 -单击**集群监控**->**服务监控**进入服务监控页面。 +单击**集群监控**->**服务监控**->**总览**进入服务监控总览页面。 用户可快速查看 Graph、Meta、Storage 服务的信息，右上角显示正常服务和异常服务的数量。 diff --git a/docs-2.0/nebula-dashboard/4.use-dashboard.md b/docs-2.0/nebula-dashboard/4.use-dashboard.md index 4dc7587e828..393dc37c56f 100644 --- a/docs-2.0/nebula-dashboard/4.use-dashboard.md +++ b/docs-2.0/nebula-dashboard/4.use-dashboard.md @@ -4,92 +4,121 @@ Dashboard 页面主要分为机器、服务、管理三个部分，本文将详 ## 页面概览 -![页面概览](https://docs-cdn.nebula-graph.com.cn/figures/overview1-220624-cn.png) +![页面概览](https://docs-cdn.nebula-graph.com.cn/figures/overview1-220922-cn.png) ## 机器页面介绍 -机器页面分为如下几个子页面： +单击**机器**->**概览**进入机器概览页面。 -- 概览 - - 可以查看 CPU、内存、负载、磁盘和上下行流量变化情况。 - - - 默认可以选择最多 14 天的监控数据进行查看，支持选择时间段，也可以快捷选择最近 1 小时、6 小时、12 小时、1 天、3 天、7 天和 14 天。 +用户可快速查看 CPU、Memory、Load、Disk 和 Network In/Out 变化情况。 - - 默认勾选显示所有实例的监控数据，可以在**实例**框内调整。 +- 默认最多可选择 14 天的监控数据进行查看，支持选择时间段，也可以快捷选择最近 1 小时、6 小时、12 小时、1 天、3 天、7 天和 14 天。 +- 默认勾选显示所有实例的监控数据，可以在**实例**框内调整。 +- 页面的监控数据默认不自动更新，可以调整**更新频率**让页面自动更新，也可以单击![setup](https://docs-cdn.nebula-graph.com.cn/figures/refresh-220616.png)按钮手动更新。 +- 如果需要设置基线，作为参考标准线，可以单击模块右上角的![setup](https://docs-cdn.nebula-graph.com.cn/figures/Setup_cn.png) 按钮。 +- 如果需要查看某一项更详细的监控指标，可以单击模块右上角的![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch_cn.png) 按钮，在示例中选择`Load`查看详情信息，如下图。 + ![load](https://docs-cdn.nebula-graph.com.cn/figures/ds-load-220913-cn.png) + - 可以设置监控时间段、实例、更新频率和基线。 + - 可以搜索和勾选指标。监控指标详情请参见[监控指标说明](6.monitor-parameter.md)。 + - 可以暂时隐藏不需要查看的节点。 + - 可以单击![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch_cn.png) 按钮查看指标详情。 - - 页面的监控数据默认不自动更新，可以调整**更新频率**让页面自动更新，也可以单击![setup](https://docs-cdn.nebula-graph.com.cn/figures/refresh-220616.png)按钮手动更新。 +## 服务页面介绍 - 如果需要查看某一项更详细的监控指标，可以单击模块右上角的![眼睛](https://docs-cdn.nebula-graph.com.cn/figures/eye_cn.png) 按钮，或者在左侧单击监控项。 +单击**服务**->**概览**进入服务概览页面。 -- CPU、内存、负载、磁盘、流量 - - 分类展示机器各个维度的详细监控数据，也可以设置监控时间段、实例、更新频率和基线。监控指标详情请参见[监控指标说明](6.monitor-parameter.md)。 +用户可快速查看 Graph、Meta、Storage 服务的信息，右上角显示正常服务和异常服务的数量。 - ![机器页面](https://docs-cdn.nebula-graph.com.cn/figures/machine-220624-cn.png) +!!! note -## 服务页面介绍 + 服务监控页仅支持每种服务设置两个监控指标，可以单击模块内的设置按钮进行调整。 -服务页面分为如下几个子页面： +- 默认最多可选择 14 天的监控数据进行查看，支持选择时间段，也可以快捷选择最近 1 小时、6 小时、12 小时、1 天、3 天、7 天和 14 天。 +- 默认勾选显示所有实例的监控数据，可以在**实例**框内调整。 +- 页面的监控数据默认不自动更新，可以调整**更新频率**让页面自动更新，也可以单击![setup](https://docs-cdn.nebula-graph.com.cn/figures/refresh-220616.png)按钮手动更新。 +- 可以查看集群内所有服务的状态。 +- 如果需要查看某一项更详细的监控指标，可以单击模块右上角的![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch_cn.png) 按钮，在示例中选择 `Graph` 查看详情信息，如下图。 + ![service](https://docs-cdn.nebula-graph.com.cn/figures/ds-graph-220913-cn.png) + - 可以设置监控时间段、实例、更新频率、周期、聚合方式和基线。 + - 可以搜索和勾选指标。监控指标详情请参见[监控指标说明](6.monitor-parameter.md)。 + - 可以暂时隐藏不需要查看的节点。 + - 可以单击![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch_cn.png) 按钮查看指标详情。 + - Graph 服务支持一系列基于图空间的监控指标。详情参见下文**图空间监控**。 -- 概览 +### 图空间监控 - 可以查看各种服务的监控指标变化情况，右上角还可以切换到**版本**页面查看所有服务的 IP 地址和版本。 +!!! caution - - 默认可以选择最多 14 天的监控数据进行查看，支持选择时间段，也可以快捷选择最近 1 小时、6 小时、12 小时、1 天、3 天、7 天和 14 天。 + 使用图空间指标前，用户需要在 Graph 服务中，设置`enable_space_level_metrics`为`true`。具体操作，参见[Graph 服务配置](../5.configurations-and-logs/1.configurations/3.graph-config.md)。 - - 默认勾选显示所有实例的监控数据，可以在**实例**框内调整。 +!!! compatibility "图监控指标不兼容性" - - 页面的监控数据默认不自动更新，可以调整**更新频率**让页面自动更新，也可以单击![setup](https://docs-cdn.nebula-graph.com.cn/figures/refresh-220616.png)按钮手动更新。 + 如果图空间的名称包括特殊字符，可能会有图空间监控指标数据不显示的问题。 - 如果需要查看某一种服务更详细的监控指标，可以单击模块右上角的![眼睛](https://docs-cdn.nebula-graph.com.cn/figures/eye_cn.png)按钮，或者在左侧单击具体服务。 +服务监控页面还可以监控图空间级别指标。**只有当图空间指标的行为被触发后，用户才能指定图空间查看对应的图空间指标的信息**。图空间的监控指标记录不同图空间的数据。目前，只有 Graph 服务支持基于图空间的监控指标。 - !!! note +Dashboard 支持的图空间指标，参见[图空间级别监控指标](6.monitor-parameter.md)。 - 当前社区版的概览页仅支持每种服务设置两个监控指标，可以单击模块内的**设置**按钮进行调整。 +![graph-metrics](https://docs-cdn.nebula-graph.com.cn/figures/space_level_metrics_cn.png) -- Graph、Meta、Storage +## 管理页面介绍 - 分类展示各个服务的详细监控数据。 +### 信息总览 - - 可以设置监控时间段、实例、更新频率、周期、聚合方式和基线。监控指标详情请参见[监控指标说明](6.monitor-parameter.md)。 +用户可以在**信息总览**页面查看 NebulaGraph 内核相关信息，包括 Storage 服务信息、Storage Leader 分布、NebulaGraph 各个服务的版本信息及所在节点信息、分片的分布情况及详细信息。 - - Graph 服务支持一系列基于图空间的监控指标。详情，参见[图空间监控](../nebula-dashboard-ent/4.cluster-operator/2.monitor.md)。 +![coreinfo](https://docs-cdn.nebula-graph.com.cn/figures/clustercore-info_2022-04-11_cn.png) - - 可以查看当前服务的状态。 +#### Storage Leader 分布 - ![服务页面](https://docs-cdn.nebula-graph.com.cn/figures/service-220624-cn.png) +显示 Leader 数量及 Leader 的分布。 -## 管理页面介绍 +- 单击右上角的 **Balance Leader** 按钮可以快速在 NebulaGraph 集群中均衡分布 Leader。关于 Leader 的详细信息，参见 [Storage 服务](../1.introduction/3.nebula-graph-architecture/4.storage-service.md)。 -!!! note +- 单击右上角的**详情**，查看 Leader 分布的详细信息。 + +#### 版本 + +显示 NebulaGraph 所有服务版本及服务地址。单击右上角的**详情**，查看更多信息。 + +#### 服务信息 + +展示 Storage 服务的基本信息。参数说明如下： + +| 参数 | 说明 | +| :--- | :--- | +| `Host` | 主机地址 | +| `Port` | 主机端口号 | +| `Status` | 主机状态 | +| `Git Info Sha` | 版本 Commit ID | +| `Leader Count` | Leader 总数 | +| `Partition Distribution` | 分片分布 | +| `Leader Distribution` | Leader 分布 | - 非`root`用户只能查看服务信息和有空间权限的分片信息，无法查看配置和长时任务。 +单击右上角的**详情**，查看更多信息。 -管理页面分为如下几个子页面： +#### Partition 分布 -- 服务信息 +左上方选择指定图空间，查看图空间的分片分布情况。显示所有 Storage 服务的 IP 地址、端口，及对应 Storage 服务中的分片数量。 - 展示 Storage 服务的基本信息，包括主机信息、版本 Commit ID、leader 总数、分片分布和 leader 分布。 +单击右上角的**详情**，查看更多信息。 -- 分片信息 +#### 分片信息 - 可以选择不同图空间，查看分片信息。参数说明如下。 +显示分片信息。用户需要在左上角选择图空间，查看分片信息。参数说明如下： - |参数|说明| - |:---|:---| - |`Partition ID`|分片序号。| - |`Leader`|分片的 leader 副本的 IP 地址和端口。| - |`Peers`|分片所有副本的 IP 地址和端口。| - |`Losts`|分片的故障副本的 IP 地址和端口。| +|参数|说明| +|:---|:---| +|`Partition ID`|分片序号。| +|`Leader`|分片的 leader 副本的 IP 地址和端口。| +|`Peers`|分片所有副本的 IP 地址和端口。| +|`Losts`|分片的故障副本的 IP 地址和端口。| -- 配置 - - 展示 Graph 和 Storage 服务的配置信息。暂不支持在线修改配置，详情请参见[配置管理](../5.configurations-and-logs/1.configurations/1.configurations.md)。 +单击右上角的**详情**，查看更多信息，通过右上角的输入框，输入分片 ID，筛选展示的数据。 -- 长时任务 +### 配置 - 展示所有作业的信息。暂不支持在线管理作业，详情请参见[作业管理](../3.ngql-guide/4.job-statements.md)。 +展示 Graph 和 Storage 服务的配置信息。暂不支持在线修改配置。 ## 其他