You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ha...@apache.org on 2026/04/10 04:10:39 UTC
(iotdb-docs) branch main updated: add note about slow query in auditlog (#1063)
This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iotdb-docs.git
The following commit(s) were added to refs/heads/main by this push:
new d4efe240 add note about slow query in auditlog (#1063)
d4efe240 is described below
commit d4efe240e379b8c3c1bf54b060bbd0b8053ffddf
Author: leto-b <bi...@timecho.com>
AuthorDate: Fri Apr 10 12:10:33 2026 +0800
add note about slow query in auditlog (#1063)
---
src/UserGuide/Master/Table/User-Manual/Audit-Log_timecho.md | 5 +++++
src/UserGuide/Master/Tree/User-Manual/Audit-Log_timecho.md | 4 ++++
src/UserGuide/latest-Table/User-Manual/Audit-Log_timecho.md | 5 +++++
src/UserGuide/latest/User-Manual/Audit-Log_timecho.md | 5 +++++
src/zh/UserGuide/Master/Table/User-Manual/Audit-Log_timecho.md | 3 +++
src/zh/UserGuide/Master/Tree/User-Manual/Audit-Log_timecho.md | 4 ++++
src/zh/UserGuide/latest-Table/User-Manual/Audit-Log_timecho.md | 3 +++
src/zh/UserGuide/latest/User-Manual/Audit-Log_timecho.md | 4 ++++
8 files changed, 33 insertions(+)
diff --git a/src/UserGuide/Master/Table/User-Manual/Audit-Log_timecho.md b/src/UserGuide/Master/Table/User-Manual/Audit-Log_timecho.md
index b8f07976..c4d06e6c 100644
--- a/src/UserGuide/Master/Table/User-Manual/Audit-Log_timecho.md
+++ b/src/UserGuide/Master/Table/User-Manual/Audit-Log_timecho.md
@@ -70,6 +70,11 @@ Edit the `iotdb-system.properties` file to enable audit logging using the follow
| `audit_log_batch_interval_in_ms` | Batch write interval for audit logs | Long | 1000 | Hot Reload |
| `audit_log_batch_max_queue_bytes` | Maximum byte size of the queue for batch processing audit logs. Subsequent write operations will be blocked when this threshold is exceeded. | Long | 268435456 | Hot Reload |
+**Instructions for Object Authentication and Slow Operations:**
+- When the parameters `auditable_dml_event_type`, `auditable_ddl_event_type`, `auditable_query_event_type`, or `auditable_control_event_type` are set to `OBJECT_AUTHENTICATION`, the corresponding event types will be recorded in the audit log.
+- When the parameters `auditable_dml_event_type`, `auditable_ddl_event_type`, `auditable_query_event_type`, or `auditable_control_event_type` are set to `SLOW_OPERATION`, only the corresponding event types whose execution time exceeds the value of the `slow_query_threshold` parameter (default: 3000 ms) will be recorded in the audit log. The value of the `slow_query_threshold` parameter can be configured in the `iotdb-system.properties` file.
+
+
## 3. Access Methods
Supports direct reading of audit logs via SQL.
diff --git a/src/UserGuide/Master/Tree/User-Manual/Audit-Log_timecho.md b/src/UserGuide/Master/Tree/User-Manual/Audit-Log_timecho.md
index 3004fd1e..39c68b7e 100644
--- a/src/UserGuide/Master/Tree/User-Manual/Audit-Log_timecho.md
+++ b/src/UserGuide/Master/Tree/User-Manual/Audit-Log_timecho.md
@@ -70,6 +70,10 @@ Edit the `iotdb-system.properties` file to enable audit logging using the follow
| `audit_log_batch_interval_in_ms` | Batch write interval for audit logs | Long | 1000 | Hot Reload |
| `audit_log_batch_max_queue_bytes` | Maximum byte size of the queue for batch processing audit logs. Subsequent write operations will be blocked when this threshold is exceeded. | Long | 268435456 | Hot Reload |
+**Instructions for Object Authentication and Slow Operations:**
+- When the parameters `auditable_dml_event_type`, `auditable_ddl_event_type`, `auditable_query_event_type`, or `auditable_control_event_type` are set to `OBJECT_AUTHENTICATION`, the corresponding event types will be recorded in the audit log.
+- When the parameters `auditable_dml_event_type`, `auditable_ddl_event_type`, `auditable_query_event_type`, or `auditable_control_event_type` are set to `SLOW_OPERATION`, only the corresponding event types whose execution time exceeds the value of the `slow_query_threshold` parameter (default: 3000 ms) will be recorded in the audit log. The value of the `slow_query_threshold` parameter can be configured in the `iotdb-system.properties` file.
+
## 3. Access Methods
Supports direct reading of audit logs via SQL.
diff --git a/src/UserGuide/latest-Table/User-Manual/Audit-Log_timecho.md b/src/UserGuide/latest-Table/User-Manual/Audit-Log_timecho.md
index b8fb96cb..4020434e 100644
--- a/src/UserGuide/latest-Table/User-Manual/Audit-Log_timecho.md
+++ b/src/UserGuide/latest-Table/User-Manual/Audit-Log_timecho.md
@@ -69,6 +69,11 @@ Edit the `iotdb-system.properties` file to enable audit logging using the follow
| `audit_log_batch_interval_in_ms` | Batch write interval for audit logs | Long | 1000 | Hot Reload |
| `audit_log_batch_max_queue_bytes` | Maximum byte size of the queue for batch processing audit logs. Subsequent write operations will be blocked when this threshold is exceeded. | Long | 268435456 | Hot Reload |
+**Instructions for Object Authentication and Slow Operations:**
+- When the parameters `auditable_dml_event_type`, `auditable_ddl_event_type`, `auditable_query_event_type`, or `auditable_control_event_type` are set to `OBJECT_AUTHENTICATION`, the corresponding event types will be recorded in the audit log.
+- When the parameters `auditable_dml_event_type`, `auditable_ddl_event_type`, `auditable_query_event_type`, or `auditable_control_event_type` are set to `SLOW_OPERATION`, only the corresponding event types whose execution time exceeds the value of the `slow_query_threshold` parameter (default: 3000 ms) will be recorded in the audit log. The value of the `slow_query_threshold` parameter can be configured in the `iotdb-system.properties` file.
+
+
## 3. Access Methods
Supports direct reading of audit logs via SQL.
diff --git a/src/UserGuide/latest/User-Manual/Audit-Log_timecho.md b/src/UserGuide/latest/User-Manual/Audit-Log_timecho.md
index a5695ec5..d6006290 100644
--- a/src/UserGuide/latest/User-Manual/Audit-Log_timecho.md
+++ b/src/UserGuide/latest/User-Manual/Audit-Log_timecho.md
@@ -68,6 +68,11 @@ Edit the `iotdb-system.properties` file to enable audit logging using the follow
| `audit_log_batch_interval_in_ms` | Batch write interval for audit logs | Long | 1000 | Hot Reload |
| `audit_log_batch_max_queue_bytes` | Maximum byte size of the queue for batch processing audit logs. Subsequent write operations will be blocked when this threshold is exceeded. | Long | 268435456 | Hot Reload |
+**Instructions for Object Authentication and Slow Operations:**
+- When the parameters `auditable_dml_event_type`, `auditable_ddl_event_type`, `auditable_query_event_type`, or `auditable_control_event_type` are set to `OBJECT_AUTHENTICATION`, the corresponding event types will be recorded in the audit log.
+- When the parameters `auditable_dml_event_type`, `auditable_ddl_event_type`, `auditable_query_event_type`, or `auditable_control_event_type` are set to `SLOW_OPERATION`, only the corresponding event types whose execution time exceeds the value of the `slow_query_threshold` parameter (default: 3000 ms) will be recorded in the audit log. The value of the `slow_query_threshold` parameter can be configured in the `iotdb-system.properties` file.
+
+
## 3. Access Methods
Supports direct reading of audit logs via SQL.
diff --git a/src/zh/UserGuide/Master/Table/User-Manual/Audit-Log_timecho.md b/src/zh/UserGuide/Master/Table/User-Manual/Audit-Log_timecho.md
index 06a3ddd7..e8adddc8 100644
--- a/src/zh/UserGuide/Master/Table/User-Manual/Audit-Log_timecho.md
+++ b/src/zh/UserGuide/Master/Table/User-Manual/Audit-Log_timecho.md
@@ -70,6 +70,9 @@
| `audit_log_batch_interval_in_ms` | 审计日志批量写入的时间间隔 | Long | 1000 | 热加载 |
| `audit_log_batch_max_queue_bytes` | 用于批量处理审计日志的队列最大字节数。当队列大小超过此值时，后续的写入操作将被阻塞。 | Long | 268435456 | 热加载 |
+**关于对象鉴权和慢操作的说明：**
+* 当 `auditable_dml_event_type` 、`auditable_ddl_event_type`、`auditable_query_event_type`、`auditable_control_event_type` 参数值设置为 `OBJECT_AUTHENTICATION`（对象鉴权）时，则对应的事件类型会被记录审计日志。
+* 当 `auditable_dml_event_type` 、`auditable_ddl_event_type`、`auditable_query_event_type`、`auditable_control_event_type` 参数值设置为 `SLOW_OPERATION`（慢操作），则操作时间大于 `slow_query_threshold` 参数值（默认 3000 ms）的对应事件类型才会被记录审计日志。`slow_query_threshold` 参数值可通过 iotdb-system.properties 文件进行配置。
## 3. 查阅方法
diff --git a/src/zh/UserGuide/Master/Tree/User-Manual/Audit-Log_timecho.md b/src/zh/UserGuide/Master/Tree/User-Manual/Audit-Log_timecho.md
index b63fc4c4..4897871d 100644
--- a/src/zh/UserGuide/Master/Tree/User-Manual/Audit-Log_timecho.md
+++ b/src/zh/UserGuide/Master/Tree/User-Manual/Audit-Log_timecho.md
@@ -70,6 +70,10 @@
| `audit_log_batch_interval_in_ms` | 审计日志批量写入的时间间隔 | Long | 1000 | 热加载 |
| `audit_log_batch_max_queue_bytes` | 用于批量处理审计日志的队列最大字节数。当队列大小超过此值时，后续的写入操作将被阻塞。 | Long | 268435456 | 热加载 |
+**关于对象鉴权和慢操作的说明：**
+* 当 `auditable_dml_event_type` 、`auditable_ddl_event_type`、`auditable_query_event_type`、`auditable_control_event_type` 参数值设置为 `OBJECT_AUTHENTICATION`（对象鉴权）时，则对应的事件类型会被记录审计日志。
+* 当 `auditable_dml_event_type` 、`auditable_ddl_event_type`、`auditable_query_event_type`、`auditable_control_event_type` 参数值设置为 `SLOW_OPERATION`（慢操作），则操作时间大于 `slow_query_threshold` 参数值（默认 3000 ms）的对应事件类型才会被记录审计日志。`slow_query_threshold` 参数值可通过 iotdb-system.properties 文件进行配置。
+
## 3. 查阅方法
支持通过 SQL 直接阅读、获取审计日志相关信息。
diff --git a/src/zh/UserGuide/latest-Table/User-Manual/Audit-Log_timecho.md b/src/zh/UserGuide/latest-Table/User-Manual/Audit-Log_timecho.md
index 0f727c4e..2e6615ed 100644
--- a/src/zh/UserGuide/latest-Table/User-Manual/Audit-Log_timecho.md
+++ b/src/zh/UserGuide/latest-Table/User-Manual/Audit-Log_timecho.md
@@ -70,6 +70,9 @@
| `audit_log_batch_interval_in_ms` | 审计日志批量写入的时间间隔 | Long | 1000 | 热加载 |
| `audit_log_batch_max_queue_bytes` | 用于批量处理审计日志的队列最大字节数。当队列大小超过此值时，后续的写入操作将被阻塞。 | Long | 268435456 | 热加载 |
+**关于对象鉴权和慢操作的说明：**
+* 当 `auditable_dml_event_type` 、`auditable_ddl_event_type`、`auditable_query_event_type`、`auditable_control_event_type` 参数值设置为 `OBJECT_AUTHENTICATION`（对象鉴权）时，则对应的事件类型会被记录审计日志。
+* 当 `auditable_dml_event_type` 、`auditable_ddl_event_type`、`auditable_query_event_type`、`auditable_control_event_type` 参数值设置为 `SLOW_OPERATION`（慢操作），则操作时间大于 `slow_query_threshold` 参数值（默认 3000 ms）的对应事件类型才会被记录审计日志。`slow_query_threshold` 参数值可通过 iotdb-system.properties 文件进行配置。
## 3. 查阅方法
diff --git a/src/zh/UserGuide/latest/User-Manual/Audit-Log_timecho.md b/src/zh/UserGuide/latest/User-Manual/Audit-Log_timecho.md
index 323399af..cfc2e0fe 100644
--- a/src/zh/UserGuide/latest/User-Manual/Audit-Log_timecho.md
+++ b/src/zh/UserGuide/latest/User-Manual/Audit-Log_timecho.md
@@ -70,6 +70,10 @@
| `audit_log_batch_interval_in_ms` | 审计日志批量写入的时间间隔 | Long | 1000 | 热加载 |
| `audit_log_batch_max_queue_bytes` | 用于批量处理审计日志的队列最大字节数。当队列大小超过此值时，后续的写入操作将被阻塞。 | Long | 268435456 | 热加载 |
+**关于对象鉴权和慢操作的说明：**
+* 当 `auditable_dml_event_type` 、`auditable_ddl_event_type`、`auditable_query_event_type`、`auditable_control_event_type` 参数值设置为 `OBJECT_AUTHENTICATION`（对象鉴权）时，则对应的事件类型会被记录审计日志。
+* 当 `auditable_dml_event_type` 、`auditable_ddl_event_type`、`auditable_query_event_type`、`auditable_control_event_type` 参数值设置为 `SLOW_OPERATION`（慢操作），则操作时间大于 `slow_query_threshold` 参数值（默认 3000 ms）的对应事件类型才会被记录审计日志。`slow_query_threshold` 参数值可通过 iotdb-system.properties 文件进行配置。
+
## 3. 查阅方法
支持通过 SQL 直接阅读、获取审计日志相关信息。