From 22ab2247cc25378384aaaaf07abf189b6e0a8aba Mon Sep 17 00:00:00 2001 From: Abby <78209557+abby-cyber@users.noreply.github.com> Date: Mon, 20 Dec 2021 14:41:26 +0800 Subject: [PATCH 01/10] add utilization note --- docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md | 9 +++++---- docs-2.0/nebula-dashboard/6.monitor-parameter.md | 9 ++++++--- 2 files changed, 11 insertions(+), 7 deletions(-) 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 937122969b7..7466a04bcce 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/6.monitor-parameter.md b/docs-2.0/nebula-dashboard/6.monitor-parameter.md index 34854bba09e..cfdfe98acf2 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`| 空闲内存| + ### 负载 |参数|说明| From 4c6270a3952f61d3139bb6cdb943496725961d69 Mon Sep 17 00:00:00 2001 From: Abby <78209557+abby-cyber@users.noreply.github.com> Date: Mon, 20 Dec 2021 15:56:41 +0800 Subject: [PATCH 02/10] update --- .../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 | 2 +- docs-2.0/nebula-dashboard/1.what-is-dashboard.md | 9 +++++++++ docs-2.0/nebula-dashboard/2.deploy-dashboard.md | 8 -------- docs-2.0/nebula-dashboard/6.monitor-parameter.md | 2 +- 6 files changed, 22 insertions(+), 15 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 53b8adef087..b47db1947ca 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 673e02a7eac..9b3eef9ef96 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 7466a04bcce..54a9b483e8a 100644 --- a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md @@ -8,7 +8,7 @@ - 默认监控的机器的操作系统为 Linux。 - 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于 1 KB/s 时单位为 Bytes/s。 - - 对于所有版本的企业版 Dashboard，机器的 Buff 和 Cache 所占的内存不会被计算在内存使用率中。 + - 对于所有版本的企业版 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 0fefb5630bf..1f4c64be9eb 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,15 @@ Nebula Dashboard（简称 Dashboard）是一款用于监控 Nebula Graph 集群 监控服务由 prometheus 提供，更新频率和保留时间等都可以自行修改。详情请参见 [prometheus 官方文档](https://prometheus.io/docs/prometheus/latest/configuration/configuration/)。 +## 版本兼容性 + +Nebula Graph 的版本和 Dashboard 社区版的版本对应关系如下。 + +|Nebula Graph 版本|Dashboard 版本| +|:---|:---| +|2.x|1.1.0| +|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 c80a7124197..47f940a3966 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 cfdfe98acf2..70c331aa872 100644 --- a/docs-2.0/nebula-dashboard/6.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard/6.monitor-parameter.md @@ -8,7 +8,7 @@ - 默认监控的机器的操作系统为 Linux。 - 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于 1 KB/s 时单位为 Bytes/s。 - - 对于等于和高于 v1.0.2 版本的社区版 Dashboard，机器的 Buff 和 Cache 所占的内存不会被计算在内存使用率中。 + - 对于等于和高于 v1.1.0 版本的社区版 Dashboard，机器的 Buff 和 Cache 所占的内存没有被计算在内存使用率中。 ### CPU From 3f1b7c792970a38ad996bb02c78dba7ef63d0a3a Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 11:56:06 +0800 Subject: [PATCH 03/10] Update docs-2.0/nebula-dashboard/6.monitor-parameter.md --- docs-2.0/nebula-dashboard/6.monitor-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-dashboard/6.monitor-parameter.md b/docs-2.0/nebula-dashboard/6.monitor-parameter.md index 70c331aa872..319f5c4b00b 100644 --- a/docs-2.0/nebula-dashboard/6.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard/6.monitor-parameter.md @@ -8,7 +8,7 @@ - 默认监控的机器的操作系统为 Linux。 - 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于 1 KB/s 时单位为 Bytes/s。 - - 对于等于和高于 v1.1.0 版本的社区版 Dashboard，机器的 Buff 和 Cache 所占的内存没有被计算在内存使用率中。 + - 对于高于 v1.0.2 版本的社区版 Dashboard，机器的 Buff 和 Cache 所占的内存没有被计算在内存使用率中。 ### CPU From 78ab418662796f7ec34a2d595c23c72121c6aa10 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 11:56:16 +0800 Subject: [PATCH 04/10] Update docs-2.0/nebula-dashboard/1.what-is-dashboard.md --- docs-2.0/nebula-dashboard/1.what-is-dashboard.md | 1 - 1 file changed, 1 deletion(-) 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 1f4c64be9eb..cf78d052d43 100644 --- a/docs-2.0/nebula-dashboard/1.what-is-dashboard.md +++ b/docs-2.0/nebula-dashboard/1.what-is-dashboard.md @@ -40,7 +40,6 @@ Nebula Graph 的版本和 Dashboard 社区版的版本对应关系如下。 |Nebula Graph 版本|Dashboard 版本| |:---|:---| -|2.x|1.1.0| |2.0.1~2.5.1|1.0.2| |2.0.1~2.5.1|1.0.1| ## 更新说明 From 561c9c475ffd719e601c3bfbf0c1fc415edab803 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 13:01:13 +0800 Subject: [PATCH 05/10] Update docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md --- docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 54a9b483e8a..63055b90478 100644 --- a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md @@ -6,7 +6,7 @@ !!! note - - 默认监控的机器的操作系统为 Linux。 + - 以下所列的机器相关的指标针对Linux操作系统。 - 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于 1 KB/s 时单位为 Bytes/s。 - 对于所有版本的企业版 Dashboard，机器的 Buff 和 Cache 所占的内存没有被计算在内存使用率中。 ### CPU From 2b009238118b37aff17163f65bd807154d8b91a0 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 13:02:32 +0800 Subject: [PATCH 06/10] Update docs-2.0/nebula-dashboard/6.monitor-parameter.md --- docs-2.0/nebula-dashboard/6.monitor-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-dashboard/6.monitor-parameter.md b/docs-2.0/nebula-dashboard/6.monitor-parameter.md index 319f5c4b00b..ce33ee7fcf7 100644 --- a/docs-2.0/nebula-dashboard/6.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard/6.monitor-parameter.md @@ -6,7 +6,7 @@ !!! note - - 默认监控的机器的操作系统为 Linux。 + - 以下所列的机器相关的指标针对Linux操作系统。 - 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于 1 KB/s 时单位为 Bytes/s。 - 对于高于 v1.0.2 版本的社区版 Dashboard，机器的 Buff 和 Cache 所占的内存没有被计算在内存使用率中。 From 93384d741948e07b307062928360f3dab6dde0ef Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 13:03:26 +0800 Subject: [PATCH 07/10] Update 6.monitor-parameter.md --- docs-2.0/nebula-dashboard/6.monitor-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-dashboard/6.monitor-parameter.md b/docs-2.0/nebula-dashboard/6.monitor-parameter.md index ce33ee7fcf7..62c93104bd7 100644 --- a/docs-2.0/nebula-dashboard/6.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard/6.monitor-parameter.md @@ -6,7 +6,7 @@ !!! note - - 以下所列的机器相关的指标针对Linux操作系统。 + - 以下所列的机器相关的指标针对 Linux 操作系统。 - 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于 1 KB/s 时单位为 Bytes/s。 - 对于高于 v1.0.2 版本的社区版 Dashboard，机器的 Buff 和 Cache 所占的内存没有被计算在内存使用率中。 From 19c9c1c58acfce7ab7049b9affe4e1c79460fa06 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 13:03:42 +0800 Subject: [PATCH 08/10] Update 7.monitor-parameter.md --- docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 63055b90478..4ea37d80f64 100644 --- a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md @@ -6,7 +6,7 @@ !!! note - - 以下所列的机器相关的指标针对Linux操作系统。 + - 以下所列的机器相关的指标针对 Linux 操作系统。 - 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于 1 KB/s 时单位为 Bytes/s。 - 对于所有版本的企业版 Dashboard，机器的 Buff 和 Cache 所占的内存没有被计算在内存使用率中。 ### CPU From 5c660a10c8ec2aa70323b1deb2af0dfe45be0d64 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 15:09:56 +0800 Subject: [PATCH 09/10] Update 7.monitor-parameter.md --- docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 4ea37d80f64..89ba9accc39 100644 --- a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md @@ -6,7 +6,7 @@ !!! note - - 以下所列的机器相关的指标针对 Linux 操作系统。 + - 以下机器指标适用于 Linux 操作系统。 - 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于 1 KB/s 时单位为 Bytes/s。 - 对于所有版本的企业版 Dashboard，机器的 Buff 和 Cache 所占的内存没有被计算在内存使用率中。 ### CPU From d6406aecccad45319f2322da06e2b371f7f827de Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 15:10:12 +0800 Subject: [PATCH 10/10] Update 6.monitor-parameter.md --- docs-2.0/nebula-dashboard/6.monitor-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-dashboard/6.monitor-parameter.md b/docs-2.0/nebula-dashboard/6.monitor-parameter.md index 62c93104bd7..7f2e38c4ff4 100644 --- a/docs-2.0/nebula-dashboard/6.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard/6.monitor-parameter.md @@ -6,7 +6,7 @@ !!! note - - 以下所列的机器相关的指标针对 Linux 操作系统。 + - 以下机器指标适用于 Linux 操作系统。 - 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于 1 KB/s 时单位为 Bytes/s。 - 对于高于 v1.0.2 版本的社区版 Dashboard，机器的 Buff 和 Cache 所占的内存没有被计算在内存使用率中。