diff --git a/docs/observability/dashboard.md b/docs/observability/dashboard.md index 2a31ce3d093070815b6d1363345322765454fb56..a5b5f972bb41aaf639bc1d4517106672f2637d64 100644 --- a/docs/observability/dashboard.md +++ b/docs/observability/dashboard.md @@ -1,10 +1,10 @@ # Dashboard -openYuanrong提供了可视化的 `dashboard` ，用于查看openYuanrong集群和实例的状态和详细信息，以便于用户可以查看系统的性能并快速排查问题。目前 dashboard 支持上千条实例数据的稳定承载与展示。 +openYuanrong 提供了可视化的 `dashboard` ，用于查看 openYuanrong 集群和实例的状态和详细信息，以便于用户可以查看系统的性能并快速排查问题。目前 dashboard 支持上千条实例数据的稳定承载与展示。 ## 启动 Dashboard -要访问 `dashboard` ，需要在启动openYuanrong系统时，加上 *`--enable_dashboard=true`* 参数以及依赖项参数。使用 dashboard 全量功能的命令如下： +要访问 `dashboard` ，需要在部署 openYuanrong 集群主节点时，加上 *`--enable_dashboard=true`* 参数以及依赖项参数。使用 dashboard 全量功能的命令如下： ```bash yr start --master --enable_faas_frontend=true --enable_dashboard=true --enable_collector=true --enable_separated_redirect_runtime_std=true --prometheus_address=prometheus_ip:prometheus_port --enable_metrics=true --metrics_config_file={file_name}.json --port_policy=FIX @@ -12,7 +12,7 @@ yr start --master --enable_faas_frontend=true --enable_dashboard=true --enable_c 您可参考 [部署参数表](../deploy/deploy_processes/parameters.md) 按需裁剪不需要的功能。 -上方 `yr start` 命令会启动openYuanrong系统的 master 节点，并打印出包含 `local_ip` 和 `dashboard_port` 信息，如下所示： +上方 `yr start` 命令会部署 openYuanrong 集群的主节点，并打印出包含 `local_ip` 和 `dashboard_port` 信息，如下所示： ```bash Yuanrong deployed succeed @@ -29,8 +29,8 @@ Cluster master info: * 查看总逻辑资源占用率：[Overview 页面](observability-dashboard-overview)，[Cluster 页面](observability-dashboard-cluster) * 概览所有组件和实例状态：[Overview 页面](observability-dashboard-overview) * 查看所有节点和组件的状态和逻辑资源占用率：[Cluster 页面](observability-dashboard-cluster) -* 查看所有 instances 任务进度和状态：[Instances 页面](observability-dashboard-instances) -* 查看 instance 的日志和错误信息：[Logs 页面](observability-dashboard-logs) +* 查看所有实例的任务进度和状态：[Instances 页面](observability-dashboard-instances) +* 查看实例的日志和错误信息：[Logs 页面](observability-dashboard-logs) (observability-dashboard-overview)= @@ -38,9 +38,9 @@ Cluster master info: Overview 页面可以查看总逻辑资源占用率、概览所有组件和实例状态。 -逻辑资源卡片展示了 Logical CPU 总占用核数、总核数及总占用率，Logical Memory 总占用量(GB)、总内存量(GB)及总占用率。 -集群状态卡片展示了总节点数和活跃节点数。 -实例状态卡片展示了总实例数和 `running` 、`exited`、`fatal` 状态实例数。 +* 逻辑资源卡片(Logical Resources)展示了 Logical CPU 总占用核数、总核数及总占用率，Logical Memory 总占用量(GB)、总内存量(GB)及总占用率。 +* 集群状态卡片(Cluster Status)展示了总节点数和活跃节点数。 +* 实例状态卡片(Instances)展示了总实例数和 `running` 、`exited`、`fatal` 状态实例数。 页面示例： @@ -52,8 +52,8 @@ Overview 页面可以查看总逻辑资源占用率、概览所有组件和实 Cluster 页面可以查看总逻辑资源占用率，所有节点和组件的状态及各资源指标使用情况，并将节点和组件的层次关系可视化。 -逻辑资源卡片展示了 Logical CPU 总占用核数、总核数及总占用率，Logical Memory 总占用量(GB)、总内存量(GB)及总占用率。 -组件卡片展示了节点和运行在节点上的 agent 代理的状态、地址、CPU 和 NPU 占用率、Memory/Disk/Logical CPU/Logical Memory 各指标的使用量、总量及占用率。 +* 逻辑资源卡片(Logical Resources)展示了 Logical CPU 总占用核数、总核数及总占用率，Logical Memory 总占用量(GB)、总内存量(GB)及总占用率。 +* 组件卡片(Components)展示了节点(node)的状态、地址、CPU 和 NPU 占用率、Memory/Disk/Logical Resources 各指标的使用量、总量及占用率；运行在对应节点上的代理(agent)的状态、地址、Logical Resources 指标的使用量、总量及占用率；运行在对应代理上的实例(instance)的状态、地址、CPU 和 NPU 占用率、Memory/Logical Resources 各指标的使用量、总量及占用率。 页面示例： @@ -86,7 +86,9 @@ Instances 页面可以查看所有实例的详细信息。 ![](../images/dashboard/instances.png) -点击 `ID` 或 `log` 跳转至 instance 详情页，可查看此 instance 的详细信息、打印的日志和错误信息。页面示例： +点击 `ID` 或 `log` 跳转至实例详情页。其中实例详情卡片(InstanceInfos)展示了此实例的详细信息，日志卡片(Log)显示此实例的日志和错误信息。 + +页面示例： ![](../images/dashboard/instance_details.png) @@ -104,4 +106,4 @@ Logs 页面可以查看所有日志内容和错误信息。页面示例： 点击想要查看的文件，即可展示文件内容。页面示例： -![](../images/dashboard/log_content.png) \ No newline at end of file +![](../images/dashboard/log_content.png)