-
Notifications
You must be signed in to change notification settings - Fork 76
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* what is dashboard * Address Joe's comments
- Loading branch information
1 parent
42c3b73
commit b7a39a1
Showing
2 changed files
with
68 additions
and
22 deletions.
There are no files selected for viewing
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 |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # What is Nebula Graph Dashboard | ||
|
|
||
| Nebula Graph Dashboard (Dashboard for short) is a visualization tool that monitors the status of machines and services in Nebula Graph clusters. | ||
|
|
||
| ## 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. | ||
|
|
||
| Features of the enterprise package (TODO: planning) | ||
|
|
||
| !!! enterpriseonly | ||
|
|
||
| Dashboard has two editions. One is open source, the other is for enterprises. Most of the functions are available in both. The functions only supported by the enterprise package will be marked and explained. | ||
|
|
||
| ## 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 updated per 7 seconds by default. | ||
|
|
||
| - 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](https://prometheus.io/docs/prometheus/latest/configuration/configuration/). |
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