diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/cluster-diagnosis.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/cluster-diagnosis.md index 5f297389ca..af3bb605e0 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/cluster-diagnosis.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/cluster-diagnosis.md @@ -5,7 +5,7 @@ ## 功能介绍 - 通过诊断报告可以排查出当前集群出现的问题，并可以对问题进行解决。 -- 快速了解集群内各个节点以及服务，Session，服务配置的基本情况。 +- 快速了解集群内各个节点以及服务、Session、服务配置的基本情况。 - 根据诊断的报告信息，做出运维建议和集群预警。 ## 入口 @@ -22,144 +22,39 @@ 集群诊断是对集群历史数据的诊断，因此用户设置的诊断范围的结束时间不能超过当前时间。 -2. 在**集群诊断**页面，单击**开始诊断**。 +2. 确认**诊断公式**的配置。用户可以自行调整公式。 - ![diagnosepage](https://docs-cdn.nebula-graph.com.cn/figures/cluster-diagnose_2022-04-11_cn.png) + 公式中的 weight 函数为：`weight(value>conditionValue , weightValue)`，其中的蓝色字体内容支持修改。函数值的计算公式为`(value - conditionValue * timeRange)/((maxValue - conditionValue) * timeRange) * weightValue`。 + + - value：当前指标值。 + - conditionValue：满足条件的最低值。 + - timeRange：时间范围天数。对于 avg 类型的指标，该参数值为 1。 + - maxValue：最大指标值。百分比类型指标最大值为 100，其余类型最大值为 conditionValue 的 2 倍。 + + 例如`weight(hit_memory_times > 10 * days, 10)`，当时间范围选择 2 天、`hit_memory_times = 40`时，计算公式为`(40 - 10 * 2)/((10*2 - 10) * 2) * 10 = 10`。 -3. 当诊断状态由 **generating** 变为 **success** 时，即表示诊断已经完成。 +3. 单击**开始诊断**。 + + ![diagnosepage](https://docs-cdn.nebula-graph.com.cn/figures/cluster_diagnose_230327_cn.png) + +4. 当诊断状态变为**成功**时，表示诊断已经完成，可以查看诊断报告。 ## 查看诊断报告 -在诊断列表中，单击目标诊断右侧的**详情**可以直接查看诊断报告，也可以下载 PDF 格式诊断报告到本地。 +在诊断列表中，单击目标诊断右侧的**详情**可以直接查看诊断报告。 集群诊断报告中包含以下内容： -- 诊断结果 - 基本信息 -- 负载 -- Network -- Session + - 展示需要重点关注的信息，例如紧急告警、普通告警、提示等。 + - 展示集群健康分数、CPU 最大平均使用率、内存最大平均使用率等。 +- 节点信息 + - 展示各节点的 Host、实例数量、架构、系统。 + - 展示各节点的 CPU、内存、硬盘、网络流量情况。 - 服务信息 + - 展示各服务的在线情况、Session 信息。 + - 展示 Graph、Meta、Storage 服务稳定性信息。 - 配置信息 + - 展示配置变更信息。 -### 诊断结果 - -- 当以下参数出现异常时，诊断结果中会显示相应的信息，包括参数名、类型、严重程度、详情。 - - | 参数 | 说明 | - | ---------------------------------- | ---- | - | `num_queries_hit_memory_watermark` | 执行的 nGQL 语句中达到内存水位值的数量。 | - | `graphd_down ` | Graph 服务停止运行。 | - | `storaged_down` | Storage 服务停止运行。 | - | `metad_down` | Meta 服务停止运行。 | - | `node-exporter down` | 用于收集节点系统数据的服务停止运行。 | - -- 当未诊断到任何异常时，诊断结果中**不显示诊断信息**。 - -### 基本信息 - -![basic-info](https://docs-cdn.nebula-graph.com.cn/figures/basicinfo_2022-04-13_cn.png) - -- **诊断区间**：显示生成报告的时间范围，包括开始时间和结束时间。 - -- **节点信息**：显示集群中节点的数量、CPU、内存、磁盘等信息。 - - | 参数 | 说明 | - | ---------------------------------- | ---- | - | `HOST` | 服务器的 IP 地址。 | - | `INSTANCE` | 该服务器部署的实例数量，例如：`metad*1 graphd*1 storaged*1`。 | - | `CPU` | CPU 核数，单位 Core。 | - | `MEMORY` | 表示服务器的内存大小，单位是 GB。 | - | `DISK` | 表示服务器磁盘大小，单位是 GB。 | - - -- **服务信息**：显示 NebulaGraph 各个服务的类型、所在节点 IP、端口、HTTP 端口、运行状态。 - -- **Leader分布**：显示 Storage 服务中 Leader 分布情况。 - - | 参数 | 说明 | - | ---------------------------------- | ---- | - | `Storage Service` | 显示 Storage 服务的访问地址。 | - | `Number of Leaders` | 显示 Storage 服务中的 Leader 总数 。 | - | `Leader Distribution` | 显示 Storage 服务中不同图空间的 Leader 分布数。 | - -### 负载 - -![basic-info](https://docs-cdn.nebula-graph.com.cn/figures/load_2022-04-13_cn.png) - -显示集群所有服务器节点的负载信息，包括以下指标的平均值（AVG）、最大值（MAX）、最小值（MIN）： - -- **内存使用率**：显示节点内存使用率，单位是 %。 - -- **CPU使用率**：显示节点 CPU 使用率，单位是 %。 - -- **磁盘使用率**：显示节点磁盘的总使用率，及节点中各个磁盘的使用率，单位是 %。 - -### Network - -![basic-info](https://docs-cdn.nebula-graph.com.cn/figures/network_2022-04-13.png) - -显示集群所有服务器节点的网络流量信息，包括以下指标的平均值（AVG）、最大值（MAX）、最小值（MIN）： - -- **NetworkOut**：显示集群中各个服务器节点的网络流出速度的大小，及每个节点中各网卡的流出速度大小，单位是 Bytes/s。 - -- **NetworkIn**：显示集群中各个服务器节点的网络流入速度的大小，及每个节点中各网卡的流入速度大小，单位是 Bytes/s。 - -### Session - -![basic-info](https://docs-cdn.nebula-graph.com.cn/figures/session_2022-04-13.png) - -显示集群中所有 Graph 服务的 Session 相关信息。 - -| 参数 | 说明 | -| -------------------------------- | ---- | -| `num_opened_sessions` | 服务端建立过的会话数量。 | -| `num_auth_failed_sessions` | 登录验证失败的会话数量。 | -| `num_active_sessions` | 活跃的会话数的变化数。 | -| `num_reclaimed_expired_sessions` | 服务端主动回收的过期的会话数量。 | - -### 服务信息 - -显示集群各服务稳定性相关的指标： - -- **Graph**： - - ![basic-info](https://docs-cdn.nebula-graph.com.cn/figures/Service_Graph_2022-04-13_cn.png) - - | 参数 | 说明 | - | ------------- | ------------------------------------------------------------ | - | `METRIC_NAME` | `query`：查询次数。
`slow_queries`：慢查询次数。
`num_killed_queries`：被终止的查询数量。
`num_queries_hit_memory_watermark`：执行的 nGQL 语句中达到内存水位值的数量。
`num_rpc_sent_to_metad`：Graphd 服务发给 Metad 服务的 RPC 请求数量。 | - -- **Meta**： - - ![basic-info](https://docs-cdn.nebula-graph.com.cn/figures/Service_meta_2022-04-13_cn.png) - - | 参数 | 说明 | - | ------------- | ------------------------------------------------------------ | - | `METRIC_NAME` | `heartbeat`：心跳次数。 | - - -- **Storage**： - - ![basic-info](https://docs-cdn.nebula-graph.com.cn/figures/Service_Storage_2022-04-13_cn.png) - - | 参数 | 说明 | - | ------------- | ------------------------------------------------------------ | - | `METRIC_NAME` | `delete_vertices`：删除的点的数量。
`delete_edges`：删除的边的数量。
`delete_tags`：删除的 Tag 的数量。
`num_rpc_sent_to_metad`：Storaged 服务发给 Metad 服务的 RPC 请求数量。 | - -其他参数说明如下： - -| 参数 | 说明 | -| ------------- | ------------------------------------------------------------ | -| `TOTAL` | 该项监控执行的总次数。 | -| `ERROR` | 发生错误的个数。 | -| `P75` | P75 周期内响应耗时从小到大排列，顺序处于 75% 位置的分位数值。 | -| `P95` | P95 周期内响应耗时从小到大排列，顺序处于 95% 位置的分位数值。 | -| `P99` | P99 周期内响应耗时从小到大排列，顺序处于 99% 位置的分位数值。 | -| `P999` | P999 周期内响应耗时从小到大排列，顺序处于 99.9% 位置的分位数值。 | - -### 配置信息 - -列出当前集群中 Graph、Meta、Storage 服务的所有配置信息。 - -关于各个服务的配置信息的详情，参见[配置管理](../../../5.configurations-and-logs/1.configurations/1.configurations.md)。 +详情页面可以下载 HTML 或 PDF 格式的诊断报告。