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.

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

Update 3.cluster-information.md #1246

Merged
merged 4 commits into from
Apr 22, 2022
Merged
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,41 +1,51 @@
# Cluster information

This topic introduces the cluster information of Dashboard.
This topic introduces the cluster information of Dashboard from two parts **Overview Info** and **Cluster Diagnostics**. The **Overview Info** section displays the overview information of the Nebula Graph cluster. The **Cluster Diagnostics** section displays the cluster Diagnostics information of the Nebula Graph cluster.

At the top navigation bar of the Dashboard Enterprise Edition page, click **Cluster Management**. At the right side of the target cluster, click **Details**, and on the left-side navigation bar of the page, click **Information**, you will see the following six parts:
## Entry

- Version
- Leader
- Partition
- Service information
- Partition information
- Long-term task
1. At the top navigation bar of the Dashboard Enterprise Edition page, click **Cluster Management**.
2. On the right side of the target cluster, click **Details**.
3. On the left-side navigation bar of the page, click **Information**.
4. You will see the following parts.

Before viewing the cluster information, you need to select any online Graph service address, enter the account to log in to Nebula Graph (not the Dashboard login account), and the corresponding password.
- Overview Info
- Cluster Diagnostics


## Overview Info

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

!!! note

Before viewing the cluster information, you need to select any online Graph service address, enter the account to log in to Nebula Graph (not the Dashboard login account), and the corresponding password.

For multi-machine deployment, you can choose any online Graph service address.

!!! caution

You need to ensure that Nebula Graph services have been deployed and started. For more information, see [Nebula Graph installation and deployment](../../4.deployment-and-installation/1.resource-preparations.md "Click to go to Nebula Graph installation and deployment").

On the **Overview Info** page, you can see the information of the Nebula Graph cluster, including Storage leader distribution, Storage service details, versions and hosts information of each Nebula Graph service, and
partition distribution and details.
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

## Storage Leader Distribution

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

On this page, all services and corresponding Nebula versions will be shown.
- Click the **Balance Leader** button in the upper right corner to distribute Leaders evenly and quickly in the Nebula Graph cluster. For details about the Leader, see [Storage Service](../../1.introduction/3.nebula-graph-architecture/4.storage-service.md).

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

On this page, the number of Leaders and the Leader distribution will be shown. You can click the **Balance Leader** button in the upper right corner to distribute Leaders evenly and quickly in the Nebula Graph cluster.

## Partition
### Version

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

On this page, you can select the specified graph space and view its distribution of Partitions.

## Service information

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

<!-- balance-3.1
You can click the **Balance Date** button in the upper right corner to start the task to distribute all partitions in the cluster evenly.
Expand All @@ -51,19 +61,34 @@ You can click the **Balance Date** button in the upper right corner to start the
| `Partition Distribution` | The distribution of partitions. |
| `Leader Distribution` | The distribution of Leaders. |

Click **Detail** in the upper right corner to view the details of the Storage service information.

## Partition Distribution

Select the specified graph space in the upper left corner, and then you can perform the following operations:

- View the distribution of partitions in the specified graph space, displaying the IP addresses and ports of all Storage services in the cluster, and the number of partitions in each Storage service.
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved
- Click **Balance Data** to evenly distribute the partitions in the specified graph space.
- Click **Balance Data Remove** to migrate the partitions in the specified Storage service and distribute them evenly to the other Storage services in the cluster. The system will guide you to select the host IP where the specified Storage service is located.

Click **Detail** in the upper right corner to view more details.


## Partition information


On this page, the information of partitions will be shown. Before viewing the partition information, you need to select a graph space in the upper left corner. You can also enter the partition ID into the input box in the upper right corner to filter the shown data. The parameter description is 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 port of the leader.|
|`Peers`|The IP addresses and ports of all the replicas.|
|`Losts`|The IP addresses and ports of replicas at fault.|
|`Losts`|The IP addresses and ports of faulty replicas.|

## Long-term task
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


On this page, the information of all jobs will be shown. Before viewing the job information, you need to select a graph space in the upper left corner. Online managing jobs is not supported. For more information, see [Job statements](../../3.ngql-guide/4.job-statements.md). The parameter description is as follows:
Expand All @@ -74,4 +99,8 @@ On this page, the information of all jobs will be shown. Before viewing the job
| `Command` | Shows the command type. |
| `Status` | Shows the status of the job or task. For more information, see [Job statements](../../3.ngql-guide/4.job-statements.md#_2). |
|`Start Time`| Shows a timestamp indicating the time when the job or task starts RUNNING.|
| `Stop Time` | Shows a timestamp indicating the time when the job or task gets `FINISHED`, `FAILED`, or`STOPPED`. |
| `Stop Time` | Shows a timestamp indicating the time when the job or task gets `FINISHED`, `FAILED`, or`STOPPED`. | -->

## Cluster Diagnostics

You can click **Cluster Diagnostics** under the **Cluster Information** menu bar to locate and analyze the problem that occurs in the cluster. For details, see [Cluster Diagnostics](7.cluster-Diagnostics.md).