system.query_log

在 ClickHouse Cloud 中进行查询

该系统表中的数据保存在 ClickHouse Cloud 中每个节点的本地。因此，如需获得所有数据的完整视图，需要使用 clusterAllReplicas 函数。更多详情请参阅此处。

存储已执行查询的元数据和统计信息，例如开始时间、持续时间、错误消息、资源使用情况以及其他执行细节。它不会存储查询结果。

可以在服务器配置的 query_log 部分更改查询日志记录相关设置。

可以通过将 log_queries 设置为 0 来禁用查询日志记录。不建议关闭日志记录，因为此表中的信息对于排查问题非常重要。

数据刷新周期由服务器设置中 query_log 部分的 flush_interval_milliseconds 参数控制。要强制刷新，请使用 SYSTEM FLUSH LOGS 查询。

ClickHouse 不会自动从该表中删除数据。更多详情参见简介。

system.query_log 表会记录两类查询：

由客户端直接运行的初始查询。
由其他查询发起的子查询（用于分布式查询执行）。对于此类查询，有关父查询的信息会显示在 initial_* 列中。

每个查询会在 query_log 表中创建一行或两行记录，具体取决于查询的状态（参见 type 列）：

如果查询执行成功，则会创建两条类型为 QueryStart 和 QueryFinish 的记录。
如果在查询处理期间发生错误，则会创建两条类型为 QueryStart 和 ExceptionWhileProcessing 的记录。
如果在启动查询之前发生错误，则会创建一条类型为 ExceptionBeforeStart 的记录。

可以使用 log_queries_probability 设置来减少记录到 query_log 表中的查询数量。

可以使用 log_formatted_queries 设置将格式化后的查询记录到 formatted_query 列中。

列

hostname (LowCardinality(String)) — 执行查询的服务器主机名。
type (Enum8) — 执行查询时发生的事件类型。取值：
- 'QueryStart' = 1 — 成功开始执行查询。
- 'QueryFinish' = 2 — 成功结束查询执行。
- 'ExceptionBeforeStart' = 3 — 在开始执行查询前发生异常。
- 'ExceptionWhileProcessing' = 4 — 在查询执行过程中发生异常。
event_date (Date) — 查询起始日期。
event_time (DateTime) — 查询的开始时间。
event_time_microseconds (DateTime64) — 查询开始时间，微秒级精度。
query_start_time (DateTime) — 查询开始执行的时间。
query_start_time_microseconds (DateTime64) — 查询执行的开始时间，具有微秒级精度。
query_duration_ms (UInt64) — 查询执行耗时，单位为毫秒。
read_rows (UInt64) — 在查询中，从所有参与的表和表函数读取的总行数。它包括普通子查询以及用于 IN 和 JOIN 的子查询。对于分布式查询，read_rows 包含在所有副本上读取的行总数。每个副本都会发送自己的 read_rows 值，查询的发起服务器会汇总所有接收到的值和本地值。缓存的使用情况不会影响该值。
read_bytes (UInt64) — 从参与查询的所有表和表函数中读取的字节总数。包括普通子查询，以及用于 IN 和 JOIN 的子查询。对于分布式查询，read_bytes 包含在所有副本上读取的字节总数。每个副本会发送自己的 read_bytes 值，发起查询的服务器会汇总所有接收到的值以及本地的值。缓存中的数据量不会影响该值。
written_rows (UInt64) — 对于 INSERT 查询，表示写入的行数。对于其他查询，该列的值为 0。`
written_bytes (UInt64) — 对于 INSERT 查询，表示写入的未压缩字节数。对于其他查询，该列的值为 0。
result_rows (UInt64) — SELECT 查询结果中的行数，或 INSERT 查询写入的行数。
result_bytes (UInt64) — 在 RAM 中存储查询结果所占用的字节数。
memory_usage (UInt64) — 查询的内存使用量。
current_database (String) — 当前数据库的名称。
query (String) — 查询语句字符串。
formatted_query (String) — 格式化查询字符串。
normalized_query_hash (UInt64) — 一个数值哈希值，使得仅在字面量取值上不同的查询具有相同的值。
query_kind (LowCardinality(String)) — 查询类型。
databases (Array(LowCardinality(String))) — 查询中出现的数据库名称。
tables (Array(LowCardinality(String))) — 查询中涉及的表名。
columns (Array(LowCardinality(String))) — 查询中出现的列的名称。
partitions (Array(LowCardinality(String))) — 查询中包含的分区名称。
projections (String) — 查询执行期间使用的投影名称。
views (Array(LowCardinality(String))) — 查询中出现的（物化或实时）视图名称。
exception_code (Int32) — 异常代码。
exception (String) — 异常信息。
stack_trace (String) — 堆栈跟踪。如果查询成功完成，则该字段为空字符串。
is_initial_query (UInt8) — 查询类型。可能的取值如下：
- 1 — 查询由客户端发起。
- 0 — 查询作为分布式查询执行的一部分，由另一条查询语句发起。
user (String) — 发起当前查询的用户名。`
query_id (String) — 查询 ID。
address (IPv6) — 用于执行该查询的 IP 地址。
port (UInt16) — 客户端用于发出该查询的端口。
initial_user (String) — 执行初始查询的用户名称（用于分布式查询执行）。
initial_query_id (String) — 初始查询的 ID（在分布式查询执行中）。
initial_address (IPv6) — 父查询发起时的 IP 地址。
initial_port (UInt16) — 用于发起父查询的客户端端口。
initial_query_start_time (DateTime) — 分布式查询执行时的初始查询开始时间。
initial_query_start_time_microseconds (DateTime64) — 初始查询开始时间，精度为微秒（在分布式查询执行中使用）。
interface (UInt8) — 发起该查询的接口。可能的取值：
- 1 — TCP。
- 2 — HTTP。
os_user (String) — 运行 clickhouse-client 的操作系统用户名。
client_hostname (String) — 客户端所在机器的主机名，即运行 clickhouse-client 或其他 TCP 客户端的主机名。
client_name (String) — clickhouse-client 或其他 TCP 客户端的名称。
client_revision (UInt32) — clickhouse-client 或其他 TCP 客户端的修订版本号。
client_version_major (UInt32) — clickhouse-client 或其他 TCP 客户端的主版本号。
client_version_minor (UInt32) — clickhouse-client 或其他 TCP 客户端的次要版本号。
client_version_patch (UInt32) — clickhouse-client 或其他 TCP 客户端版本的补丁号部分。
script_query_number (UInt32) — 在包含多个查询的脚本中，用于 clickhouse-client 的查询编号。
script_line_number (UInt32) — 在包含多个查询的脚本中，该查询在脚本中的起始行号，供 clickhouse-client 使用。
http_method (UInt8) — 发起查询的 HTTP 方法。可能的取值如下：
- 0 — 查询通过 TCP 接口发起。
- 1 — 使用了 GET 方法。
- 2 — 使用了 POST 方法。
http_user_agent (String) — 在 HTTP 请求中传递的 HTTP 头 UserAgent。
http_referer (String) — HTTP 首部字段 Referer，在 HTTP 请求中传递（包含发起该请求的页面的完整或部分地址）。
forwarded_for (String) — 在 HTTP 查询中传入的 HTTP 请求头 X-Forwarded-For。
quota_key (String) — 在 quotas 设置中指定的 quota key（参见 keyed）。
revision (UInt32) — ClickHouse 修订版本号。
ProfileEvents (Map(String, UInt64)) — 用于度量不同指标的 ProfileEvents。其详细说明可以在表 system.events 中找到
Settings (Map(String, String)) — 客户端执行查询时被更改的设置。要启用对设置变更的日志记录，请将 log_query_settings 参数设置为 1。
log_comment (String) — 日志备注。可以设置为任意字符串，长度不得超过 max_query_size。如果未定义，则为空字符串。
thread_ids (Array(UInt64)) — 参与查询执行的线程ID。这些线程可能并未同时运行。
peak_threads_usage (UInt64)) — 执行该查询时并发线程的最大数量。
used_aggregate_functions (Array(String)) — 在查询执行过程中所使用的 aggregate functions（聚合函数）的标准名称。
used_aggregate_function_combinators (Array(String)) — 在查询执行过程中使用的 aggregate functions combinators 的规范名称。
used_database_engines (Array(String)) — 在查询执行期间使用的 database engines 的规范名称。
used_data_type_families (Array(String)) — 查询执行期间使用到的 data type families 的规范名称。
used_dictionaries (Array(String)) — 在查询执行期间使用的 dictionaries 的规范名称。对于使用 XML 文件配置的字典，其规范名称为该字典的名称；对于通过 SQL 语句创建的字典，其规范名称为完全限定的对象名称。`
used_formats (Array(String)) — 查询执行期间使用的 formats 的规范名称。`
used_functions (Array(String)) — 在查询执行过程中使用的 functions 的规范名称。
used_storages (Array(String)) — 在查询执行过程中使用的 storages 的规范名称。
used_table_functions (Array(String)) — 在查询执行过程中使用的 table functions 的规范名称。
used_executable_user_defined_functions (Array(String)) — 在查询执行期间使用的“可执行用户自定义函数”（executable user defined functions）的规范名称。
used_sql_user_defined_functions (Array(String)) — 在查询执行过程中使用到的 SQL 用户自定义函数的规范名称。
used_privileges (Array(String)) - 在查询执行过程中成功通过检查的权限。
missing_privileges (Array(String)) - 在查询执行期间缺少的权限。
query_cache_usage (Enum8) — 查询执行期间对 query cache 的使用方式。可能的取值：
- 'Unknown' = 状态未知。
- 'None' = 查询结果既未写入查询缓存，也未从查询缓存读取。
- 'Write' = 查询结果已写入查询缓存。
- 'Read' = 查询结果已从查询缓存读取。

示例

基本示例

SELECT * FROM system.query_log WHERE type = 'QueryFinish' ORDER BY query_start_time DESC LIMIT 1 FORMAT Vertical;

第 1 行:
──────
hostname:                              clickhouse.eu-central1.internal
type:                                  QueryFinish
event_date:                            2021-11-03
event_time:                            2021-11-03 16:13:54
event_time_microseconds:               2021-11-03 16:13:54.953024
query_start_time:                      2021-11-03 16:13:54
query_start_time_microseconds:         2021-11-03 16:13:54.952325
query_duration_ms:                     0
read_rows:                             69
read_bytes:                            6187
written_rows:                          0
written_bytes:                         0
result_rows:                           69
result_bytes:                          48256
memory_usage:                          0
current_database:                      default
query:                                 DESCRIBE TABLE system.query_log
formatted_query:
normalized_query_hash:                 8274064835331539124
query_kind:
databases:                             []
tables:                                []
columns:                               []
projections:                           []
views:                                 []
exception_code:                        0
exception:
stack_trace:
is_initial_query:                      1
user:                                  default
query_id:                              7c28bbbb-753b-4eba-98b1-efcbe2b9bdf6
address:                               ::ffff:127.0.0.1
port:                                  40452
initial_user:                          default
initial_query_id:                      7c28bbbb-753b-4eba-98b1-efcbe2b9bdf6
initial_address:                       ::ffff:127.0.0.1
initial_port:                          40452
initial_query_start_time:              2021-11-03 16:13:54
initial_query_start_time_microseconds: 2021-11-03 16:13:54.952325
interface:                             1
os_user:                               sevirov
client_hostname:                       clickhouse.eu-central1.internal
client_name:                           ClickHouse
client_revision:                       54449
client_version_major:                  21
client_version_minor:                  10
client_version_patch:                  1
http_method:                           0
http_user_agent:
http_referer:
forwarded_for:
quota_key:
revision:                              54456
log_comment:
thread_ids:                            [30776,31174]
ProfileEvents:                         {'Query':1,'NetworkSendElapsedMicroseconds':59,'NetworkSendBytes':2643,'SelectedRows':69,'SelectedBytes':6187,'ContextLock':9,'RWLockAcquiredReadLocks':1,'RealTimeMicroseconds':817,'UserTimeMicroseconds':427,'SystemTimeMicroseconds':212,'OSCPUVirtualTimeMicroseconds':639,'OSReadChars':894,'OSWriteChars':319}
Settings:                              {'load_balancing':'random','max_memory_usage':'10000000000'}
used_aggregate_functions:              []
used_aggregate_function_combinators:   []
used_database_engines:                 []
used_data_type_families:               []
used_dictionaries:                     []
used_formats:                          []
used_functions:                        []
used_storages:                         []
used_table_functions:                  []
used_executable_user_defined_functions:[]
used_sql_user_defined_functions:       []
used_privileges:                       []
missing_privileges:                    []
query_cache_usage:                     None

Cloud 示例

在 ClickHouse Cloud 中，system.query_log 是每个节点上的本地表；要查看所有记录，需要通过 clusterAllReplicas 进行查询。

例如，要汇总 “default” 集群中每个副本的 query_log 记录，可以编写如下查询：

SELECT * 
FROM clusterAllReplicas('default', system.query_log)
WHERE event_time >= now() - toIntervalHour(1)
LIMIT 10
SETTINGS skip_unavailable_shards = 1;

另请参阅

system.query_thread_log — 此表包含关于每个查询执行线程的信息。

列​

示例​

列

示例