From 8361024852c3f2a67c468e964aac3826166ca553 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 15:15:47 +0800 Subject: [PATCH] add utilization rate note & version compatibility (#1333) * add utilization note * update * Update docs-2.0/nebula-dashboard/6.monitor-parameter.md * Update docs-2.0/nebula-dashboard/1.what-is-dashboard.md * Update docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md * Update docs-2.0/nebula-dashboard/6.monitor-parameter.md * Update 6.monitor-parameter.md * Update 7.monitor-parameter.md * Update 7.monitor-parameter.md * Update 6.monitor-parameter.md --- .../nebula-dashboard-ent/1.what-is-dashboard-ent.md | 10 ++++++++++ .../2.deploy-connect-dashboard-ent.md | 6 +----- docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md | 9 +++++---- docs-2.0/nebula-dashboard/1.what-is-dashboard.md | 8 ++++++++ docs-2.0/nebula-dashboard/2.deploy-dashboard.md | 8 -------- docs-2.0/nebula-dashboard/6.monitor-parameter.md | 9 ++++++--- 6 files changed, 30 insertions(+), 20 deletions(-) diff --git a/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md b/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md index 53b8adef08..b47db1947c 100644 --- a/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md +++ b/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md @@ -31,3 +31,13 @@ Nebula Dashboard（简称 Dashboard）是一款用于监控和管理 Nebula Grap !!! note 监控服务由 prometheus 提供，更新频率和保留时间等都可以自行修改。详情请参见 [prometheus 官方文档](https://prometheus.io/docs/prometheus/latest/configuration/configuration/)。 + +## 版本兼容性 + +Nebula Graph 的版本和 Dashboard 企业版的版本对应关系如下。 + +|Nebula Graph 版本|Dashboard 版本| +|:---|:---| +|2.0.1~2.6.1|1.0.2| +|2.0.1~2.6.1|1.0.1| +|2.0.1~2.6.1|1.0.0| diff --git a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md index 9b9a602563..004b2f1459 100644 --- a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md +++ b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md @@ -6,11 +6,7 @@ 在部署 Dashboard 之前，用户需要确认以下信息： -- 选择并下载符合版本的 Dashboard，Dashboard 版本和 Nebula Graph 的版本对应关系如下。 - - | Dashboard 版本 | Nebula Graph 版本 | - | :-------------------------- | :--------------- | - | {{ dashboard_ent.release }} | 2.x | +- 选择并下载符合版本的 Dashboard。关于 Dashboard 版本和 Nebula Graph 的版本对应关系，参见[版本兼容性](1.what-is-dashboard-ent.md)。 - 准备版本为 5.7 以上的 [MySQL](https://www.mysql.com/cn/) 环境，创建名称为`dashboard`的数据库。 - 确保在安装开始前，以下端口处于未被使用状态。 diff --git a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md index 937122969b..89ba9accc3 100644 --- a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md @@ -2,12 +2,13 @@ 本文介绍 Dashboard 中展示的 Nebula Graph 监控指标。 -!!! note - - 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于 1 KB/s 时单位为 Bytes/s。 - ## 机器 +!!! note + + - 以下机器指标适用于 Linux 操作系统。 + - 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于 1 KB/s 时单位为 Bytes/s。 + - 对于所有版本的企业版 Dashboard，机器的 Buff 和 Cache 所占的内存没有被计算在内存使用率中。 ### CPU |参数|说明| diff --git a/docs-2.0/nebula-dashboard/1.what-is-dashboard.md b/docs-2.0/nebula-dashboard/1.what-is-dashboard.md index 0fefb5630b..cf78d052d4 100644 --- a/docs-2.0/nebula-dashboard/1.what-is-dashboard.md +++ b/docs-2.0/nebula-dashboard/1.what-is-dashboard.md @@ -34,6 +34,14 @@ Nebula Dashboard（简称 Dashboard）是一款用于监控 Nebula Graph 集群 监控服务由 prometheus 提供，更新频率和保留时间等都可以自行修改。详情请参见 [prometheus 官方文档](https://prometheus.io/docs/prometheus/latest/configuration/configuration/)。 +## 版本兼容性 + +Nebula Graph 的版本和 Dashboard 社区版的版本对应关系如下。 + +|Nebula Graph 版本|Dashboard 版本| +|:---|:---| +|2.0.1~2.5.1|1.0.2| +|2.0.1~2.5.1|1.0.1| ## 更新说明 [Release](https://github.com/vesoft-inc/nebula-dashboard/releases/tag/{{dashboard.branch}}) diff --git a/docs-2.0/nebula-dashboard/2.deploy-dashboard.md b/docs-2.0/nebula-dashboard/2.deploy-dashboard.md index c80a712419..47f940a396 100644 --- a/docs-2.0/nebula-dashboard/2.deploy-dashboard.md +++ b/docs-2.0/nebula-dashboard/2.deploy-dashboard.md @@ -2,14 +2,6 @@ 安装部署 Dashboard 涉及 5 种服务，本文将详细介绍如何通过 tar 包安装部署。下载和编译 Nebula Dashboard 的最新源码，请参见 [GitHub nebula dashboard](https://github.com/vesoft-inc/nebula-dashboard#readme) 页面的说明。 -## Nebula Graph 版本 - -Dashboard 版本和 Nebula Graph 的版本对应关系如下。 - -|Dashboard 版本|Nebula Graph 版本| -|:---|:---| -|{{ dashboard.release }}|2.x| - ## 前提条件 在部署 Dashboard 之前，用户需要确认以下信息： diff --git a/docs-2.0/nebula-dashboard/6.monitor-parameter.md b/docs-2.0/nebula-dashboard/6.monitor-parameter.md index 34854bba09..7f2e38c4ff 100644 --- a/docs-2.0/nebula-dashboard/6.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard/6.monitor-parameter.md @@ -2,11 +2,13 @@ 本文介绍 Dashboard 中展示的 Nebula Graph 监控指标。 -!!! note +## 机器 - 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于 1 KB/s 时单位为 Bytes/s。 +!!! note -## 机器 + - 以下机器指标适用于 Linux 操作系统。 + - 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于 1 KB/s 时单位为 Bytes/s。 + - 对于高于 v1.0.2 版本的社区版 Dashboard，机器的 Buff 和 Cache 所占的内存没有被计算在内存使用率中。 ### CPU @@ -27,6 +29,7 @@ |`memory_actual_used`| 实际使用内存（不包括缓存）| |`memory_free`| 空闲内存| + ### 负载 |参数|说明|