Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update dashboard deployment #2517

Merged
133 changes: 60 additions & 73 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 @@ -64,7 +64,7 @@
Enable: false
Log: # Dashboard 运行日志设置。
KeepDays: 7 # 日志保留天数。
Mode: console # 日志保存方式。
Mode: console # 日志保存方式,支持 console 和 file。console 表示服务日志会记录在 webserver.log里;file 表示服务日志会分别记录在 access.log、error.log、severe.log、slow.log 和 stat.log 里
Database:
Dialect: sqlite # 使用的数据库类型,目前支持 SQLite 和 MySQL,默认使用 SQLite。
AutoMigrate: true # 自动创建数据库表,默认为 true。
Expand Down Expand Up @@ -125,6 +125,7 @@
$ cd /usr/local/nebula-dashboard-ent/scripts
$ sudo ./dashboard.service start all
```

或是执行以下命令,分别启动 Prometheus、nebula-dashboard-server、nebula-stats-exporter 和 Alertmanager 依赖服务以启动 Dashboard。

```bash
Expand All @@ -139,41 +140,6 @@

在启动 Dashboard 后,如再修改配置文件的话,在修改后,可在`scripts`目录下执行`dashboard.service restart all`同步修改至 Dashboard 客户端页面中。

### 管理 Dashboard 服务

Dashboard 使用脚本`dashboard.service`管理服务,包括启动、停止和查看。

```bash
$ sudo <dashboard_path>/dashboard/scripts/dashboard.service
[-v] [-h]
<start|stop|status> <prometheus|webserver|exporter|gateway|all>
```

| 参数 | 说明 |
| :------------------------- | :------------------- |
| `dashboard_path` | Dashboard 安装路径。 |
| `-v` | 显示详细调试信息。 |
| `-h` | 显示帮助信息。 |
| `start` | 启动服务。 |
| `stop` | 停止服务。 |
| `status` | 查看服务状态。 |
| `prometheus` | 管理 prometheus 服务。 |
| `webserver` | 管理 webserver 服务。 |
| `exporter` | 管理 exporter 服务。 |
| `gateway` | 管理 gateway 服务。 |
| `all` | 管理所有服务。 |

### 示例

Dashboard 的安装在当前目录下,用户可以用以下命令管理服务。

```bash
$ sudo /dashboard/scripts/dashboard.service start all #启动 Dashboard 所有服务。
$ sudo /dashboard/scripts/dashboard.service stop all #停止 Dashboard 所有服务。
$ sudo /dashboard/scripts/dashboard.service status all #查看 Dashboard 所有服务状态。
$ sudo /dashboard/scripts/dashboard.service restart all #重启 Dashboard 所有服务状态。
```

## 使用 RPM 包部署

### 安装
Expand Down Expand Up @@ -245,28 +211,6 @@ $ sudo /dashboard/scripts/dashboard.service restart all #重启 Dashboard 所有
emailKey: mail # LDAP 数据库存放邮箱信息的字段名。
```

### 查看日志

用户可以在`/var/log/messages`路径下查看 Dashboard 企业版的操作日志。

例如:

```
sudo cat /var/log/messages
```

或者执行以下命令查看 Dashboard 中各个服务的日志:

```
journalctl -u {nbd-prometheus.service|nbd-alert-manager.service|nbd-stats-exporter.service|nbd-webserver.service} -b
```

例如,查看 Prometheus 服务的日志:

```
journalctl -u nbd-prometheus.service -b
```

### 卸载

执行以下命令卸载通过 RPM 包部署的 Dashboard。
Expand Down Expand Up @@ -337,36 +281,79 @@ sudo rpm -e <package_name>
messageStore: 90 # 告警消息保存的天数,默认 90 天。
```

### 查看日志

用户可以在`/var/log/syslog`路径下查看 Dashboard 企业版的操作日志。
### 卸载

例如:
执行以下命令卸载通过 DEB 包部署的 Dashboard。

```
sudo cat /var/log/syslog
sudo dpkg -r <package_name>
```

或者执行以下命令查看 Dashboard 中各个服务的日志:
## 管理 Dashboard 服务

Dashboard 使用脚本`dashboard.service`管理服务,包括启动、停止和查看。

```bash
$ sudo <dashboard_path>/dashboard/scripts/dashboard.service
[-v] [-h]
<start|stop|status> <prometheus|webserver|exporter|gateway|all>
```
journalctl -u {nbd-prometheus.service|nbd-alert-manager.service|nbd-stats-exporter.service|nbd-webserver.service} -b
```

例如,查看 Prometheus 服务的日志:
| 参数 | 说明 |
| :------------------------- | :------------------- |
| `dashboard_path` | Dashboard 安装路径。 |
| `-v` | 显示详细调试信息。 |
| `-h` | 显示帮助信息。 |
| `start` | 启动服务。 |
| `stop` | 停止服务。 |
| `status` | 查看服务状态。 |
| `prometheus` | 管理 prometheus 服务。 |
| `webserver` | 管理 webserver 服务。 |
| `exporter` | 管理 exporter 服务。 |
| `gateway` | 管理 gateway 服务。 |
| `all` | 管理所有服务。 |

!!! note

- RPM/DEB 包安装的 Dashboard,需要为`dashboard.service`添加可执行权限,命令为`sudo chmod +x dashboard.service`。
- 查看 Dashboard 版本可以使用命令`./dashboard.service -version`。

```
journalctl -u nbd-prometheus.service -b
### 示例

Dashboard 的安装在当前目录下,用户可以用以下命令管理服务。

```bash
$ sudo /dashboard/scripts/dashboard.service start all #启动 Dashboard 所有服务。
$ sudo /dashboard/scripts/dashboard.service stop all #停止 Dashboard 所有服务。
$ sudo /dashboard/scripts/dashboard.service status all #查看 Dashboard 所有服务状态。
$ sudo /dashboard/scripts/dashboard.service restart all #重启 Dashboard 所有服务状态。
```

### 卸载
## 查看日志

执行以下命令卸载通过 DEB 包部署的 Dashboard。
用户可以在`logs`目录内查看 Dashboard 企业版的日志。

例如:

```
sudo dpkg -r <package_name>
cat logs/prometheus.log
```

日志文件说明如下。

|日志文件名|说明|
|:--|:--|
|`alertmanager.log`| Alertmanager 服务日志。 |
|`nebula-stats-exporter.log`| nebula-stats-exporter 服务日志。 |
|`prometheus.log`| Prometheus 服务日志。 |
|`br`| 备份恢复日志。 |
|`webserver.log`| Dashboard 服务日志。</br>Dashboard 的配置`Log.Mode`为`console`时生效。 |
|`access.log`| 访问日志。</br>Dashboard 的配置`Log.Mode`为`file`时生效。 |
|`error.log`| 错误日志。</br>Dashboard 的配置`Log.Mode`为`file`时生效。 |
|`severe.log`| 严重错误日志。</br>Dashboard 的配置`Log.Mode`为`file`时生效。 |
|`slow.log`| 慢日志。</br>Dashboard 的配置`Log.Mode`为`file`时生效。 |
|`stat.log`| 统计日志。</br>Dashboard 的配置`Log.Mode`为`file`时生效。 |

## 后续操作

[连接 Dashboard](3.connect-dashboard.md)
[连接 Dashboard](3.connect-dashboard.md)
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,4 @@

- 单击 ![nav](https://docs-cdn.nebula-graph.com.cn/figures/nav-dashboard_cn.png) 图标,可快速查看[服务监控信息](../2.monitor.md)。

<!--
- 进行数据同步时,可以在**其他依赖服务**页面查看及管理相关的服务。
-->
- 进行数据同步时,可以在**依赖服务**页面查看及管理相关的服务。关于数据同步的详情,参见[集群间数据同步](../../../synchronization-and-migration/replication-between-clusters.md)。