From f09d89de93fd716d8f02dec06fccf1b13662adcf Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:35:52 +0800 Subject: [PATCH 1/5] update --- .../dashboard-ent-release-note.md | 2 +- docs-2.0/nebula-dashboard-ent/10.tasks.md | 4 +- .../2.deploy-connect-dashboard-ent.md | 35 +++++++++++++--- .../4.cluster-operator/2.monitor.md | 2 +- .../4.cluster-operator/9.notification.md | 2 +- ...{config-management.md => update-config.md} | 10 ++--- docs-2.0/nebula-dashboard-ent/8.faq.md | 12 +++++- .../deploy-connect/ex-ug-deploy.md | 40 ++++++++++++++++++- docs-2.0/nebula-explorer/faq.md | 34 ++++++++++++++++ mkdocs.yml | 2 +- 10 files changed, 125 insertions(+), 18 deletions(-) rename docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/{config-management.md => update-config.md} (84%) diff --git a/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md b/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md index 1596bfd8ba9..0621cad9b9b 100644 --- a/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md +++ b/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md @@ -8,7 +8,7 @@ - [Back up and restore](../../nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md) support full backup to local. - Add [Slow query analyst](../../nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/slow-query-analyst.md) function. - The [Cluster diagnostics](../../nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/cluster-diagnosis.md) formula supports configuration. - - [Config Management](../../nebula-dashboard-ent/4.cluster-operator/operator/config-management.md) support **Add Config**, view the **Effective value** of the current configuration, and **View inconsistent configurations**. + - [Config Management](../../nebula-dashboard-ent/4.cluster-operator/operator/update-config.md) support **Add Config**, view the **Effective value** of the current configuration, and **View inconsistent configurations**. - In the [Notification endpoint](../../nebula-dashboard-ent/system-settings/notification-endpoint.md), the webhook supports configuring the **Webhook request body**. - Support [custom monitoring panel](../../nebula-dashboard-ent/4.cluster-operator/2.monitor.md). diff --git a/docs-2.0/nebula-dashboard-ent/10.tasks.md b/docs-2.0/nebula-dashboard-ent/10.tasks.md index 74d46ec2fcb..8c2f7538a80 100644 --- a/docs-2.0/nebula-dashboard-ent/10.tasks.md +++ b/docs-2.0/nebula-dashboard-ent/10.tasks.md @@ -26,7 +26,7 @@ At the top navigation bar of the Dashboard Enterprise Edition page, click Task C Click the tab **Running Task** to view the progress of the running tasks. -- Click a task name to view the ID, node name, type, create time, and operator of the running task. +- Click a task name to view the ID, node name, type, create time, and operator of the running task. - Clink **Task information** to view task details. ## Task history @@ -34,4 +34,4 @@ Click the tab **Running Task** to view the progress of the running tasks. Click **Task History** to view all ended tasks. - You can filter historical tasks by status, type, date, and time. -- On the right side of the target historical task, click **Task information** to view task details, and click **Logs** to view task execution logs. +- On the right side of the target historical task, click **Task information** to view task details, click **Logs** to view task execution logs, and click **Retry** to re-execute the failed task. diff --git a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md index 51551b4ca76..8ff4d916c60 100644 --- a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md +++ b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md @@ -229,6 +229,31 @@ The following section presents two methods for managing the Dashboard service. I sudo systemctl stop nbd-prometheus.service ``` +## Directory structure + +The structure of the Dashboard Enterprise Edition is as follows: + +```bash +├── assets # Static resource files +│   └── ... +├── bin # System executables +│   └──... +├── CMakeLists.txt # CMake configuration files +| +├── data # Database data files +│   └──... +├── download # Dependency packages +│   └──... +├── etc # Configuration files +│   └──... +├── logs # Log files +│   └──... +├── pids # Service process files +│   └──... +└── scripts # Scripts for managing services + └──... +``` + ## View logs - Users who manage services using `dashboard.service` can view the Dashboard Enterprise Edition logs in the `logs` directory. @@ -248,11 +273,11 @@ The following section presents two methods for managing the Dashboard service. I |`prometheus.log`| Prometheus service log. | |`br`| Backup and restore service log. | |`webserver.log`| Dashboard service log.
It takes effect only when the `Log.Mode` in the Dashboard configuration is `console`. | - |`access.log`| Access log.
It takes effect only when the `Log.Mode` in the Dashboard configuration is `file`. | - |`error.log`| Error log.
It takes effect only when the `Log.Mode` in the Dashboard configuration is `file`. | - |`severe.log`| Severe log.
It takes effect only when the `Log.Mode` in the Dashboard configuration is `file`. | - |`slow.log`| Slow log.
It takes effect only when the `Log.Mode` in the Dashboard configuration is `file`. | - |`stat.log`| Statistic log.
It takes effect only when the `Log.Mode` in the Dashboard configuration is `file`. | + |`access.log`| Access log. Records all request messages for accessing the services, including request time, source address, requested URL, HTTP method, returned HTTP status code, etc.
It takes effect only when the `Log.Mode` in the Dashboard configuration is `file`. | + |`error.log`| Error log. Records error messages that occur during service running. This may include runtime errors, system errors, service logic errors, etc.
It takes effect only when the `Log.Mode` in the Dashboard configuration is `file`. | + |`severe.log`| Severe log. Records error messages that could cause the system to crash, or seriously affect the correct functioning of the system. This may include runtime errors, system errors, serious service logic errors, etc.
It takes effect only when the `Log.Mode` in the Dashboard configuration is `file`. | + |`slow.log`| Slow log. Records requests or operations whose execution time exceeds a preset threshold, helping users identify performance bottlenecks.
It takes effect only when the `Log.Mode` in the Dashboard configuration is `file`. | + |`stat.log`| Statistic log. Records statistical information about the service, the content of which depends on the needs of the application and may include a variety of performance metrics, usage statistics, etc.
It takes effect only when the `Log.Mode` in the Dashboard configuration is `file`. | - Users managing services with systemd can access the logs for each Dashboard Enterprise Edition service through `journalctl`. diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md index 7604aa0eb15..ae9d828d9c1 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md @@ -47,7 +47,7 @@ Clicking the ![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch.png) bu !!! Caution - Before using Graph Space Metrics, users need to set `enable_space_level_metrics` to `true` in the Graph service. For specific operations, see [Update config](operator/config-management.md). + Before using Graph Space Metrics, users need to set `enable_space_level_metrics` to `true` in the Graph service. For specific operations, see [Update config](operator/update-config.md). ### Managing Monitoring diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/9.notification.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/9.notification.md index ba90c2139b9..f4c3de2a142 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/9.notification.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/9.notification.md @@ -47,7 +47,7 @@ Follow the below steps to create a custom rule. | Parameter | Description | | -------- | ------------------------------------------------------------ | - | Metric Type | Set a metric type. Metric type includes the node metric type and the service type (graphd,storaged,metad). | + | Metric Type | Set a metric type. Metric type includes the node metric type, service metric type (graphd,storaged,metad), and graph space metric type. | | Metric Rule | Click **+ Add condition** to set metric rules for a node or a service. It supports adding composite conditions (like the usage of AND). For more information, see [Monitoring metrics](../7.monitor-parameter.md).| | Alert duration | Set how long an alert lasts before the alert message is triggered. Unit: Minute (Min). | diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/config-management.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/update-config.md similarity index 84% rename from docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/config-management.md rename to docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/update-config.md index 459b3498534..6c978799d5f 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/config-management.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/update-config.md @@ -2,10 +2,6 @@ On **Config Management** page, you can view and update the service configuration files. -## Precautions - -You need to restart the corresponding service in the **Service** page after the configuration modification. For details, see [Service](service.md). - ## Entry 1. At the top navigation bar of the Dashboard Enterprise Edition page, click **Cluster Management**. @@ -18,9 +14,13 @@ You need to restart the corresponding service in the **Service** page after the 2. Locate the configuration to be modified and click **Edit** in the **Operation** column. 3. In the pop-up dialog box, you can modify the **Value** individually. They can also be modified uniformly at the top, and you need to click **Apply To All Services** after modification. + !!! note + + The top of the dialog box displays whether the modification of the parameter requires a restart to take effect. Please restart the corresponding service on the **Services** page. For details, see [Service](service.md). + A screenshot that shows the configuration of dashboard -4. Click **Confirm** after the modification is complete. +4. Click **Confirm** or **Save and Apply** after the modification is complete. ## Add configuration diff --git a/docs-2.0/nebula-dashboard-ent/8.faq.md b/docs-2.0/nebula-dashboard-ent/8.faq.md index dec8583c379..fe8efb9710c 100644 --- a/docs-2.0/nebula-dashboard-ent/8.faq.md +++ b/docs-2.0/nebula-dashboard-ent/8.faq.md @@ -60,4 +60,14 @@ When importing a cluster, you need to access the path where the NebulaGraph serv If **Service Host** shows `127.0.0.1`, and your Dashboard and NebulaGraph are deployed on the same machine when authorizing service hosts, the system will prompt "SSH connection error”. You need to change the Host IP of each service to the real machine IP in the configuration files of all NebulaGraph services. For more information, see [Configuration management](../5.configurations-and-logs/1.configurations/1.configurations.md). -If you import a cluster deployed with Docker, it also prompts "SSH connection error". Dashboard does not support importing a cluster deployed with Docker. \ No newline at end of file +If you import a cluster deployed with Docker, it also prompts "SSH connection error". Dashboard does not support importing a cluster deployed with Docker. + +## How to implement a highly available architecture + +Users can use third-party high-availability software (e.g. HAProxy) to implement the high-availability architecture for Dashboard and the high-availability architecture for LM. + +For example, you can deploy Dashboard service, database service, Prometheus service, and LM service on multiple machines. Then use HAProxy to implement their respective load balancing. + +Then fill in the external interfaces of each service into the configuration of the Dashboard, for example, fill in the external interface information of the database service, Prometheus service, LM service, so as to realize the highly available architecture. + +For detailed solutions, you can contact the after-sales staff for consultation. \ No newline at end of file diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md index 4bda9a2580b..c72d7e6c85b 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md @@ -277,6 +277,44 @@ The Dag Controller can perform complex graph computing with NebulaGraph Analytic exec_file: /home/xxx/nebula-analytics/scripts/run_algo.sh ``` +## Directory structure + +The structure of the Explorer Enterprise Edition is as follows: + +```bash +├── CMakeLists.txt # CMake configuration files +| +├── config # Configuration files +│   +├── dag-ctrl # Dag Controller installation directory +│   +├── scripts # Scripts for managing services +│   +├── tmp # Temporary files +| +└── yueshu-explorer-server # Explorer service application +``` + +## View logs + +Users can view the Explorer Enterprise Edition logs in the `logs` directory. + +For example: + +``` +cat logs/access.log +``` + +The descriptions of the log files are as follows. + +|Log file| Description | +|:--|:--| +|`access.log`| Access log. Records all request messages for accessing the services, including request time, source address, requested URL, HTTP method, returned HTTP status code, etc.
It takes effect only when the `Log.Mode` in the Explorer configuration is `file`. | +|`error.log`| Error log. Records error messages that occur during service running. This may include runtime errors, system errors, service logic errors, etc.
It takes effect only when the `Log.Mode` in the Explorer configuration is `file`. | +|`severe.log`| Severe log. Records error messages that could cause the system to crash, or seriously affect the correct functioning of the system. This may include runtime errors, system errors, serious service logic errors, etc.
It takes effect only when the `Log.Mode` in the Explorer configuration is `file`. | +|`slow.log`| Slow log. Records requests or operations whose execution time exceeds a preset threshold, helping users identify performance bottlenecks.
It takes effect only when the `Log.Mode` in the Explorer configuration is `file`. | +|`stat.log`| Statistic log. Records statistical information about the service, the content of which depends on the needs of the application and may include a variety of performance metrics, usage statistics, etc.
It takes effect only when the `Log.Mode` in the Explorer configuration is `file`. | + ## Configuration file description ```yaml @@ -346,7 +384,7 @@ IframeMode: Any source is allowed by default. # Origins: # The source whitelist of iframe. Any source is allowed by default. # - "http://192.168.8.8" -LicenseManagerURL: http://192.168.8.100:9119 # license manager url. +LicenseManagerURL: http://192.168.8.100:9119 # License manager url. CorsOrigins: [] # The list of domains that are allowed to initiate cross-domain requests. ``` diff --git a/docs-2.0/nebula-explorer/faq.md b/docs-2.0/nebula-explorer/faq.md index a78fd63fc2e..3a2ec43d144 100644 --- a/docs-2.0/nebula-explorer/faq.md +++ b/docs-2.0/nebula-explorer/faq.md @@ -84,3 +84,37 @@ If the port is not opened, an error similar to the following may be reported: ## How to resolve the error `broadcast.hpp:193] Check failed: (size_t)recv_bytes >= sizeof(chunk_tail_t) recv message too small: 0`? The amount of data to be processed is too small, but the number of compute nodes and processes is too large. Smaller `clusterSize` and `processes` need to be set when submitting jobs. + +## How to implement a highly available architecture + +Users can use third-party high-availability software (e.g. HAProxy) to implement the high-availability architecture for Explorer and the high-availability architecture for LM. + +For example, you can deploy Explorer service and database service on multiple machines. Then use HAProxy to implement their respective load balancing. + +Then fill in the external interfaces of database service into the configuration of the Explorer, as shown in the example below: + +```yaml +# The deployment mode of explorer, supports single and multiple instances.The optional values are single and multi. +# In multi-instance mode, local storage service (data import) will be disabled to ensure data consistency between instances. +AppInstance: "multi" + +# 数据库配置 +DB: + Enable: true + LogLevel: 4 # Database runtime log levels. 1, 2, 3, and 4 correspond to Silent, ERROR, Warn, and INFO, respectively. + IgnoreRecordNotFoundError: false + AutoMigrate: true # Whether or not to automatically create database tables. The default is true. + Type: "mysql" # The type of database used in the backend. Supports mysql and sqlite3. PolarDB is fully compatible with MySQL, if it is PolarDB, just fill in mysql. + Host: "192.168.8.200:3306" # The external IP and port for the high availability database service. + Name: "nebula" # Database name. + User: "root" # Database username. + Password: "123456" # Database password. + # SqliteDbFilePath: "./data/tasks.db" # This parameter is required for sqlite3 only. The address of the database file. + MaxOpenConns: 30 # Maximum number of active connections in the connection pool. + MaxIdleConns: 10 # Maximum number of free connections in the connection pool. +LicenseManagerURL: http://192.168.8.100:9119 # License manager url. +``` + +Finally, just access the external interface of Explorer provided by HAProxy. + +For detailed solutions, you can contact the after-sales staff for consultation. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 78e5e85f269..9c763ce3614 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -615,7 +615,7 @@ nav: # - Node: nebula-dashboard-ent/4.cluster-operator/operator/node.md # - Scale: nebula-dashboard-ent/4.cluster-operator/operator/scale.md # - Service: nebula-dashboard-ent/4.cluster-operator/operator/service.md - # - Config Management: nebula-dashboard-ent/4.cluster-operator/operator/config-management.md + # - Config Management: nebula-dashboard-ent/4.cluster-operator/operator/update-config.md # - Version upgrade: nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md # - Backup and restore: nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md # - Analysis: From 0988862021b00ca62155e8418ebe6aa8f5cff492 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 9 Oct 2023 11:26:04 +0800 Subject: [PATCH 2/5] Update docs-2.0/nebula-dashboard-ent/8.faq.md --- docs-2.0/nebula-dashboard-ent/8.faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-dashboard-ent/8.faq.md b/docs-2.0/nebula-dashboard-ent/8.faq.md index fe8efb9710c..48af8926cac 100644 --- a/docs-2.0/nebula-dashboard-ent/8.faq.md +++ b/docs-2.0/nebula-dashboard-ent/8.faq.md @@ -64,7 +64,7 @@ If you import a cluster deployed with Docker, it also prompts "SSH connection er ## How to implement a highly available architecture -Users can use third-party high-availability software (e.g. HAProxy) to implement the high-availability architecture for Dashboard and the high-availability architecture for LM. +Users can use third-party high-availability software (e.g. [HAProxy](https://www.haproxy.org/)) to implement the high-availability architecture for Dashboard and the high-availability architecture for LM. For example, you can deploy Dashboard service, database service, Prometheus service, and LM service on multiple machines. Then use HAProxy to implement their respective load balancing. From 0f8eb7ddf3a7c9985ca57b239ae362531bdce902 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 9 Oct 2023 11:26:09 +0800 Subject: [PATCH 3/5] Update docs-2.0/nebula-explorer/faq.md --- docs-2.0/nebula-explorer/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-explorer/faq.md b/docs-2.0/nebula-explorer/faq.md index 3a2ec43d144..38632fb0810 100644 --- a/docs-2.0/nebula-explorer/faq.md +++ b/docs-2.0/nebula-explorer/faq.md @@ -87,7 +87,7 @@ The amount of data to be processed is too small, but the number of compute nodes ## How to implement a highly available architecture -Users can use third-party high-availability software (e.g. HAProxy) to implement the high-availability architecture for Explorer and the high-availability architecture for LM. +Users can use third-party high-availability software (e.g. [HAProxy](https://www.haproxy.org/)) to implement the high-availability architecture for Explorer and the high-availability architecture for LM. For example, you can deploy Explorer service and database service on multiple machines. Then use HAProxy to implement their respective load balancing. From 047a60c9750c28bd0407bb72dbf0615387d02949 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 9 Oct 2023 13:43:34 +0800 Subject: [PATCH 4/5] Update ex-ug-deploy.md --- docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md index c72d7e6c85b..9be87592d88 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md @@ -292,7 +292,7 @@ The structure of the Explorer Enterprise Edition is as follows: │   ├── tmp # Temporary files | -└── yueshu-explorer-server # Explorer service application +└── nebula-explorer-server # Explorer service application ``` ## View logs @@ -320,7 +320,7 @@ The descriptions of the log files are as follows. ```yaml Name: explorer Version: {{explorer.release}} -Database: yueshu +Database: nebula Host: 0.0.0.0 # Specifies the address where explorer can be accessed. Port: 7002 # The default access port for explorer. From a15af0e703ecdb6d9a78ab774fdafb7f052cd69f Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 9 Oct 2023 13:44:24 +0800 Subject: [PATCH 5/5] Update faq.md --- docs-2.0/nebula-explorer/faq.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/nebula-explorer/faq.md b/docs-2.0/nebula-explorer/faq.md index 38632fb0810..e608f5b7e27 100644 --- a/docs-2.0/nebula-explorer/faq.md +++ b/docs-2.0/nebula-explorer/faq.md @@ -98,7 +98,7 @@ Then fill in the external interfaces of database service into the configuration # In multi-instance mode, local storage service (data import) will be disabled to ensure data consistency between instances. AppInstance: "multi" -# 数据库配置 +# Database configuration DB: Enable: true LogLevel: 4 # Database runtime log levels. 1, 2, 3, and 4 correspond to Silent, ERROR, Warn, and INFO, respectively. @@ -117,4 +117,4 @@ LicenseManagerURL: http://192.168.8.100:9119 # License manager url. Finally, just access the external interface of Explorer provided by HAProxy. -For detailed solutions, you can contact the after-sales staff for consultation. \ No newline at end of file +For detailed solutions, you can contact the after-sales staff for consultation.