使用 DISSECT 和 GROK 进行数据处理

编辑

使用 DISSECT 和 GROK 进行数据处理编辑

您的数据可能包含您想要结构化的非结构化字符串。这使得分析数据变得更容易。例如,日志消息可能包含您想要提取的 IP 地址,以便您可以找到最活跃的 IP 地址。

unstructured data

Elasticsearch 可以在索引时间或查询时间结构化您的数据。在索引时间,您可以使用 DissectGrok 摄取处理器,或 Logstash DissectGrok 过滤器。在查询时间,您可以使用 ES|QL DISSECTGROK 命令。

DISSECT 还是 GROK?或者两者都用?编辑

DISSECT 通过使用基于分隔符的模式分解字符串来工作。GROK 的工作原理类似,但使用正则表达式。这使得 GROK 更强大,但通常也更慢。DISSECT 在数据可靠地重复时效果很好。GROK 是您真正需要正则表达式功能时的更好选择,例如,当文本的结构因行而异时。

您可以同时使用 DISSECTGROK 来处理混合用例。例如,当行的某个部分可靠地重复,但整行不重复时。DISSECT 可以解构行中重复的部分。GROK 可以使用正则表达式处理剩余的字段值。

使用 DISSECT 处理数据编辑

DISSECT 处理命令将字符串与基于分隔符的模式匹配,并将指定的键提取为列。

例如,以下模式

%{clientip} [%{@timestamp}] %{status}

匹配这种格式的日志行

1.2.3.4 [2023-01-23T12:15:00.000Z] Connected

并导致将以下列添加到输入表中

clientip:keyword @timestamp:keyword status:keyword

1.2.3.4

2023-01-23T12:15:00.000Z

Connected

Dissect 模式编辑

dissect 模式由字符串中将被丢弃的部分定义。在上一个示例中,要丢弃的第一部分是一个空格。Dissect 找到此空格,然后将 clientip 的值分配给直到该空格之前的所有内容。接下来,dissect 匹配 [],然后将 @timestamp 分配给 [] 之间的所有内容。特别注意要丢弃的字符串部分将有助于构建成功的 dissect 模式。

可以使用空键 (%{}) 或 命名跳过键 来匹配值,但从输出中排除该值。

所有匹配的值都作为关键字字符串数据类型输出。使用 类型转换函数 转换为另一种数据类型。

Dissect 还支持 键修饰符,它们可以更改 dissect 的默认行为。例如,您可以指示 dissect 忽略某些字段、追加字段、跳过填充等。

术语编辑

dissect 模式
描述文本格式的字段和分隔符集。也称为剖析。剖析使用一组 %{} 部分来描述:%{a} - %{b} - %{c}
字段
%{}(包括两者)的文本。
分隔符
} 和下一个 %{ 字符之间的文本。除 %{'not }'} 以外的任何字符集都是分隔符。

%{} 之间的文本,不包括 ?+& 前缀和序数后缀。

示例

  • %{?aaa} - 键是 aaa
  • %{+bbb/3} - 键是 bbb
  • %{&ccc} - 键是 ccc

示例编辑

以下示例解析包含时间戳、一些文本和 IP 地址的字符串

ROW a = "2023-01-23T12:15:00.000Z - some text - 127.0.0.1"
| DISSECT a "%{date} - %{msg} - %{ip}"
| KEEP date, msg, ip
date:keyword msg:keyword ip:keyword

2023-01-23T12:15:00.000Z

一些文本

127.0.0.1

默认情况下,DISSECT 输出关键字字符串列。要转换为其他类型,请使用 类型转换函数

ROW a = "2023-01-23T12:15:00.000Z - some text - 127.0.0.1"
| DISSECT a "%{date} - %{msg} - %{ip}"
| KEEP date, msg, ip
| EVAL date = TO_DATETIME(date)
msg:keyword ip:keyword date:date

一些文本

127.0.0.1

2023-01-23T12:15:00.000Z

Dissect 键修饰符编辑

键修饰符可以更改剖析的默认行为。键修饰符可以在 %{keyname} 的左侧或右侧找到,始终位于 %{} 内。例如,%{+keyname ->} 具有追加和右填充修饰符。

表 80. Dissect 键修饰符

修饰符 名称 位置 示例 描述 详细信息

->

跳过右填充

(最)右侧

%{keyname1->}

跳过右侧的任何重复字符

链接

+

追加

左侧

%{+keyname} %{+keyname}

将两个或多个字段追加在一起

链接

+/n

按顺序追加

左侧和右侧

%{+keyname/2} %{+keyname/1}

按指定顺序将两个或多个字段追加在一起

链接

?

命名跳过键

左侧

%{?ignoreme}

在输出中跳过匹配的值。与 %{} 行为相同

链接

右填充修饰符 (->)编辑

执行剖析的算法非常严格,因为它要求模式中的所有字符都与源字符串匹配。例如,模式 %{fookey} %{barkey}(1 个空格)将匹配字符串“foo bar”(1 个空格),但不会匹配字符串“foo bar”(2 个空格),因为该模式只有 1 个空格,而源字符串有 2 个空格。

右填充修饰符有助于这种情况。将右填充修饰符添加到模式 %{fookey->} %{barkey} 中,它现在将匹配“foo bar”(1 个空格)和“foo bar”(2 个空格),甚至“foo bar”(10 个空格)。

使用右填充修饰符允许在 %{keyname->} 之后重复字符。

右填充修饰符可以放置在任何键上,并带有任何其他修饰符。它应该始终是最右边的修饰符。例如:%{+keyname/1->}%{->}

例如

ROW message="1998-08-10T17:15:42          WARN"
| DISSECT message "%{ts->} %{level}"
message:keyword ts:keyword level:keyword

1998-08-10T17:15:42 WARN

1998-08-10T17:15:42

WARN

右填充修饰符可以与空键一起使用,以帮助跳过不需要的数据。例如,相同的输入字符串,但用括号括起来,需要使用空右填充键才能获得相同的结果。

例如

ROW message="[1998-08-10T17:15:42]          [WARN]"
| DISSECT message "[%{ts}]%{->}[%{level}]"
message:keyword ts:keyword level:keyword

["[1998-08-10T17:15:42] [WARN]"]

1998-08-10T17:15:42

WARN

追加修饰符 (+)编辑

Dissect 支持将两个或多个结果追加在一起以进行输出。值从左到右追加。可以指定追加分隔符。在此示例中,append_separator 定义为空格。

ROW message="john jacob jingleheimer schmidt"
| DISSECT message "%{+name} %{+name} %{+name} %{+name}" APPEND_SEPARATOR=" "
message:keyword name:keyword

john jacob jingleheimer schmidt

john jacob jingleheimer schmidt

按顺序追加修饰符 (+/n)编辑

Dissect 支持将两个或多个结果追加在一起以进行输出。值根据定义的顺序 (/n) 追加。可以指定追加分隔符。在此示例中,append_separator 定义为逗号。

ROW message="john jacob jingleheimer schmidt"
| DISSECT message "%{+name/2} %{+name/4} %{+name/3} %{+name/1}" APPEND_SEPARATOR=","
message:keyword name:keyword

john jacob jingleheimer schmidt

schmidt,john,jingleheimer,jacob

命名跳过键 (?)编辑

Dissect 支持在最终结果中忽略匹配项。这可以使用空键 %{} 来完成,但为了便于阅读,可能需要为该空键指定一个名称。

这可以使用命名跳过键来完成,语法为 {?name}。在以下查询中,identauth 未添加到输出表中

ROW message="1.2.3.4 - - 30/Apr/1998:22:00:52 +0000"
| DISSECT message "%{clientip} %{?ident} %{?auth} %{@timestamp}"
message:keyword clientip:keyword @timestamp:keyword

1.2.3.4 - - 30/Apr/1998:22:00:52 +0000

1.2.3.4

30/Apr/1998:22:00:52 +0000

限制编辑

DISSECT 命令不支持引用键。

使用 GROK 处理数据编辑

GROK 处理命令将字符串与基于正则表达式的模式匹配,并将指定的键提取为列。

例如,以下模式

%{IP:ip} \[%{TIMESTAMP_ISO8601:@timestamp}\] %{GREEDYDATA:status}

匹配这种格式的日志行

1.2.3.4 [2023-01-23T12:15:00.000Z] Connected

将其组合为 ES|QL 查询

ROW a = "1.2.3.4 [2023-01-23T12:15:00.000Z] Connected"
| GROK a "%{IP:ip} \\[%{TIMESTAMP_ISO8601:@timestamp}\\] %{GREEDYDATA:status}"

GROK 将以下列添加到输入表中

@timestamp:keyword ip:keyword status:keyword

2023-01-23T12:15:00.000Z

1.2.3.4

Connected

grok 模式中的特殊正则表达式字符,例如 [] 需要使用 \ 进行转义。例如,在前面的模式中

%{IP:ip} \[%{TIMESTAMP_ISO8601:@timestamp}\] %{GREEDYDATA:status}

在 ES|QL 查询中,反斜杠字符本身就是一个需要使用另一个 \ 进行转义的特殊字符。对于此示例,相应的 ES|QL 查询变为

ROW a = "1.2.3.4 [2023-01-23T12:15:00.000Z] Connected"
| GROK a "%{IP:ip} \\[%{TIMESTAMP_ISO8601:@timestamp}\\] %{GREEDYDATA:status}"

Grok 模式编辑

grok 模式的语法为 %{SYNTAX:SEMANTIC}

SYNTAX 是与您的文本匹配的模式的名称。例如,3.44NUMBER 模式匹配,而 55.3.244.1IP 模式匹配。语法是您如何匹配的方式。

SEMANTIC 是您赋予要匹配的文本片段的标识符。例如,3.44 可以是事件的持续时间,因此您可以简单地将其称为 duration。此外,字符串 55.3.244.1 可能会标识发出请求的 client

默认情况下,匹配的值将作为关键字字符串数据类型输出。要转换语义的数据类型,请在其后缀上添加目标数据类型。例如 %{NUMBER:num:int},它将 num 语义从字符串转换为整数。当前仅支持 intfloat 转换。对于其他类型,请使用类型转换函数

有关可用模式的概述,请参阅GitHub。您还可以使用REST API 检索所有模式的列表。

正则表达式编辑

Grok 基于正则表达式。任何正则表达式在 grok 中也有效。Grok 使用 Oniguruma 正则表达式库。有关完全受支持的正则表达式语法,请参阅Oniguruma GitHub 存储库

自定义模式编辑

如果 grok 没有您需要的模式,则可以使用 Oniguruma 语法进行命名捕获,该语法允许您匹配一段文本并将其保存为一列

(?<field_name>the pattern here)

例如,postfix 日志有一个 queue id,它是一个 10 或 11 字符的十六进制值。可以使用以下命令将其捕获到名为 queue_id 的列中

(?<queue_id>[0-9A-F]{10,11})

示例编辑

以下示例解析一个字符串,该字符串包含一个时间戳、一个 IP 地址、一个电子邮件地址和一个数字

ROW a = "2023-01-23T12:15:00.000Z 127.0.0.1 [email protected] 42"
| GROK a "%{TIMESTAMP_ISO8601:date} %{IP:ip} %{EMAILADDRESS:email} %{NUMBER:num}"
| KEEP date, ip, email, num
date:keyword ip:keyword email:keyword num:keyword

2023-01-23T12:15:00.000Z

127.0.0.1

[email protected]

42

默认情况下,GROK 输出关键字字符串列。可以通过将 :type 附加到模式中的语义来转换 intfloat 类型。例如 {NUMBER:num:int}

ROW a = "2023-01-23T12:15:00.000Z 127.0.0.1 [email protected] 42"
| GROK a "%{TIMESTAMP_ISO8601:date} %{IP:ip} %{EMAILADDRESS:email} %{NUMBER:num:int}"
| KEEP date, ip, email, num
date:keyword ip:keyword email:keyword num:integer

2023-01-23T12:15:00.000Z

127.0.0.1

[email protected]

42

对于其他类型转换,请使用类型转换函数

ROW a = "2023-01-23T12:15:00.000Z 127.0.0.1 [email protected] 42"
| GROK a "%{TIMESTAMP_ISO8601:date} %{IP:ip} %{EMAILADDRESS:email} %{NUMBER:num:int}"
| KEEP date, ip, email, num
| EVAL date = TO_DATETIME(date)
ip:keyword email:keyword num:integer date:date

127.0.0.1

[email protected]

42

2023-01-23T12:15:00.000Z

Grok 调试器编辑

要编写和调试 grok 模式,可以使用Grok 调试器。它提供了一个用于针对示例数据测试模式的 UI。在幕后,它使用与 GROK 命令相同的引擎。

限制编辑

GROK 命令不支持配置自定义模式多个模式GROK 命令不受Grok 看门狗设置的约束。