Skip to content

Commit

Permalink
update (#3026)
Browse files Browse the repository at this point in the history
* update

dashboard 的目录结构和介绍,以及日志文件的介绍。
dashboard 图空间容量预警管理。
dashboard 重试失败任务。
dashboard 新增图空间指标。
dashboard 修改配置提示。
dashboard/explorer 高可用架构。

* Update docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md

* Update docs-2.0/nebula-dashboard-ent/8.faq.md

* Update docs-2.0/nebula-explorer/faq.md
  • Loading branch information
cooper-lzy authored Oct 9, 2023
1 parent 79b8bd5 commit 062b6e8
Show file tree
Hide file tree
Showing 6 changed files with 81 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs-2.0/nebula-dashboard-ent/10.tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@
单击**历史任务**页签,用户可以查看所有结束的任务。

- 用户可通过任务状态、类型、时间段筛选历史任务。
- 在目标历史任务右侧,单击**任务信息**查看历史任务的详情;单击**任务日志**查看任务执行日志。
- 在目标历史任务右侧,单击**任务信息**查看历史任务的详情;单击**任务日志**查看任务执行日志;单击**重试**重新执行失败的任务
35 changes: 30 additions & 5 deletions docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,31 @@ sudo dpkg -r <package_name>
sudo systemctl stop nbd-prometheus.service
```

## 目录结构

{{dashboard_ent.name}}的目录结构如下:

```bash
├── assets # 静态资源文件
│   └── ...
├── bin # 系统执行文件
│   └──...
├── CMakeLists.txt # CMake 配置文件
|
├── data # 数据库数据文件
│   └──...
├── download # 依赖包
│   └──...
├── etc # 配置文件
│   └──...
├── logs # 日志文件
│   └──...
├── pids # 服务进程文件
│   └──...
└── scripts # 管理服务的脚本
└──...
```

## 查看日志

- 使用脚本`dashboard.service`管理服务的用户可以在`logs`目录内查看{{dashboard_ent.name}}的日志。
Expand All @@ -238,11 +263,11 @@ sudo dpkg -r <package_name>
|`prometheus.log`| Prometheus 服务日志。 |
|`br`| 备份恢复日志。 |
|`webserver.log`| {{dashboard_ent.name}}服务日志。</br>{{dashboard_ent.name}}的配置`Log.Mode``console`时生效。 |
|`access.log`| 访问日志。</br>{{dashboard_ent.name}}的配置`Log.Mode``file`时生效。 |
|`error.log`| 错误日志。</br>{{dashboard_ent.name}}的配置`Log.Mode``file`时生效。 |
|`severe.log`| 严重错误日志。</br>{{dashboard_ent.name}}的配置`Log.Mode``file`时生效。 |
|`slow.log`| 慢日志。</br>{{dashboard_ent.name}}的配置`Log.Mode``file`时生效。 |
|`stat.log`| 统计日志。</br>{{dashboard_ent.name}}的配置`Log.Mode``file`时生效。 |
|`access.log`| 访问日志。通常记录所有访问服务的请求信息,包括请求时间、源地址、请求的 URL、HTTP 方法、返回的 HTTP 状态码等。</br>{{dashboard_ent.name}}的配置`Log.Mode``file`时生效。 |
|`error.log`| 错误日志。记录服务运行过程中出现的错误信息。这可能包括运行时错误、系统错误、服务逻辑错误等。</br>{{dashboard_ent.name}}的配置`Log.Mode``file`时生效。 |
|`severe.log`| 严重错误日志。记录那些可能导致系统崩溃,或者严重影响系统正常运行的错误。这可能包括运行时错误、系统错误、严重的服务逻辑错误等。</br>{{dashboard_ent.name}}的配置`Log.Mode``file`时生效。 |
|`slow.log`| 慢日志。记录执行时间超过预设阈值的请求或操作,帮助用户找出性能瓶颈。</br>{{dashboard_ent.name}}的配置`Log.Mode``file`时生效。 |
|`stat.log`| 统计日志。记录服务的统计信息,具体的内容取决于应用的需求,可能包括各种性能指标、使用情况统计等。</br>{{dashboard_ent.name}}的配置`Log.Mode``file`时生效。 |

- 使用 systemd 管理服务的用户,可以通过`journalctl`查看{{dashboard_ent.name}}中各个服务的日志。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

| 参数 | 说明 |
| -------- | ------------------------------------------------------------ |
| 指标类型 | 包括节点和服务(graphd、storaged、metad)两种指标类型|
| 指标类型 | 包括节点、服务(graphd、storaged、metad)和图空间三种指标类型|
| 指标规则 | 单击**添加条件**为节点或者服务设置指标规则。支持添加复合条件(`AND`关系)。指标的详细介绍请参见[监控指标](../7.monitor-parameter.md)|
| 持续时间 | 设置警报持续多长时间后触发告警。单位分(Min)。 |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

在更新配置页面,用户可以查看及更新服务的配置文件。

## 注意事项

配置更新后需要在**服务**页面重启对应服务。具体操作参见[服务管理](service.md)

## 入口

1. 在{{dashboard_ent.name}}顶部导航栏,单击**集群管理**
Expand All @@ -18,9 +14,13 @@
2. 查找需要修改的配置,在操作列单击**编辑**
3. 在弹出的会话框中,可以单个修改**配置值**,也可以在上方统一修改,修改后需要单击**应用到所有服务**

!!! note

会话框上方会显示修改该参数是否需要重启才能生效。如需重启,请在**服务**页面重启对应服务。具体操作参见[服务管理](service.md)。

<img src="https://docs-cdn.nebula-graph.com.cn/figures/ec_dash_config_230912_cn.png" width="1000" alt="运维监控更新配置截屏">

4. 修改完成后单击**确认**
4. 修改完成后单击**确认****保存并生效**

## 新增配置

Expand Down
10 changes: 10 additions & 0 deletions docs-2.0/nebula-dashboard-ent/8.faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,13 @@ Meta 服务主要存储{{nebula.name}}数据库中的元数据。一旦 Meta 服
如果在为节点授权时,**节点Host** 显示为`127.0.0.1`且{{dashboard_ent.name}}和{{nebula.name}}没有被部署在同一台机器上,系统会提示 “ssh 连接失败”。用户需要在{{nebula.name}}所有服务的配置文件中,修改各服务的 Host IP 为真实的机器 IP。更多信息,参见[配置管理](../5.configurations-and-logs/1.configurations/1.configurations.md)

如果用户导入的是 Docker 部署的集群,也会显示 “ssh 连接失败”。{{dashboard_ent.name}}不支持导入使用 Docker 部署的集群。

## 如何实现高可用架构

用户可以使用第三方高可用软件(例如 [HAProxy](https://www.haproxy.org/))实现{{dashboard_ent.name}}的高可用架构和 LM 的高可用架构。

例如,用户可以在多台机器上部署{{dashboard_ent.name}}服务、数据库服务、Prometheus 服务、LM 服务。然后使用 HAProxy 实现各自的负载均衡。

然后将各个服务的对外接口填写到{{dashboard_ent.name}}的配置中,例如填写数据库服务、Prometheus 服务、LM 服务的对外接口信息,从而实现高可用架构。

关于详细的配置方案,可以联系售后工作人员咨询。
34 changes: 34 additions & 0 deletions docs-2.0/nebula-explorer/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,37 @@ Dag Controller 包含图查询组件和图计算组件。图查询是发送请
## 任务运行失败,报错`broadcast.hpp:193] Check failed: (size_t)recv_bytes >= sizeof(chunk_tail_t) recv message too small: 0`怎么办?

任务要处理的数据量过小,但是配置的计算节点数与进程数太多。需要在提交作业时设置较小的`clusterSize``processes`

## 如何实现高可用架构

用户可以使用第三方高可用软件(例如 [HAProxy](https://www.haproxy.org/))实现{{explorer.name}}的高可用架构。

例如,用户可以在多台机器上部署{{explorer.name}}服务、数据库服务,然后使用 HAProxy 实现各自的负载均衡。

然后将数据库服务的对外接口填写到{{explorer.name}}的配置中,示例如下:

```yaml
# {{explorer.name}}的部署模式,支持单实例和多实例。可选值为:single 和 multi。默认值为 single。
# 多实例模式下,本地的存储服务(数据导入)将被禁止,以保证实例之间的数据一致性。
AppInstance: "multi"

# 数据库配置
DB:
Enable: true
LogLevel: 4 # 数据库运行日志级别。1、2、3、4 分别对应 Silent、ERROR、Warn、INFO。
IgnoreRecordNotFoundError: false
AutoMigrate: true # 是否自动创建数据库表。默认为 true。
Type: "mysql" # 后端使用的数据库类型。可选值为 mysql 和 sqlite3。PolarDB 完全兼容 MySQL, 如果是 PolarDB,填写 mysql 即可。
Host: "192.168.8.200:3306" # 数据库高可用服务的对外 IP 和端口。
Name: "nebula" # 数据库名称。
User: "root" # 数据库用户名。
Password: "123456" # 数据库密码。
# SqliteDbFilePath: "./data/tasks.db" # 仅 sqlite3 需要填写该参数。数据库文件地址。
MaxOpenConns: 30 # 连接池最大活跃连接数。
MaxIdleConns: 10 # 连接池最大空闲连接数。
LicenseManagerURL: http://192.168.8.100:9119 # License Manager 所在的主机 IP,端口默认为9119。
```
最后访问 HAProxy 提供的{{explorer.name}}对外接口即可。
关于详细的配置方案,可以联系售后工作人员咨询。

0 comments on commit 062b6e8

Please sign in to comment.