Skip to content

Commit

Permalink
add utilization rate note & version compatibility (#983)
Browse files Browse the repository at this point in the history
* [wip]add utilization rate note & version compatibility

* Update docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md

Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com>

* Update 7.monitor-parameter.md

* Create 7.monitor-parameter.md

* Update docs-2.0/nebula-dashboard/6.monitor-parameter.md

* Update 1.what-is-dashboard.md

* Update 6.monitor-parameter.md

* Create 6.monitor-parameter.md

Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com>
  • Loading branch information
abby-cyber and randomJoe211 authored Dec 31, 2021
1 parent 634fd21 commit 93ee46f
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 19 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 @@ -45,3 +45,13 @@ Nebula Dashboard Enterprise Edition (Dashboard for short) is a visualization too
!!! note

The monitoring feature is supported by Prometheus. The update frequency and retention intervals can be modified. For details, see [Prometheus](https://prometheus.io/docs/prometheus/latest/configuration/configuration/).

## Version compatibility

The version correspondence between Nebula Graph and Dashboard Enterprise Edition is as follows.

|Nebula Graph version|Dashboard version|
|:---|:---|
|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 @@ This topic will introduce how to install and deploy Dashboard in detail.

Before deploying Dashboard, you must do a check of these:

- Select and download Dashboard of the correct version. The version correspondence between Dashboard and Nebula Graph is as follows.

| Dashboard version | Nebula Graph version |
| :-------------------------- | :--------------- |
| {{ dashboard_ent.release }} | 2.x |
- Select and download Dashboard of the correct version. For information about the version correspondence between Dashboard and Nebula Graph, see [Version compatibility](1.what-is-dashboard-ent.md).

- The environment of [MySQL](https://www.mysql.com/) is ready and a database named as `dashboard` is created.
- Before the installation starts, the following ports are not occupied.
Expand Down
8 changes: 5 additions & 3 deletions docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@

This topic will describe the monitoring metrics in Nebula Dashboard.

!!! note
## Machine

The default unit in **Disk** and **Network** is byte. The unit will be changed with the data magnitude as the page displays. For example, when the flow is less than 1 KB/s, the unit will be Bytes/s.
!!! note

## Machine
- All the machine metrics listed below are for the Linux operating system.
- The default unit for **Disk** and **Network** is byte. The unit changes with the data magnitude as the page displays. For example, when the flow is less than 1 KB/s, the unit is Bytes/s.
- For all versions of Dashboard Enterprise Edition, the memory occupied by Buff and Cache will not be counted in the memory usage.

### CPU

Expand Down
9 changes: 9 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 @@ -38,6 +38,15 @@ You can use Dashboard in one of the following scenarios:

The monitoring service is supported by Prometheus. The update frequency and retention intervals can be modified. For details, see [Prometheus](https://prometheus.io/docs/prometheus/latest/configuration/configuration/).

## Version compatibility

The version correspondence between Nebula Graph and Dashboard Community Edition is as follows.

|Nebula Graph version|Dashboard version|
|:---|:---|
|2.0.1~2.5.1|1.0.2|
|2.0.1~2.5.1|1.0.1|

## Release note

[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 @@

The deployment of Dashboard involves five services. This topic will describe how to deploy Dashboard in detail. To download and compile the latest source code of Nebula Dashboard, follow the instructions on the [nebula dashboard GitHub page](https://github.com/vesoft-inc/nebula-dashboard).

## Nebula Graph releases

The correspondence between the Dashboard release and the Nebula Graph release is as follows.

|Dashboard|Nebula Graph|
|:---|:---|
|{{dashboard.release}}|2.x|

## Prerequisites

Before you deploy Dashboard, you must confirm that:
Expand Down
8 changes: 5 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 @@

This topic will describe the monitoring metrics in Nebula Dashboard.

!!! note
## Machine

The default unit in **Disk** and **Network** is byte. The unit will change with the data magnitude as the page displays. For example, when the flow is less than 1 KB/s, the unit will be Bytes/s.
!!! note

## Machine
- All the machine metrics listed below are for the Linux operating system.
- The default unit in **Disk** and **Network** is byte. The unit will change with the data magnitude as the page displays. For example, when the flow is less than 1 KB/s, the unit will be Bytes/s.
- For versions of Dashboard Community Edition greater than v1.0.2, the memory occupied by Buff and Cache will not be counted in the memory usage.

### CPU

Expand Down

0 comments on commit 93ee46f

Please sign in to comment.