Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add utilization rate note & version compatibility #983

Merged
merged 8 commits into from
Dec 31, 2021
Merged

add utilization rate note & version compatibility #983

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c9b5a07
[wip]add utilization rate note & version compatibility
abby-cyber Dec 21, 2021
640438d
Update docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md
abby-cyber Dec 31, 2021
7109262
Update 7.monitor-parameter.md
abby-cyber Dec 31, 2021
7775ed9
Create 7.monitor-parameter.md
abby-cyber Dec 31, 2021
2ab901c
Update docs-2.0/nebula-dashboard/6.monitor-parameter.md
abby-cyber Dec 31, 2021
1d366ff
Update 1.what-is-dashboard.md
abby-cyber Dec 31, 2021
7c1bd67
Update 6.monitor-parameter.md
abby-cyber Dec 31, 2021
7e5bf8e
Create 6.monitor-parameter.md
abby-cyber Dec 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md
View file
Open in desktop
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|
6 changes: 1 addition & 5 deletions docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
View file
Open in desktop
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).
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

- 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
View file
Open in desktop
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
10 changes: 10 additions & 0 deletions docs-2.0/nebula-dashboard/1.what-is-dashboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,16 @@ 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.x|1.1.0|
|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
View file
Open in desktop
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
View file
Open in desktop
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
- The operating system of the monitored machine is Linux by default.
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved
- 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 equal to and greater than v1.1.0, the memory occupied by Buff and Cache will not be counted in the memory usage.

### CPU

Expand Down