Generator 输入插件

编辑
  • 插件版本:v3.1.0
  • 发布日期:2021-11-04
  • 变更日志

其他版本,请查看 版本化插件文档

获取帮助

编辑

如有任何关于插件的问题,请在 Discuss 论坛发帖提问。如有错误或功能请求,请在 Github 上提交问题。如需查看 Elastic 支持的插件列表,请查看 Elastic 支持矩阵

描述

编辑

生成随机日志事件。

此插件的总体目的是测试插件的性能。

首先生成一个事件

与 Elastic 通用架构 (ECS) 的兼容性

编辑

此插件根据是否启用了 ECS 兼容性 使用不同的字段名称(另请参见 ecs_compatibility)。

ECS 已禁用 ECS v1, v8 描述

主机

[host][name]

处理事件的 Logstash 主机的名称

序列号

[event][sequence]

生成的事件的序列号

Generator 输入配置选项

编辑

此插件支持以下配置选项以及稍后描述的 通用选项

设置 输入类型 必需

计数

数字

ecs_compatibility

字符串

数组

消息

字符串

线程

数字

另请参见 通用选项,了解所有输入插件支持的选项列表。

 

count

编辑
  • 值类型为 数字
  • 默认值为 0

设置应生成的邮件数量。

默认值 0 表示生成无限数量的事件。

ecs_compatibility

编辑
  • 值类型为 字符串
  • 支持的值为

    • disabled:使用向后兼容的字段名称,例如 [host]
    • v1, v8:使用与 ECS 兼容的字段,例如 [host][name]

控制此插件与 Elastic 通用架构 (ECS) 的兼容性。有关详细信息,请参见 与 Elastic 通用架构 (ECS) 的兼容性

示例输出:ECS 已启用

{
    "message" => "Hello world!",
    "event" => {
        "sequence" => 0
    },
    "host" => {
        "name" => "the-machine"
    }
}

示例输出:ECS 已禁用

{
    "message" => "Hello world!",
    "sequence" => 0,
    "host" => "the-machine"
}

lines

编辑
  • 值类型为 数组
  • 此设置没有默认值。

要按顺序发出的行。此选项不能与 *message* 设置一起使用。

示例

    input {
      generator {
        lines => [
          "line 1",
          "line 2",
          "line 3"
        ]
        # Emit all lines 3 times.
        count => 3
      }
    }

以上将依次发出 line 1line 2line 3,然后是 line 1 等……

message

编辑
  • 值类型为 字符串
  • 默认值为 "Hello world!"

要在事件中使用的消息字符串。

如果将其设置为 stdin,则此插件将从 stdin 读取一行,并将其用作每个事件的消息字符串。

否则,此值将按字面原样用作事件消息。

threads

编辑
  • 值类型为 数字
  • 默认值为 1

通用选项

编辑

所有输入插件都支持这些配置选项

add_field

编辑

向事件添加字段

codec

编辑

用于输入数据的编解码器。输入编解码器是在数据进入输入之前对其进行解码的一种便捷方法,无需在 Logstash 管道中使用单独的过滤器。

enable_metric

编辑

默认情况下,我们会记录所有可以记录的指标,但您可以禁用特定插件的指标收集功能,从而禁用或启用此特定插件实例的指标日志记录。

  • 值类型为 字符串
  • 此设置没有默认值。

向插件配置添加唯一的 ID。如果没有指定 ID,Logstash 将生成一个 ID。强烈建议您在配置中设置此 ID。当您有两个或多个相同类型的插件时,这尤其有用,例如,如果您有两个生成器输入。在这种情况下,添加命名 ID 将有助于在使用监控 API 时监控 Logstash。

input {
  generator {
    id => "my_plugin_id"
  }
}

id 字段中的变量替换仅支持环境变量,不支持使用密钥存储中的值。

tags

编辑
  • 值类型为 数组
  • 此设置没有默认值。

向您的事件添加任意数量的标签。

这可以帮助以后的处理。

type

编辑
  • 值类型为 字符串
  • 此设置没有默认值。

向此输入处理的所有事件添加 type 字段。

类型主要用于过滤器激活。

类型存储为事件本身的一部分,因此您也可以使用类型在 Kibana 中搜索它。

如果您尝试在已拥有类型的事件上设置类型(例如,当您将事件从发件人发送到索引器时),则新的输入不会覆盖现有类型。即使发送到另一个 Logstash 服务器,在发件人处设置的类型也会一直保留在该事件中。