What is NebulaGraph Dashboard Community Edition¶
NebulaGraph Dashboard Community Edition (Dashboard for short) is a visualization tool that monitors the status of machines and services in NebulaGraph clusters. This topic introduces Dashboard Community Edition. For details of Dashboard Enterprise Edition, refer to What is NebulaGraph Dashboard Enterprise Edition.
Enterpriseonly
Dashboard Enterprise Edition adds features such as visual cluster creation, batch import of clusters, fast scaling, etc. For more information, see Pricing.
Features¶
Dashboard monitors:
- The status of all the machines in clusters, including CPU, memory, load, disk, and network.
- The information of all the services in clusters, including the IP addresses, versions, and monitoring metrics (such as the number of queries, the latency of queries, the latency of heartbeats, and so on).
- The information of clusters, including the information of services, partitions, configurations, and long-term tasks.
- Set how often the metrics page refreshes.
Scenarios¶
You can use Dashboard in one of the following scenarios:
- You want to monitor key metrics conveniently and quickly, and present multiple key information of the business to ensure the business operates normally.
- You want to monitor clusters from multiple dimensions (such as the time, aggregate rules, and metrics).
- After a failure occurs, you need to review it and confirm its occurrence time and unexpected phenomena.
Precautions¶
The monitoring data will be retained for 14 days by default, that is, only the monitoring data within the last 14 days can be queried.
Note
The monitoring service is supported by Prometheus. The update frequency and retention intervals can be modified. For details, see Prometheus.
Version compatibility¶
The version correspondence between NebulaGraph and Dashboard Community Edition is as follows.
| NebulaGraph version | Dashboard version |
|---|---|
| 2.5.0 ~ 3.2.0 | 3.1.0 |
| 2.5.x ~ 3.1.0 | 1.1.1 |
| 2.0.1~2.5.1 | 1.0.2 |
| 2.0.1~2.5.1 | 1.0.1 |