New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
« 替换事件中的字段 Syslog »
Elastic 文档 ›Filebeat 参考 [8.17] ›配置 Filebeat ›使用处理器过滤和增强数据

脚本处理器

编辑

脚本处理器

编辑

script 处理器执行 Javascript 代码来处理事件。该处理器使用纯 Go 实现的 ECMAScript 5.1，并且没有外部依赖项。在其他处理器无法提供您需要的过滤事件的功能时，这非常有用。

可以通过在配置文件中嵌入 Javascript 或将处理器指向外部文件来配置处理器。

processors:
  - script:
      lang: javascript
      source: >
        function process(event) {
            event.Tag("js");
        }

这将从磁盘加载 filter.js。

processors:
  - script:
      lang: javascript
      file: ${path.config}/filter.js

可以通过在配置中添加 params 将参数传递给脚本。这使得脚本可以重复使用。当使用 params 时，代码必须定义一个 register(params) 函数来接收参数。

processors:
  - script:
      lang: javascript
      tag: my_filter
      params:
        threshold: 15
      source: >
        var params = {threshold: 42};
        function register(scriptParams) {
            params = scriptParams;
        }
        function process(event) {
            if (event.Get("severity") < params.threshold) {
                event.Cancel();
            }
        }

如果脚本定义了一个 test() 函数，它将在处理器加载时被调用。任何抛出的异常都会导致处理器加载失败。这可以用来断言脚本的行为。

function process(event) {
    if (event.Get("event.code") === 1102) {
        event.Put("event.action", "cleared");
    }
    return event;
}

function test() {
    var event = process(new Event({event: {code: 1102}}));
    if (event.Get("event.action") !== "cleared") {
        throw "expected event.action === cleared";
    }
}

配置选项

编辑

script 处理器具有以下配置设置

lang
此字段是必需的，其值必须为 javascript。
tag
这是一个可选的标识符，它被添加到日志消息中。如果定义了此项，则会为此处理器实例启用指标日志记录。指标包括异常数量和 process 函数的执行时间直方图。
source
内联 Javascript 源代码。
file
要加载的脚本文件的路径。相对路径被解释为相对于 path.config 目录。通配符会被展开。
files
要加载的脚本文件列表。这些脚本被连接在一起。相对路径被解释为相对于 path.config 目录。通配符会被展开。
params
传递给脚本的 register 的参数字典。
tag_on_exception
在 Javascript 代码在处理事件时导致异常的情况下添加到事件的标签。默认为 _js_exception。
timeout
这为 process 函数设置执行超时。当 process 函数的执行时间超过 timeout 周期时，该函数将被中断。您可以设置此选项以防止脚本运行时间过长（例如，防止无限的 while 循环）。默认情况下，没有超时。
max_cached_sessions
这设置将缓存的最大 Javascript VM 会话数，以避免重新分配。默认值为 4。

事件 API

编辑

传递给 process 方法的 Event 对象具有以下 API。

方法 描述

Get(string)

从事件中获取一个值（标量或对象）。如果键不存在，则返回 null。如果未提供键，则返回包含所有字段的对象。

示例: var value = event.Get(key);

Put(string, value)

将一个值放入事件中。如果已经设置了键，则返回先前的值。如果由于某个中间值不是对象而无法设置键，则会抛出异常。

示例: var old = event.Put(key, value);

Rename(string, string)

重命名事件中的键。目标键必须不存在。如果源键已成功重命名为目标键，则返回 true。

示例: var success = event.Rename("source", "target");

Delete(string)

从事件中删除一个字段。成功时返回 true。

示例: var deleted = event.Delete("user.email");

Cancel()

将事件标记为已取消，这将导致处理器丢弃事件。

示例: event.Cancel(); return;

Tag(string)

如果 tags 字段中尚不存在该标签，则将该标签追加到该字段。如果 tags 存在但不是字符串或字符串列表，则会抛出异常。

示例: event.Tag("user_event");

AppendTo(string, string)

AppendTo 是一个专门的 Put 方法，它将现有值转换为数组，并在该值尚不存在时追加该值。如果存在的值不是字符串或字符串数组，则会抛出异常。

示例: event.AppendTo("error.message", "invalid file hash");
« 替换事件中的字段 Syslog »

On this page

Was this helpful?
Feedback