From 1583b066440d4f15956df340bba0a1bd0804838b Mon Sep 17 00:00:00 2001 From: lishaoheng <133954629+gtahoo@users.noreply.github.com> Date: Mon, 15 Jan 2024 10:21:47 +0800 Subject: [PATCH] fix #359: add configuration description for enabling the "Audit Log" module (#377) fix_doc_log Co-authored-by: lishaoheng.lsh --- .../source/5.developer-manual/5.ecosystem-tools/4.log.md | 4 +++- .../source/5.developer-manual/5.ecosystem-tools/4.log.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/en-US/source/5.developer-manual/5.ecosystem-tools/4.log.md b/docs/en-US/source/5.developer-manual/5.ecosystem-tools/4.log.md index 9a5d1d24b1..b05ab1d2b2 100644 --- a/docs/en-US/source/5.developer-manual/5.ecosystem-tools/4.log.md +++ b/docs/en-US/source/5.developer-manual/5.ecosystem-tools/4.log.md @@ -38,4 +38,6 @@ You can also refer to the log macro usage in test/test_lgraph_log.cpp. ## 3.Audit log -Audit logs record each request and response, as well as the user who sent the request and when the request received. Audit logging can only be turned on or off. The results can be queried using the TuGraph visualization tool and the REST API. \ No newline at end of file +Audit logs record each request and response, as well as the user who sent the request and when the request received. Audit logging can only be turned on or off. The results can be queried using the TuGraph visualization tool and the REST API. + +To enable the Audit Log, you need to set the `enable_audit_log` parameter to `true` in the configuration file. For the configuration file and parameter descriptions, see:[Tugraph Running/Service configuration](../2.running/2.tugraph-running.md/#4service-configuration) \ No newline at end of file diff --git a/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/4.log.md b/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/4.log.md index 47ae02c925..71b875ddb2 100644 --- a/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/4.log.md +++ b/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/4.log.md @@ -38,4 +38,6 @@ void LogExample() { ## 3.审计日志 -审核日志记录每个请求和响应，以及发送请求的用户以及收到请求的时间。审核日志只能是打开或关闭状态。可以使用 TuGraph 可视化工具和 REST API 查询结果。 \ No newline at end of file +审核日志记录每个请求和响应，以及发送请求的用户以及收到请求的时间。审核日志只能是打开或关闭状态。可以使用 TuGraph 可视化工具和 REST API 查询结果。 + +开启审计日志需要在配置文件中将`enable_audit_log`参数设置为`true`。配置文件和配置参数说明详见：[数据库运行/服务配置](../2.running/2.tugraph-running.md/#4服务配置)。 \ No newline at end of file