-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
42 additions
and
40 deletions.
There are no files selected for viewing
82 changes: 42 additions & 40 deletions
82
docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,66 +1,68 @@ | ||
| # Cluster monitoring | ||
|
|
||
| This topic introduces node monitoring, service monitoring, graph space monitoring, and TV Dashboard. | ||
| This section introduces the monitoring function of the Dashboard, including default monitoring and custom monitoring. | ||
|
|
||
| At the top navigation bar of the Dashboard Enterprise Edition page, click **Cluster Management**, and click **Detail** at the right of the target cluster. **Monitoring** at the left navigation bar contains **Node**, **Service** and **TV Dashboard**. | ||
| At the top navigation bar of the Dashboard Enterprise Edition page, click **Cluster Management**, and click **Detail** at the right of the target cluster. **Monitoring** at the left navigation bar contains default monitoring and custom monitoring. | ||
|
|
||
| ## Node | ||
| ## Default monitoring | ||
|
|
||
| Click **Monitoring**->**Node**->**Overview** to enter the node monitoring overview page. | ||
| The default cluster monitoring page of Dashboard displays 8 monitoring metric panels, which cannot be modified or deleted. Users can add, modify, and delete monitoring metric panels in a new dashboard using the **Custom Monitoring** function described below. | ||
|
|
||
| On this page, you can view the variation of CPU, Memory, Load, Disk, and Network In/Out quickly. | ||
| The 8 default monitoring metrics displayed are: | ||
|
|
||
| - 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  button to update the page manually. | ||
| - To set a base line, click the  button. | ||
| - To view the detailed monitoring information, click the  button. In this example, select `Load` for details. The figure is as follows. | ||
|  | ||
| - CPU Utilization: Percentage of CPU usage. | ||
| - Memory Utilization: Percentage of memory usage. | ||
| - Disk Usage: Disk usage shows instances, disk name, mount point, and usage. | ||
| - Load 5: System average load over the last 5 minutes. | ||
| - QPS: Queries per second. | ||
| - Num Queries & Slow Queries: Number of queries and slow queries. | ||
| - Num Opened Sessions: Number of active sessions. | ||
| - Add Edge Latency & Add Vertex Latency: Delay time for adding edges and vertices. | ||
|
|
||
| - 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 [Monitor parameter](../7.monitor-parameter.md). | ||
| - You can temporarily hide nodes that you do not need to view. | ||
| - You can click the  button to view the detailed monitoring information. | ||
| Clicking the  button on the upper right corner of each panel can filter the time and view each monitoring metric on a separate subpage. | ||
|
|
||
| ## Service | ||
| ## Custom Monitoring | ||
|
|
||
| Click **Monitoring**->**Service**->**Overview** to enter the service monitoring overview page. | ||
| ### Creating Monitoring | ||
|
|
||
| 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. | ||
| 1. Click on **New Dashboard** and enter a custom Dashboard name in the pop-up dialog box. Click **OK** to create a new cluster monitoring. | ||
|
|
||
| !!! note | ||
| 2. Click on **Add Panel** in the upper right corner or **Create Panel** in the middle of the page to add a monitoring panel. Set the parameters and click **Confirm**. The parameter descriptions are as follows: | ||
|
|
||
|  | ||
|
|
||
| In the current **Service** page of the Enterprise Edition, only two monitoring metrics can be set for each service, which can be adjusted by clicking the **Set up** button. | ||
| - **Panel Name**: Custom panel name. | ||
|
|
||
| - 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  button to update the page manually. | ||
| - You can view the status of all the services in cluster. | ||
| - To view the detailed monitoring information, click the  button. In this example, select `Graph` for details. The figure is as follows. | ||
|  | ||
| - **Panel Type**: Includes **Node Linear Panel**, **Service Linear Panel**, and **Disk Usage Bar Panel**. Different panel types determine the available metrics for selection. | ||
|
|
||
| - 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  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**. | ||
| - **Metric**: Select different metrics based on the panel type. For example, for **Node Linear Panel**, you can select CPU, Memory, Load, Disk, Network In/Out, etc. Multiple metrics can be selected. Please refer to the [Metrics](../7.monitor-parameter.md) for more details. | ||
|
|
||
| ### Graph space | ||
| - **Metric Type**: Choose from percentage, byte, byte/s, io/s, number, etc. | ||
|
|
||
| - **Show Index**: Panel display order, with numbers ranging from 1 to infinity, with smaller numbers being displayed first. The panels are sorted by the creation time by default. | ||
|
|
||
| !!! note | ||
|
|
||
| Before using graph space metrics, you need to set `enable_space_level_metrics` to `true` in the Graph service. For details, see [Update config](operator/update-config.md). | ||
| The Graph service supports a set of graph space-based monitoring metrics. When selecting Graph service-related metrics, you can select the corresponding graph space in the added **spaces** dropdown list. | ||
|
|
||
| !!! Caution | ||
|
|
||
| Before using Graph Space Metrics, users need to set `enable_space_level_metrics` to `true` in the Graph service. For specific operations, please refer to [Update config](./operator/update-config.md). | ||
|
|
||
| ### Managing Monitoring | ||
|
|
||
| To manage monitoring metric panels, click the  button in the upper right corner of each panel to modify or delete the panel. | ||
|
|
||
| !!! compatibility "Space-level metric incompatibility" | ||
| You can also click the  button in the upper right corner of the panel to enter the subpage of the monitoring metrics panel and view the monitoring metrics. | ||
|
|
||
| If a graph space name contains special characters, the corresponding metric data of that graph space may not be displayed. | ||
|
|
||
| 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**. | ||
| ## More operations | ||
|
|
||
| Space graph metrics record the information of different graph spaces separately. Currently, only the Graph service supports a set of space-level metrics. | ||
| The section above the page is used for monitoring filtering, with the following features: | ||
|
|
||
| For information about the space graph metrics, see [Space graph](../7.monitor-parameter.md). | ||
| - Time selection: By default, 6 hours of monitoring data is selected for viewing. You can select a time based on a specific date, or choose a recent period, such as the past 5 minutes, 1 hour, 6 hours, 12 hours, 1 day, or 3 days. | ||
|
|
||
|  | ||
| - Instance selection: Monitoring data for all nodes is displayed by default, and you can adjust the selections within the **Instance** box. | ||
|
|
||
| - Service selection: Monitoring data for all services is displayed by default, and you can adjust the selections within the **Service** box. | ||
|
|
||
| - Data update: The monitoring data on the page is not automatically updated by default (i.e., it is turned `Off`). You can set the page update frequency in the drop-down box, such as every 5 seconds, 30 seconds, or 5 minutes. Click the  button to manually update the data. |