From d29848ad4455c29d6ea2e9ef184a526a84eaa144 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 26 Apr 2023 09:45:48 +0800 Subject: [PATCH] optimize overview page (#2067) * optimize overview page * Update docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com> * Update docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com> --------- Co-authored-by: min.wu <50101159+whitewum@users.noreply.github.com> Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com> Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> --- .../4.cluster-operator/1.overview.md | 79 +++++++------------ 1 file changed, 29 insertions(+), 50 deletions(-) diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md index 4c7a733e7f5..9a587fbf1f4 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md @@ -1,71 +1,50 @@ # Cluster overview -This topic introduces the **Overview** page of Dashboard. +This topic introduces the **Overview** page of Dashboard. -At the top of the Dashboard page, click **Cluster Management**, and then click **Detail** on the right of the cluster management page to check the overview of a specified cluster. +## Entry + +1. At the top navigation bar of the Dashboard Enterprise Edition page, click **Cluster Management**. +2. Click **Detail** on the right of the cluster management page to check the overview of a specified cluster. ## Overview The **Overview** page has the following parts: -- Cluster survey -- Alert -- Information -- Node -- Status list -- Service - -### Cluster survey - -In this part, you can view the number of nodes as well as the number of running and abnormal services of Graphd, Storaged, and Metad. You can click the **View** button to quickly check the abnormal service and node. - -### Alert - -In the **Alert** section, the system displays the five most recently triggered alert messages according to their severity levels (`emergency`>`critical`>`warning`). - -In the right upper corner, click **Alert Messages** to view alert messages. For more information about alerts, see [Alerts](../4.cluster-operator/9.notification.md). - -### Information - -In this part, you can view the information of **Cluster Name**, **Creation Time**, **Expiration Time**, **Creator**, and **Version**. +- Cluster key information +- Cluster topology +- Node monitoring +- Service monitoring -- **Cluster Name**：The name of the cluster. -- **Creation Time**：The time when the cluster is created. -- **Expiration Time**：The time when the cluster license expires. +### Cluster key information - !!! enterpriseonly +In the cluster key information, the following information is displayed. - The parameter **Expiration Time** is displayed only if the created or imported cluster is an Enterprise Edition cluster. +- Cluster health score: Displays the health of the cluster on a percentage basis. It is refreshed every 5 minutes, or immediately if there is an emergency level alarm. The calculation formula can be configured in the **Cluster Diagnostics** page. +- Monitoring nodes: Shows the number of online nodes/total number of nodes. +- Monitoring services: Shows the number of online services/total number of services. Different types of services are displayed separately. +- Cluster information: Displays the cluster name, create time, creator, version, owner, and version upgrade portal. +- Creation time: The total running time of the cluster. +- Service online ratio: The ratio of the cluster is in an available state. The calculation formula can be configured in the **Cluster Diagnostics** page. +- Slow queries: The number of slow queries in the cluster. +- Max QPS: The maximum QPS in the cluster. +- Max query latency: The maximum query latency in the cluster. +- Opened sessions: The total number of sessions created in the cluster. +- QPS: The time-series diagram of the QPS. +- Query latency: The time-series diagram of the query latency. -- **Creator**：The Dashboard account that is used to create the cluster. -- **Version**：The version of NebulaGraph installed in the cluster. The **Version Upgrade** button is displayed on the right to go to the page of [version upgrade](operator/version-upgrade.md). +### Cluster topology -In the upper right of the **Information** section, click ![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch.png) to view the cluster details, including name, creation time, account name, version, and the role of the account name. +Shows the distribution and status of nodes and services in the cluster. -{{ ent.ent_begin }} -!!! enterpriseonly +### Node monitoring - For Enterprise Edition, there is a **License** section. - - - Displays the license details of the cluster, including the usage status, the organization, the creation time, the expiration time, the cluster versions supported by the license, and the license type. - - - Supports uploading new licenses. **When the license expires, you cannot perform operations on the current cluster.** Click **Upload License** to upload a new license. -{{ ent.ent_end }} - -### Node - -- You can view the information of node monitoring quickly and change the displayed information. By default, the CPU information will be shown. +- You can view the information of node monitoring quickly, and add or delete monitoring metrics. - You can click ![setup](https://docs-cdn.nebula-graph.com.cn/figures/Setup.png) on the page to insert a base line. - You can click ![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch.png) to jump to the detailed node monitoring page. -### Status list - -This part uses pie charts to visually display the running status of nodes. - -### Service - -- By default, the information of `query_latency_us` and `slow_query_latency_us` will be shown. +### Service monitoring +- You can view the information of service monitoring quickly, and add or delete monitoring metrics. - You can click ![setup](https://docs-cdn.nebula-graph.com.cn/figures/Setup.png) **Set up** to insert a base line. - - You can click ![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch.png) **View** to jump to the detailed service monitoring page.