Merge pull request #3954 from manticoresoftware/vacuum_spaces

feat: skip extra spaces for JSONs in query log

Author: klirichek

.translation-cache/Logging/Query_logging.md.json

@@ -3,7 +3,7 @@
 <!-- example query_logging -->
 可以通过在配置文件的 searchd 部分设置 [query_log](../Server_settings/Searchd.md#query_log) 指令来启用查询日志。
 
-查询也可以通过设置 `syslog`（而不是文件路径）发送到 syslog。在这种情况下，所有搜索查询将以 `LOG_INFO` 优先级发送到 syslog 守护进程，前缀为 `[query]`，而不是时间戳。syslog 仅支持 `plain` 日志格式。
+也可以通过将 `syslog` 设置为文件路径来将查询发送到 syslog。在这种情况下，所有搜索查询将以 `LOG_INFO` 优先级发送到 syslog 守护进程，前缀为 `[query]` 而不是时间戳。syslog 仅支持 `plain` 日志格式。
 
 <!-- intro -->
 `query_log` 示例：
@@ -22,15 +22,15 @@ searchd {
 ## 日志格式
 
 支持两种查询日志格式：
-* `sphinxql`（默认）：以 SQL 格式记录日志。它还提供了一种轻松重放已记录查询的方法。
-* `plain`：以简单文本格式记录全文查询。若大多数查询主要是全文查询，或者不需要记录非全文组件（如按属性过滤、排序或分组），推荐使用此格式。以 `plain` 格式记录的查询无法重放。请注意，通过 [Buddy](../Installation/Manticore_Buddy.md) 处理的查询不会在此模式下记录。
+* `sphinxql`（默认）：以 SQL 格式记录日志。它还提供了一种便捷方式来重放已记录的查询。
+* `plain`：以简单文本格式记录全文查询。建议在大多数查询主要为全文查询或不需要记录非全文组件（例如按属性过滤、排序或分组）的情况下使用此格式。以 `plain` 格式记录的查询无法重放。请注意，通过 [Buddy](../Installation/Manticore_Buddy.md) 处理的查询在此模式下不会被记录。
 
-要切换格式，可以使用 searchd 设置 [query_log_format](../Server_settings/Searchd.md#query_log_format)。
+要在格式之间切换，可以使用 searchd 设置中的 [query_log_format](../Server_settings/Searchd.md#query_log_format)。
 
 ### SQL 日志格式
 
 <!-- example sphixql_log -->
-SQL 日志格式是默认设置。在此模式下，Manticore 记录所有成功和失败的 select 查询。以 SQL 或二进制 API 发送的请求以 SQL 格式记录，但 JSON 查询按原样记录。此类日志仅适用于普通日志文件，不支持使用 'syslog' 服务记录。
+SQL 日志格式是默认设置。在此模式下，Manticore 会记录所有成功和失败的 select 查询。以 SQL 或通过二进制 API 发送的请求以 SQL 格式记录，但 JSON 查询按原样记录。此类日志仅适用于普通日志文件，不支持用于日志的 'syslog' 服务。
 
 <!-- intro -->
 `query_log_format` 示例：
@@ -42,39 +42,29 @@ query_log_format = sphinxql # default
 <!-- end -->
 
 <!-- example sphixql_log2 -->
-与[plain 格式](../Logging/Query_logging.md#Plain-log-format)相比，Manticore SQL 日志格式的特点包括：
+相比于[plain 格式](../Logging/Query_logging.md#Plain-log-format)，Manticore SQL 日志格式的特性包括：
 * 尽可能记录完整的语句数据。
 * 记录错误和警告。
-* 查询日志可以重放。
-* 记录额外的性能计数器（当前为每个代理的分布式查询时间）。
-* 每条日志条目都是有效的 Manticore SQL/JSON 语句，可重构完整请求，除非记录的请求过大，为性能考虑需要缩短。
-* JSON 请求及附加消息、计数器等以注释形式记录。
+* 查询日志可被重放。
+* 记录额外的性能计数器（目前为每个代理的分布式查询时间）。
+* 每条日志条目都是有效的 Manticore SQL/JSON 语句，可重建完整请求，除非被记录的请求过大，出于性能原因需要缩短。
+* JSON 请求作为注释记录，跳过元素之间的多余空白。
+* 额外消息、计数器等作为注释记录。
 
 <!-- intro -->
 `sphinxql` 日志条目示例：
 <!-- request Example -->
 ```sql
 /* Sun Apr 28 12:38:02.808 2024 conn 2 (127.0.0.1:53228) real 0.000 wall 0.000 found 0 */ SELECT * FROM test WHERE MATCH('test') OPTION ranker=proximity;
 /* Sun Apr 28 12:38:05.585 2024 conn 2 (127.0.0.1:53228) real 0.001 wall 0.001 found 0 */ SELECT * FROM test WHERE MATCH('test') GROUP BY channel_id OPTION ranker=proximity;
-/* Sun Apr 28 12:40:57.366 2024 conn 4 (127.0.0.1:53256) real 0.000 wall 0.000 found 0 */  /*{
-    "table" : "test",
-    "query":
-    {
-        "match":
-        {
-            "*" : "test"
-        }
-    },
-    "_source": ["f"],
-    "limit": 30
-} */
+/* Sun Apr 28 12:40:57.366 2024 conn 4 (127.0.0.1:53256) real 0.000 wall 0.000 found 0 */  /*{ "index" : "test", "query": { "match": { "*" : "test" } }, "_source": ["f"], "limit": 30 } */
 ```
 <!-- end -->
 
 ### Plain 日志格式
 
 <!-- example plain_log -->
-使用 `plain` 日志格式时，Manticore 以简单文本格式记录所有成功执行的搜索查询。查询的非全文部分不被记录。JSON 查询以单行条目记录。通过 [Buddy](../Installation/Manticore_Buddy.md) 处理的查询不会被记录。
+使用 `plain` 日志格式时，Manticore 以简单文本格式记录所有成功执行的搜索查询。查询的非全文部分不会被记录。JSON 查询以单行条目记录。通过 [Buddy](../Installation/Manticore_Buddy.md) 处理的查询不会被记录。
 
 <!-- intro -->
 `query_log_format` 示例：
@@ -92,27 +82,27 @@ query_log_format = plain
 ```
 
 其中：
-* `real-time` 是查询从开始到结束的时间。
+* `real-time` 是从查询开始到结束的时间。
 * `wall-time` 类似于 real-time，但不包括等待代理和合并代理结果集的时间。
-* `perf-stats` 包含 CPU/IO 统计信息，当 Manticore 以 `--cpustats` 启动（或通过 `SET GLOBAL cpustats=1` 启用）和/或 `--iostats` 启动（或通过 `SET GLOBAL iostats=1` 启用）时：
-  - `ios` 是执行的文件 I/O 操作次数；
+* `perf-stats` 包含当 Manticore 用 `--cpustats`（或通过 `SET GLOBAL cpustats=1` 启用）和/或 `--iostats`（或通过 `SET GLOBAL iostats=1` 启用）启动时的 CPU/IO 统计信息：
+  - `ios` 是完成的文件 I/O 操作次数；
   - `kb` 是从表文件读取的数据量（千字节）；
-  - `ms` 是 I/O 操作所花费的时间。
-  - `cpums` 是处理查询时 CPU 花费的毫秒数。
-* `match-mode` 可以是以下值之一：
-  - "all" 表示 `SPH_MATCH_ALL` 模式；
-  - "any" 表示 `SPH_MATCH_ANY` 模式；
-  - "phr" 表示 `SPH_MATCH_PHRASE` 模式；
-  - "bool" 表示 `SPH_MATCH_BOOLEAN` 模式；
-  - "ext" 表示 `SPH_MATCH_EXTENDED` 模式；
-  - "ext2" 表示 `SPH_MATCH_EXTENDED2` 模式；
-  - "scan" 表示使用了全扫描模式，可能是通过 `SPH_MATCH_FULLSCAN` 指定，或查询为空。
-* `sort-mode` 可以是以下值之一：
-  - "rel" 表示 `SPH_SORT_RELEVANCE` 模式；
-  - "attr-" 表示 `SPH_SORT_ATTR_DESC` 模式；
-  - "attr+" 表示 `SPH_SORT_ATTR_ASC` 模式；
-  - "tsegs" 表示 `SPH_SORT_TIME_SEGMENTS` 模式；
-  - "ext" 表示 `SPH_SORT_EXTENDED` 模式。
+  - `ms` 是用于 I/O 操作的时间。
+  - `cpums` 是处理查询所用的 CPU 时间（毫秒）。
+* `match-mode` 可以是以下之一：
+  - “all” 代表 `SPH_MATCH_ALL` 模式；
+  - “any” 代表 `SPH_MATCH_ANY` 模式；
+  - “phr” 代表 `SPH_MATCH_PHRASE` 模式；
+  - “bool” 代表 `SPH_MATCH_BOOLEAN` 模式；
+  - “ext” 代表 `SPH_MATCH_EXTENDED` 模式；
+  - “ext2” 代表 `SPH_MATCH_EXTENDED2` 模式；
+  - “scan” 如果使用了全扫描模式，或通过 `SPH_MATCH_FULLSCAN` 指定，或查询为空。
+* `sort-mode` 可以是以下之一：
+  - “rel” 代表 `SPH_SORT_RELEVANCE` 模式；
+  - “attr-” 代表 `SPH_SORT_ATTR_DESC` 模式；
+  - “attr+” 代表 `SPH_SORT_ATTR_ASC` 模式；
+  - “tsegs” 代表 `SPH_SORT_TIME_SEGMENTS` 模式；
+  - “ext” 代表 `SPH_SORT_EXTENDED` 模式。
 
 注意：`SPH*` 模式特指 `sphinx` 旧接口。SQL 和 JSON 接口在大多数情况下会记录 `ext2` 作为 `match-mode`，以及 `ext` 和 `rel` 作为 `sort-mode`。
 
@@ -132,7 +122,7 @@ query_log_format = plain
 ## 仅记录慢查询
 
 <!-- example query_log_min_msec -->
-默认情况下，所有查询都会被记录。如果只想记录执行时间超过指定限制的查询，可以使用 `query_log_min_msec` 指令。
+默认情况下，会记录所有查询。如果只想记录执行时间超过指定限制的查询，可以使用 `query_log_min_msec` 指令。
 
 预期的单位是毫秒，但也可以使用时间后缀表达式。
 
@@ -154,7 +144,7 @@ searchd {
 ## 日志文件权限模式
 
 <!-- Example query_log_mode -->
-默认情况下，searchd 和查询日志文件的权限为 `600`，因此只有运行 Manticore 的用户和 `root` 可以读取日志文件。`query_log_mode` 选项允许设置不同的权限。这对于允许其他用户读取日志文件（例如，运行在非 root 用户下的监控解决方案）很有帮助。
+默认情况下，searchd 和查询日志文件的权限为 `600`，因此只有运行 Manticore 的用户和 `root` 可以读取日志文件。`query_log_mode` 选项允许设置不同的权限。这有助于允许其他用户读取日志文件（例如，运行在非 root 用户下的监控解决方案）。
 
 <!-- intro -->
 `query_log_mode` 示例：

manual/chinese/Logging/Query_logging.md

@@ -48,26 +48,16 @@ The features of the Manticore SQL log format compared to the [plain format](../L
 * The query log can be replayed.
 * Additional performance counters (currently, per-agent distributed query times) are logged.
 * Each log entry is a valid Manticore SQL/JSON statement that reconstructs the full request, except if the logged request is too large and needs to be shortened for performance reasons.
-* JSON requests and additional messages, counters, etc., are logged as comments.
+* JSON requests are logged as comments, skipping extra whitespaces between elements. 
+* Additional messages, counters, etc., are logged as comments.
 
 <!-- intro -->
 `sphinxql` log entries example:
 <!-- request Example -->
 ```sql
 /* Sun Apr 28 12:38:02.808 2024 conn 2 (127.0.0.1:53228) real 0.000 wall 0.000 found 0 */ SELECT * FROM test WHERE MATCH('test') OPTION ranker=proximity;
 /* Sun Apr 28 12:38:05.585 2024 conn 2 (127.0.0.1:53228) real 0.001 wall 0.001 found 0 */ SELECT * FROM test WHERE MATCH('test') GROUP BY channel_id OPTION ranker=proximity;
-/* Sun Apr 28 12:40:57.366 2024 conn 4 (127.0.0.1:53256) real 0.000 wall 0.000 found 0 */  /*{
-    "table" : "test",
-    "query":
-    {
-        "match":
-        {
-            "*" : "test"
-        }
-    },
-    "_source": ["f"],
-    "limit": 30
-} */
+/* Sun Apr 28 12:40:57.366 2024 conn 4 (127.0.0.1:53256) real 0.000 wall 0.000 found 0 */  /*{ "index" : "test", "query": { "match": { "*" : "test" } }, "_source": ["f"], "limit": 30 } */
 ```
 <!-- end -->