what is dashboard

docs-2.0/nebula-dashboard/1.what-is-dashboard.md

@@ -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/).

mkdocs.yml

@@ -244,38 +244,45 @@ nav:
     - Compaction: 8.service-tuning/compaction.md
     - Storage load balance: 8.service-tuning/load-balance.md
 
-  - Nebula Graph Studio:
-      - Release Note: nebula-studio/about-studio/st-ug-release-note.md
-      - About Nebula Graph Studio:
-        - What is Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md
-#        - Usage restriction:
-        - Limitation: nebula-studio/about-studio/st-ug-limitations.md
-        - Check updates: nebula-studio/about-studio/st-ug-check-updates.md
-        - Shortcuts: nebula-studio/about-studio/st-ug-shortcuts.md
-      - Deploy and connect:
-        - Deploy Studio: nebula-studio/install-configure/st-ug-deploy.md
-        - Connect to Studio: nebula-studio/install-configure/st-ug-connect.md
-        - Reset connection: nebula-studio/install-configure/st-ug-reset-connection.md
-      - Quick start: 
-        - Design a schema: nebula-studio/quick-start/st-ug-plan-schema.md
-        - Create a schema: nebula-studio/quick-start/st-ug-create-schema.md
-        - Import data: nebula-studio/quick-start/st-ug-import-data.md
-        - Query graph data: nebula-studio/quick-start/st-ug-explore.md
-      - Operation guide: 
-        - Use Schema:
-          - Operate graph spaces: nebula-studio/manage-schema/st-ug-crud-space.md
+#  - Nebula Graph Studio:
+#    - Release Note: nebula-studio/about-studio/st-ug-release-note.md
+#    - About Nebula Graph Studio:
+#      - What is Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md
+#      - Usage restriction:
+#      - Limitation: nebula-studio/about-studio/st-ug-limitations.md
+#      - Check updates: nebula-studio/about-studio/st-ug-check-updates.md
+#      - Shortcuts: nebula-studio/about-studio/st-ug-shortcuts.md
+#    - Deploy and connect:
+#      - Deploy Studio: nebula-studio/install-configure/st-ug-deploy.md
+#      - Connect to Studio: nebula-studio/install-configure/st-ug-connect.md
+#      - Reset connection: nebula-studio/install-configure/st-ug-reset-connection.md
+#    - Quick start: 
+#      - Design a schema: nebula-studio/quick-start/st-ug-plan-schema.md
+#      - Create a schema: nebula-studio/quick-start/st-ug-create-schema.md
+#      - Import data: nebula-studio/quick-start/st-ug-import-data.md
+#      - Query graph data: nebula-studio/quick-start/st-ug-explore.md
+#    - Operation guide: 
+#      - Use Schema:
+#          - Operate graph spaces: nebula-studio/manage-schema/st-ug-crud-space.md
 #          - Operate tags: nebula-studio/manage-schema/st-ug-crud-tag.md
 #          - Operate edge types: nebula-studio/manage-schema/st-ug-crud-edge-type.md
 #          - Operate indexes: nebula-studio/manage-schema/st-ug-crud-index.md
-#        - Use Console:
+#      - Use Console:
 #          - Console: 
 #          - Open in Explore: nebula-studio/use-console/st-ug-open-in-explore.md
 #          - View subgraph: nebula-studio/use-console/st-ug-visualize-subgraph.md
-#      - Troubleshooting:
+#    - Troubleshooting:
 #        - Config server errors:
 #        - Connection errors:
 #        - FAQ:
 
+  - Nebula Graph Dashboard: 
+      - What is Nebula Graph Dashboard: nebula-dashboard/1.what-is-dashboard.md
+      - Deploy Dashboard: nebula-dashboard/2.deploy-dashboard.md
+      - Connect Dashboard: nebula-dashboard/3.connect-dashboard.md
+      - Use Dashboard: nebula-dashboard/4.use-dashboard.md
+      - Monitor Parameter: nebula-dashboard/6.monitor-parameter.md
+
   - Nebula Spark Connector: nebula-spark-connector.md
 
   - Nebula Flink Connector: nebula-flink-connector.md