`FileLog` 引擎

该引擎允许将应用程序日志文件处理为记录流。

FileLog 让您可以：

订阅日志文件。
处理附加到订阅日志文件的新记录。

创建表

CREATE TABLE [IF NOT EXISTS] [db.]table_name [ON CLUSTER cluster]
(
    name1 [type1] [DEFAULT|MATERIALIZED|ALIAS expr1],
    name2 [type2] [DEFAULT|MATERIALIZED|ALIAS expr2],
    ...
) ENGINE = FileLog('path_to_logs', 'format_name') SETTINGS
    [poll_timeout_ms = 0,]
    [poll_max_batch_size = 0,]
    [max_block_size = 0,]
    [max_threads = 0,]
    [poll_directory_watch_events_backoff_init = 500,]
    [poll_directory_watch_events_backoff_max = 32000,]
    [poll_directory_watch_events_backoff_factor = 2,]
    [handle_error_mode = 'default']

引擎参数：

path_to_logs – 要订阅的日志文件的路径。可以是包含日志文件的目录路径或单个日志文件的路径。请注意，ClickHouse 仅允许路径在 user_files 目录内。
format_name - 记录格式。请注意，FileLog 将文件中的每一行作为单独的记录进行处理，并非所有数据格式都适合它。

可选参数：

poll_timeout_ms - 从日志文件进行单次轮询的超时。默认值: stream_poll_timeout_ms.
poll_max_batch_size — 单次轮询中要轮询的最大记录数。默认值: max_block_size.
max_block_size — 轮询的最大批处理大小（以记录为单位）。默认值: max_insert_block_size.
max_threads - 解析文件的最大线程数，默认值为 0，表示数量将是 max(1, physical_cpu_cores / 4)。
poll_directory_watch_events_backoff_init - 监视目录线程的初始休眠值。默认值: 500。
poll_directory_watch_events_backoff_max - 监视目录线程的最大休眠值。默认值: 32000。
poll_directory_watch_events_backoff_factor - 回退速度，默认是指数形式。默认值: 2。
handle_error_mode — FileLog 引擎的错误处理方式。可能的值：default（如果消息解析失败将抛出异常），stream（异常消息和原始消息将保存在虚拟列 _error 和 _raw_message 中）。

描述

已传递的记录会自动跟踪，因此日志文件中的每条记录只会被计数一次。

SELECT 对于读取记录并不是特别有用（除非用于调试），因为每条记录只能读取一次。建立实时线程使用物化视图更为实用。为此：

使用引擎创建一个 FileLog 表，并将其视为数据流。
创建一个具有所需结构的表。
创建一个物化视图，将来自引擎的数据转换并放入先前创建的表中。

当 MATERIALIZED VIEW 连接引擎时，它会开始在后台收集数据。这使您能够不断接收来自日志文件的记录，并使用 SELECT 将其转换为所需格式。一个 FileLog 表可以拥有任意数量的物化视图，它们不会直接从表中读取数据，而是接收新记录（以块的形式），通过这种方式，您可以向多个表写入不同的细节级别（具有分组 - 聚合和不带分组）。

示例：

CREATE TABLE logs (
  timestamp UInt64,
  level String,
  message String
) ENGINE = FileLog('user_files/my_app/app.log', 'JSONEachRow');

CREATE TABLE daily (
  day Date,
  level String,
  total UInt64
) ENGINE = SummingMergeTree(day, (day, level), 8192);

CREATE MATERIALIZED VIEW consumer TO daily
  AS SELECT toDate(toDateTime(timestamp)) AS day, level, count() AS total
  FROM queue GROUP BY day, level;

SELECT level, sum(total) FROM daily GROUP BY level;

要停止接收流数据或更改转换逻辑，请分离物化视图：

DETACH TABLE consumer;
ATTACH TABLE consumer;

如果您希望通过使用 ALTER 更改目标表，建议禁用物化视图，以避免目标表与视图中的数据之间的不一致。

虚拟列

_filename - 日志文件的名称。数据类型: LowCardinality(String)。
_offset - 日志文件中的偏移量。数据类型: UInt64。

当 handle_error_mode='stream' 时的额外虚拟列：

_raw_record - 无法成功解析的原始记录。数据类型: Nullable(String)。
_error - 解析失败时发生的异常消息。数据类型: Nullable(String)。

注意：_raw_record 和 _error 虚拟列仅在解析期间发生异常时填充，当消息成功解析时，它们始终为 NULL。

创建表​

描述​

虚拟列​

创建表

描述

虚拟列