› › ›

脚本处理器

脚本处理器编辑

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

可以通过将 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 »