Skip to content

Commit

Permalink
add utilization rate note & version compatibility (#1333)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
abby-cyber authored Dec 31, 2021
1 parent f9e515e commit 8361024
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 20 deletions.
10 changes: 10 additions & 0 deletions docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md
Original file line number Diff line number Diff line change
Expand Up @@ -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|
Original file line number Diff line number Diff line change
Expand Up @@ -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`的数据库。
- 确保在安装开始前,以下端口处于未被使用状态。
Expand Down
9 changes: 5 additions & 4 deletions docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

|参数|说明|
Expand Down
8 changes: 8 additions & 0 deletions docs-2.0/nebula-dashboard/1.what-is-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}})
8 changes: 0 additions & 8 deletions docs-2.0/nebula-dashboard/2.deploy-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 之前,用户需要确认以下信息:
Expand Down
9 changes: 6 additions & 3 deletions docs-2.0/nebula-dashboard/6.monitor-parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -27,6 +29,7 @@
|`memory_actual_used`| 实际使用内存(不包括缓存)|
|`memory_free`| 空闲内存|


### 负载

|参数|说明|
Expand Down

0 comments on commit 8361024

Please sign in to comment.