From 73f3c7f72491b6a06b5f834874a1e04d9005d1cf Mon Sep 17 00:00:00 2001 From: Leto_b Date: Wed, 8 Apr 2026 11:05:43 +0800 Subject: [PATCH] add note about slow query in auditlog --- 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 +++++ .../UserGuide/Master/Table/User-Manual/Audit-Log_timecho.md | 3 +++ .../UserGuide/Master/Tree/User-Manual/Audit-Log_timecho.md | 4 ++++ .../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 b8f079768..c4d06e6c1 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 3004fd1e6..39c68b7ec 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 b8fb96cb7..4020434ef 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 a5695ec55..d6006290d 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 06a3ddd7f..e8adddc86 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 b63fc4c44..4897871d2 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 0f727c4ec..2e6615ed2 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 323399afc..cfc2e0fe0 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 直接阅读、获取审计日志相关信息。