From 49db68e3cb1084776f09e1fb173cfbab573fb632 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 17 Jan 2023 15:34:56 +0800 Subject: [PATCH 1/2] Added audit logs, runtime logs, and updated job management --- .../cluster-information/audit-log.md | 27 +++++++++++++++++++ .../cluster-information/job-management.md | 14 +++++----- .../cluster-information/runtime-log.md | 22 +++++++++++++++ mkdocs.yml | 4 ++- 4 files changed, 59 insertions(+), 8 deletions(-) create mode 100644 docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md create mode 100644 docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/runtime-log.md diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md new file mode 100644 index 00000000000..36b24dcd941 --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md @@ -0,0 +1,27 @@ +# 审计日志 + +NebulaGraph 的审计日志功能可以将 Graph 服务接受到的所有操作进行分类存储，Dashboard 可以快速查看审计日志。 + +!!! enterpriseonly + + 仅企业版 NebulaGraph 支持审计日志。 + +## 入口 + +1. 在 Dashboard 企业版顶部导航栏，单击**集群管理**。 +2. 单击目标集群右侧**详情**。 +3. 在左侧导航栏，单击**集群信息**->**审计日志**。 + +!!! note + + - 首次使用审计日志，需要根据页面提示跳转到**更新配置**页面开启审计日志。开启后需要重启 Graph 服务。 + - 审计日志参数的说明请参见[设置审计日志](../../..//5.configurations-and-logs/2.log-management/audit-log.md)。 + +## 查看审计日志 + +在页面上方可以筛选服务或搜索日志名称，在操作列单击**查看日志**。 + +- 支持一键复制窗口内所有日志。 +- 支持复制日志文件路径。 +- 支持**行尾模式**和**区间模式**查看日志。设置后需要单击**刷新**。 +- 支持通过关键字（至少 3 个字符）搜索日志。 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md index 9540ef40902..26ce5c5a09f 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md @@ -16,21 +16,21 @@ Dashboard 可以管理指定图空间中的作业，包括查看、停止、恢 ## 查看作业 -选择图空间后，页面会默认展示所有未过期的作业信息。用户可以通过上方筛选框快速查找作业，方法如下： +选择图空间后，页面会默认展示所有未过期的作业信息。用户可以通过上方筛选框快速查找作业。方法如下： -- 选择作业状态进行筛选。状态包括`QUEUE`、`RUNNING`、`FINISHED`、`FAILED`、`STOPPED`。状态说明请参见[作业管理](../../../3.ngql-guide/4.job-statements.md)。 -- 选择时间进行筛选。默认最多可选择 7 天的作业信息进行查看，支持选择时间段，也可以快捷选择最近 12 小时、1 天、3 天、7 天。 -- 选择`作业ID`或`Command`筛选。选择后输入要搜索的内容。 +- 选择作业状态进行筛选。状态包括`QUEUE`、`RUNNING`、`FINISHED`、`FAILED`、`STOPPED`、`SUCCEEDED`。状态说明请参见[作业管理](../../../3.ngql-guide/4.job-statements.md)。 +- 选择时间进行筛选。 +- 选择`作业命令`或`作业 ID`筛选。选择后输入要搜索的内容。 - 页面的作业数据默认不自动更新，可以调整**更新频率**让页面自动更新，也可以单击![setup](https://docs-cdn.nebula-graph.com.cn/figures/refresh-220616.png)按钮手动更新。 -- 在目标作业右侧的`操作`列单击`详情`，可以查看更多详细信息，包括`任务 ID`、`Host`、`错误码`等，还可以停止、重新执行该作业，以及搜索任务 ID。 +- 在目标作业右侧的`操作`列单击`详情`，可以查看更多详细信息，包括`任务 ID`、`Host`、`错误码`等。 ## 停止作业 -在目标作业右侧的`操作`列单击`停止作业`，可以停止状态为`QUEUE`、`RUNNING`、`FAILED`的作业，点击后该作业状态变为`STOPPED`。 +在目标作业右侧的`操作`列单击`停止作业`，可以停止未完成的作业，点击后该作业状态变为`STOPPED`。 ## 重新执行作业 -在目标作业右侧的`操作`列单击`重新执行`，可以重新执行状态为`QUEUE`、`FAILED`、`STOPPED`的作业，点击后该作业状态变为`RUNNING`。 +在目标作业右侧的`操作`列单击`重新执行`，可以重新执行状态为`FAILED`、`STOPPED`的作业，点击后该作业状态变为`RUNNING`。 !!! note diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/runtime-log.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/runtime-log.md new file mode 100644 index 00000000000..e00bca8234a --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/runtime-log.md @@ -0,0 +1,22 @@ +# 运行日志 + +运行日志通常提供给 DBA 或开发人员查看，当系统出现故障，DBA 或开发人员可以根据运行日志定位问题。，Dashboard 可以快速查看运行日志。 + +## 入口 + +1. 在 Dashboard 企业版顶部导航栏，单击**集群管理**。 +2. 单击目标集群右侧**详情**。 +3. 在左侧导航栏，单击**集群信息**->**运行日志**。 + +!!! note + + 运行日志参数的说明请参见[运行日志](../../..//5.configurations-and-logs/2.log-management/logs.md)。 + +## 查看运行日志 + +在页面上方可以筛选服务或搜索日志名称，在操作列单击**查看日志**。 + +- 支持一键复制窗口内所有日志。 +- 支持复制日志文件路径。 +- 支持**行尾模式**和**区间模式**查看日志。设置后需要单击**刷新**。 +- 支持通过关键字（至少 3 个字符）搜索日志。 \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index dcc47a1abbf..733abae0867 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -595,7 +595,9 @@ nav: - 集群信息: - 信息总览: nebula-dashboard-ent/4.cluster-operator/cluster-information/overview-info.md - 集群诊断: nebula-dashboard-ent/4.cluster-operator/cluster-information/cluster-diagnosis.md -# - 集群作业管理: nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md + - 作业管理: nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md + - 审计日志: nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md + - 运行日志: nebula-dashboard-ent/4.cluster-operator/cluster-information/runtime-log.md - 集群操作: - 节点管理: nebula-dashboard-ent/4.cluster-operator/operator/node.md - 扩缩容: nebula-dashboard-ent/4.cluster-operator/operator/scale.md From 41c7c536536c72755313df2c126675a26f42ba89 Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Tue, 17 Jan 2023 15:54:48 +0800 Subject: [PATCH 2/2] Update docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md --- .../4.cluster-operator/cluster-information/audit-log.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md index 36b24dcd941..a482a536f42 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md @@ -23,5 +23,5 @@ NebulaGraph 的审计日志功能可以将 Graph 服务接受到的所有操作 - 支持一键复制窗口内所有日志。 - 支持复制日志文件路径。 -- 支持**行尾模式**和**区间模式**查看日志。设置后需要单击**刷新**。 +- 支持以**行尾模式**和**区间模式**查看日志。设置后需要单击**刷新**。 - 支持通过关键字（至少 3 个字符）搜索日志。