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

optimize dashboard ent #1840

Merged
merged 1 commit into from
May 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 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 @@ -39,16 +39,16 @@
2. 使用`tar -xzvf`解压 TAR 包。

```bash
$ tar -xzvf nebula-dashboard-ent-<version>.linux-amd64.tar.gz
$ tar -xzvf nebula-dashboard-ent-<version>.linux-amd64.tar.gz -C <install_path>
```

例如:

```bash
$ tar -xzvf nebula-dashboard-ent-{{dashboard_ent.release}}.linux-amd64.tar.gz
$ tar -xzvf nebula-dashboard-ent-{{dashboard_ent.release}}.linux-amd64.tar.gz -C /usr/local/
```

3. 使用`vim config/config.yaml`命令设置配置文件。
3. 使用`vim /usr/local/nebula-dashboard-ent/config/config.yaml`命令设置配置文件。

```bash
# 数据库信息
Expand Down Expand Up @@ -88,6 +88,14 @@
baseDN: dc=vesoft,dc=com # 查询用户数据的路径。
userFilter: "&(objectClass=*)" # 查询条件。
emailKey: mail # LDAP 数据库存放邮箱信息的字段名。
monitor:
onStart:
disableNodeExporterDeploy: false
disableNebulaExporterConfig: false
disablePrometheusConfig: false
disablePrometheusRule: false
disableAlertManagerRoutes: false
disableRecoveryAlertMessage: false
```

4. 拷贝 License 至`nebula-dashboard-ent`目录下。
Expand All @@ -106,7 +114,7 @@
可以使用以下命令一键启动 Dashboard。

```bash
$ cd scripts
$ cd /usr/local/nebula-dashboard-ent/scripts
$ sudo ./dashboard.service start all
```
或是执行以下命令,分别启动 prometheus、webserver、exporter 和 gateway 服务以启动 Dashboard。
Expand Down
20 changes: 11 additions & 9 deletions docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# 集群监控

本文主要介绍 Dashboard 的集群监控中的节点监控、服务监控、图空间监控,以及可视化的监控大屏。
本文主要介绍 Dashboard 的集群监控中的节点监控、服务监控以及可视化的监控大屏。

在 Dashboard 顶部导航栏,单击**集群管理**,在目标集群右侧单击**详情**,在左侧导航栏的**集群监控**下包含**节点监控**、**服务监控**和**监控大屏**。

## 节点监控

在 Dashboard 顶部导航栏,单击**集群管理**,然后单击**集群监控**->**节点监控**进入节点监控页面。
单击**集群监控**->**节点监控**进入节点监控页面。

用户可快速查看 CPU、Memory、Load、Disk 和 Network In/Out 变化情况。

Expand All @@ -17,7 +19,7 @@

## 服务监控

在 Dashboard 顶部导航栏,单击**集群管理**,然后单击**集群监控**->**服务监控**进入服务监控页面。
单击**集群监控**->**服务监控**进入服务监控页面。

用户可快速查看 Graph、Meta、Storage 服务的信息,右上角显示正常服务和异常服务的数量。

Expand All @@ -33,24 +35,24 @@
- 可以设置基线,作为参考标准线。
- 可以查看当前服务的状态。

## 图空间监控
### 图空间监控

!!! note

使用图空间指标前,用户需要在 Graph 服务中,设置`enable_space_level_metrics`为`true`。具体操作,参见[更新配置](4.manage.md)。

图空间的监控指标记录不同图空间的数据。目前,只有 Graph 服务支持基于图空间的监控指标。
服务监控页面还可以监控图空间级别指标。**只有当图空间指标的行为被触发后,用户才能指定图空间查看对应的图空间指标的信息**。图空间的监控指标记录不同图空间的数据。目前,只有 Graph 服务支持基于图空间的监控指标。

**只有当图空间指标的行为被触发后,用户才能指定图空间查看对应的图空间指标的信息**。Dashboard 支持的图空间指标,参见[图空间](../7.monitor-parameter.md)。
Dashboard 支持的图空间指标,参见[图空间](../7.monitor-parameter.md)。

![graph-metrics](https://docs-cdn.nebula-graph.com.cn/figures/space_level_metrics_cn.png)

## 可视化监控大屏

Dashboard 企业版的可视化监控大屏帮助用户一目了然地把握集群的健康状态、服务及节点信息。

在 Dashboard 顶部导航栏,单击**集群管理**,然后单击**集群监控**->**监控大屏**进入监控大屏页面。
单击**集群监控**->**监控大屏**进入监控大屏页面。

![tv-dashboard](https://docs-cdn.nebula-graph.com.cn/figures/screen_2022-04-13_cn.png)

| 大屏区域 | 显示信息 |
Expand All @@ -60,7 +62,7 @@ Dashboard 企业版的可视化监控大屏帮助用户一目了然地把握集
| 左侧区域 | 1. 集群的每秒查询率 QPS (Query Per Second)。<br/>2. 在不同时间段两个 Storage 服务指标的监控信息。两个指标分别是 add_edges_latency_us、add_vertices_latency_us。 |
| 右侧区域 | 在不同时间段节点相关指标的信息,指标包括:<br/>1. cpu_utilization<br/>2. memory_utilization<br/>3. load_1m<br/>4. disk_readbytes<br/>5. disk_writebytes |

有关监控指标的具体信息,参见[指标监控](../7.monitor-parameter.md)。
有关监控指标的具体信息,参见[监控指标说明](../7.monitor-parameter.md)。

!!! note

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

本文主要介绍 Dashboard 的集群信息,包括信息总览和集群诊断。用户可以通过**信息总览**查看 Nebula Graph 内核相关信息,通过**集群诊断**查看集群的诊断信息并根据诊断报告做出相应的调整。

在 Dashboard 顶部导航栏,单击**集群管理**,单击目标集群右侧**详情**,然后在左侧导航栏,单击**集群信息**,看到以下部分:

- 信息总览
- 集群诊断

在 Dashboard 顶部导航栏,单击**集群管理**,单击目标集群右侧**详情**,在左侧导航栏的**集群监控**下包含**信息总览**和**集群诊断**。

## 信息总览

![coreinfo](https://docs-cdn.nebula-graph.com.cn/figures/clustercore-info_2022-04-11_cn.png)

!!! note

在查看集群信息之前,用户需要选择任意一个在线的 Graph 服务地址,输入登录 Nebula Graph 的账号(非 Dashboard 登录账号)和对应密码。
Expand All @@ -20,6 +14,8 @@

用户需要保证 Nebula Graph 服务已经部署并启动。详细信息,参见 [Nebula Graph 安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往 Nebula Graph 安装部署")。

![coreinfo](https://docs-cdn.nebula-graph.com.cn/figures/clustercore-info_2022-04-11_cn.png)

用户可以在**信息总览**页面查看 Nebula Graph 内核相关信息,包括 Storage 服务信息、Storage Leader 分布、Nebula Graph 各个服务的版本信息及所在节点信息、分片的分布情况及详细信息。


Expand Down Expand Up @@ -94,4 +90,4 @@

## 集群诊断

用户可以在集群信息菜单栏下,单击集群诊断定位和分析集群出现的问题。详情参见[集群诊断](7.cluster-diagnosis.md)。
用户可以在**集群诊断**页面,单击**开始诊断**自动生成最近一天的诊断报告,便于分析集群出现的问题。详情参见[集群诊断](7.cluster-diagnosis.md)。
6 changes: 4 additions & 2 deletions docs-2.0/nebula-dashboard-ent/4.cluster-operator/4.manage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 集群操作

本文主要介绍 Dashboard 企业版的集群操作,包括集群节点、集群服务、集群扩缩容、服务配置、集群成员管理
本文主要介绍 Dashboard 企业版的集群操作,包括节点管理、扩缩容、服务管理、更新配置和成员管理

## 节点管理

Expand All @@ -12,9 +12,11 @@

- 单击**节点监控**可快速跳转至节点监控页面,详情信息见[集群监控](../4.cluster-operator/2.monitor.md)。

- 单击**服务管理**可快速跳转至服务管理页面。

- 单击**编辑节点**可修改 SSH 端口号、用户名、密码。

- 当节点上无服务时,可单击**删除节点**。
- 当节点上无服务时,可以**删除节点**。

## 扩缩容

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

本文主要介绍 Dashboard 的操作记录。

在 Dashboard 顶部导航栏,单击**集群管理**,然后在左侧导航栏,单击**操作记录**进入操作记录页面。
在 Dashboard 顶部导航栏,单击**集群管理**,单击目标集群右侧**详情**,然后在左侧导航栏,单击**操作记录**进入操作记录页面。

在操作页面可以看到 1 小时、6 小时、12 小时、1 天、3 天、7 天和 14 天的操作记录,操作人、操作、时间、集群的信息。
10 changes: 6 additions & 4 deletions docs-2.0/nebula-dashboard-ent/9.alerts.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# 监控告警

监控告警是对 Nebula Graph 集群的监控指标进行报警的服务。用户可以查看告警信息,设置告警规则和告警接收方。
监控告警是监控 Nebula Graph 集群的监控指标进行报警的服务。用户可以查看告警信息,设置告警规则和告警接收方。

在 Dashboard 顶部导航栏,单击**集群管理**,在目标集群右侧单击**详情**,在左侧导航栏的**通知**下包含**告警信息**、**告警规则**和**接收人设置**。

![Alerts](https://docs-cdn.nebula-graph.com.cn/figures/alerts_cn.gif)

## 告警信息

用户在**集群管理**页面左侧导航栏中,单击**通知**->**告警信息**可查看触发的告警信息。
单击**通知**->**告警信息**可查看触发的告警信息。

- 支持在搜索框中根据告警的名称搜索目标告警信息。
- 支持通过日期筛选告警信息。同时支持不同时间段的告警信息筛选,时间段包括 1 小时、6 小时、12 小时、1 天、3 天、7 天和 14 天。
Expand All @@ -24,8 +26,8 @@
用户创建自定义规则的步骤如下:

1. 在 Dashboard 顶部导航栏中,单击**集群管理**,然后在目标集群右侧,单击**详情**。
2. 在**集群管理**页面左侧导航栏中,单击**通知**->**规则**。
3. 在**规则**页面,单击**自定义规则**,然后单击右侧的**创建规则**。
2. 在**集群管理**页面左侧导航栏中,单击**通知**->**告警规则**。
3. 在**告警规则**页面,单击**自定义规则**,然后单击右侧的**创建规则**。
4. 设置创建规则的所需的信息。
1. 在**基本信息**配置页中,设置告警名称、级别和频率。

Expand Down