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

Jump to bottom

dashboard community add overview #1650

Merged
merged 4 commits into from
Oct 9, 2022
Merged

dashboard community add overview #1650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
88d79ce
dashboard community add overview
cooper-lzy Sep 22, 2022
01c9e9d
Update docs-2.0/nebula-dashboard/4.use-dashboard.md
cooper-lzy Sep 29, 2022
04ca62c
Update docs-2.0/nebula-dashboard/4.use-dashboard.md
cooper-lzy Sep 29, 2022
f1d92f9
Update docs-2.0/nebula-dashboard/4.use-dashboard.md
cooper-lzy Sep 29, 2022
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
4 changes: 2 additions & 2 deletions docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ At the top navigation bar of the Dashboard Enterprise Edition page, click **Clus

## Node

Click **Monitoring**->**Node** to enter the node monitoring page.
Click **Monitoring**->**Node**->**Overview** to enter the node monitoring overview page.

On this page, you can view the variation of CPU, Memory, Load, Disk, and Network In/Out quickly.

Expand All @@ -24,7 +24,7 @@ On this page, you can view the variation of CPU, Memory, Load, Disk, and Network

## Service

Click **Monitoring**->**Service** to enter the service monitoring page.
Click **Monitoring**->**Service**->**Overview** to enter the service monitoring overview page.

On this page, you can view the information of Graph, Meta, and Storage services quickly. In the upper right corner, the number of normal services and abnormal services will be displayed.

Expand Down
135 changes: 87 additions & 48 deletions docs-2.0/nebula-dashboard/4.use-dashboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,88 +4,127 @@ NebulaGraph Dashboard consists of three parts: Machine, Service, and Management.

## Overview

![Overview](https://docs-cdn.nebula-graph.com.cn/figures/overview1-220624-en.png)
![Overview](https://docs-cdn.nebula-graph.com.cn/figures/overview1-220922-en.png)

## Machine

Machine consists of the following parts:
Click **Machine**->**Overview** to enter the machine overview page.

- Overview

You can check the fluctuations of CPU, Memory, Load, Disk, Network In, and Network Out.
On this page, you can view the variation of CPU, Memory, Load, Disk, and Network In/Out quickly.

- By default, you can view the monitoring data of the maximum of 14 days. You can also select a time range or quickly select latest 1 hour, 6 hours, 12 hours, 1 day, 3 days, 7days, or 14 days.
- By default, you can view the monitoring data of all the instances in clusters. You can select the instances you want to view in the **instance** box.
- By default, the monitoring information page will not be updated automatically. You can set the update frequency of the monitoring information page globally or click the ![setup](https://docs-cdn.nebula-graph.com.cn/figures/refresh-220616.png) button to update the page manually.
- By default, you can view the monitoring data for a maximum of 14 days. You can also select a time range or quickly select the latest 1 hour, 6 hours, 12 hours, 1 day, 3 days, 7 days, or 14 days.
- By default, you can view the monitoring data of all the instances in clusters. You can select the instances you want to view in the **instance** box.
- By default, the monitoring information page will not be updated automatically. You can set the update frequency of the monitoring information page globally or click the ![setup](https://docs-cdn.nebula-graph.com.cn/figures/refresh-220616.png) button to update the page manually.
- To set a base line, click the ![setup](https://docs-cdn.nebula-graph.com.cn/figures/Setup.png) button.
- To view the detailed monitoring information, click the ![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch.png) button. In this example, select `Load` for details. The figure is as follows.
![load](https://docs-cdn.nebula-graph.com.cn/figures/ds-load-220913-en.png)

For details of certain monitoring metrics, you can click the ![overview](https://docs-cdn.nebula-graph.com.cn/figures/eye.png) symbol in the upper right corner, or click the monitoring metrics on the left.
- You can set the monitoring time range, instance, update frequency and base line.
- You can search for or select the target metric. For details about monitoring metrics, see [Metrics](6.monitor-parameter.md).
- You can temporarily hide nodes that you do not need to view.
- You can click the ![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch.png) button to view the detailed monitoring information.

- CPU, Memory, Load, Disk, Network

It shows the detailed monitoring data of the machine from the above dimensions. You can set the monitoring time range, instance, update frequency and base line. For details of monitoring metrics, see [Monitor parameter](../7.monitor-parameter.md).
## Service

![Machine](https://docs-cdn.nebula-graph.com.cn/figures/machine-220624-en.png)
Click **Service**->**Overview** to enter the service overview page.

## Service
On this page, you can view the information of Graph, Meta, and Storage services quickly. In the upper right corner, the number of normal services and abnormal services will be displayed.

Service consists of the following parts:
!!! note

- Overview
In the **Service** page, only two monitoring metrics can be set for each service, which can be adjusted by clicking the **Set up** button.

You can check the fluctuations of monitoring metrics of various services. You can also switch to the **Version** page to view the IP addresses and versions of all services.
- By default, you can view the monitoring data for a maximum of 14 days. You can also select a time range or quickly select the latest 1 hour, 6 hours, 12 hours, 1 day, 3 days, 7 days, or 14 days.
- By default, you can view the monitoring data of all the instances in clusters. You can select the instances you want to view in the **instance** box.
- By default, the monitoring information page will not be updated automatically. You can set the update frequency of the monitoring information page globally or click the ![setup](https://docs-cdn.nebula-graph.com.cn/figures/refresh-220616.png) button to update the page manually.
- You can view the status of all the services in a cluster.
- To view the detailed monitoring information, click the ![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch.png) button. In this example, select `Graph` for details. The figure is as follows.
![service](https://docs-cdn.nebula-graph.com.cn/figures/ds-graph-220913-en.png)

- By default, you can view the monitoring data of the maximum of 14 days. You can also select a time range or quickly select latest 1 hour, 6 hours, 12 hours, 1 day, 3 days, 7days, or 14 days.
- By default, you can view the monitoring data of all the instances in clusters. You can select the instances you want to view in the **instance** box.
- By default, the monitoring information page will not be updated automatically. You can set the update frequency of the monitoring information page globally or click the ![setup](https://docs-cdn.nebula-graph.com.cn/figures/refresh-220616.png) button to update the page manually.

For details of certain monitoring metrics, you can click the ![overview](https://docs-cdn.nebula-graph.com.cn/figures/eye.png) symbol in the upper right corner, or click the services on the left.
- You can set the monitoring time range, instance, update frequency, period, aggregation and base line.
- You can search for or select the target metric. For details of monitoring metrics, see [Monitor parameter](../7.monitor-parameter.md).
- You can temporarily hide nodes that you do not need to view.
- You can click the ![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch.png) button to view the detailed monitoring information.
- The Graph service supports a set of space-level metrics. For more information, see the following section **Graph space**.

!!! note
### Graph space

!!! note

The overview page of the current Community Edition only supports setting two monitoring metrics for each service. You can adjust it by clicking the **Set up** button.
Before using graph space metrics, you need to set `enable_space_level_metrics` to `true` in the Graph service. For details, see [Graph Service configuration](../5.configurations-and-logs/1.configurations/3.graph-config.md.

- Graph, Meta, Storage
!!! compatibility "Space-level metric incompatibility"

It shows the detailed monitoring data of the above services.
If a graph space name contains special characters, the corresponding metric data of that graph space may not be displayed.

- You can set the monitoring time range, instance, update frequency, period, aggregation and base line. For details of monitoring metrics, see [Monitor parameter](../7.monitor-parameter.md).
The service monitoring page can also monitor graph space level metrics. **Only when the behavior of a graph space metric is triggered, you can specify the graph space to view information about the corresponding graph space metric**.

- The Graph service supports a set of space-level metrics. For more information, see [Cluster monitoring](../nebula-dashboard-ent/4.cluster-operator/2.monitor.md).
Space graph metrics record the information of different graph spaces separately. Currently, only the Graph service supports a set of space-level metrics.

- You can check the status of the current service.
For information about the space graph metrics, see [Graph space](6.monitor-parameter.md).

![Service](https://docs-cdn.nebula-graph.com.cn/figures/service-220624-en.png)
![graph-metrics](https://docs-cdn.nebula-graph.com.cn/figures/space_level_metrics.png)

## Management

!!! note
### Overview info

On the **Overview Info** page, you can see the information of the NebulaGraph cluster, including Storage leader distribution, Storage service details, versions and hosts information of each NebulaGraph service, and partition distribution and details.

![coreinfo](https://docs-cdn.nebula-graph.com.cn/figures/clustercore-info_2022-04-11_en.png)

#### Storage Leader Distribution

In this section, the number of Leaders and the Leader distribution will be shown.

- Click the **Balance Leader** button in the upper right corner to distribute Leaders evenly and quickly in the NebulaGraph cluster. For details about the Leader, see [Storage Service](../../../1.introduction/3.nebula-graph-architecture/4.storage-service.md).

- Click **Detail** in the upper right corner to view the details of the Leader distribution.


#### Version

In this section, the version and host information of each NebulaGraph service will be shown. Click **Detail** in the upper right corner to view the details of the version and host information.


#### Service information

In this section, the information on Storage services will be shown. The parameter description is as follows:

| Parameter | Description |
| :--- | :--- |
| `Host` | The IP address of the host. |
| `Port` | The port of the host. |
| `Status` | The host status. |
| `Git Info Sha` | The commit ID of the current version. |
| `Leader Count` | The number of Leaders. |
| `Partition Distribution` | The distribution of partitions. |
| `Leader Distribution` | The distribution of Leaders. |

`Non-root` users can view the service information and the partition information with spatial permissions, but cannot view the configuration and long-term tasks.
Click **Detail** in the upper right corner to view the details of the Storage service information.

Management consists of the following parts:
#### Partition Distribution

- Service Info
Select the specified graph space in the upper left corner, you can view the distribution of partitions in the specified graph space. You can see the IP addresses and ports of all Storage services in the cluster, and the number of partitions in each Storage service.

It shows the basic information of the Storage Service, including the information of the host, the commit ID of versions, the number of leaders, the distribution of partitions, and the distribution of leaders.
Click **Detail** in the upper right corner to view more details.

- Partition Info
#### Partition information

You can check the information of partitions in different graph spaces. The descriptions are as follows.
In this section, the information on partitions will be shown. Before viewing the partition information, you need to select a graph space in the upper left corner. The parameter description is as follows:

|Parameter|Description|
|:---|:---|
|`Partition ID`|The ID of the partition.|
|`Leader`|The IP address and the port of the leader.|
|`Peers`|The IP addresses and the ports of all the replicas.|
|`Losts`|The IP addresses and the ports of replicas at fault.|
|Parameter|Description|
|:---|:---|
|`Partition ID`|The ID of the partition.|
|`Leader`|The IP address and port of the leader.|
|`Peers`|The IP addresses and ports of all the replicas.|
|`Losts`|The IP addresses and ports of faulty replicas.|

- Config

It shows the configuration of each service. Dashboard does not support online modification of configurations for now. For details, see [configurations](../5.configurations-and-logs/1.configurations/1.configurations.md).
Click **Detail** in the upper right corner to view details. You can also enter the partition ID into the input box in the upper right corner of the details page to filter the shown data.

- Long-term Task
### Config

It shows the information of all jobs. Dashboard does not support online management of jobs for now. For details, see [job statements](../3.ngql-guide/4.job-statements.md).
It shows the configuration of Graph and Storage service. NebulaGraph Dashboard Community Edition does not support online modification of configurations for now.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It shows the---->What does "It" here specify?


## Others

Expand Down