生成器输入插件

编辑

对于其他版本,请参阅版本化的插件文档

获取帮助

编辑

有关插件的问题,请在Discuss论坛中打开一个主题。 对于错误或功能请求,请在Github中打开一个 issue。 有关 Elastic 支持的插件列表,请参阅Elastic 支持矩阵

描述

编辑

生成随机日志事件。

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

首先生成一个事件

与 Elastic Common Schema (ECS) 的兼容性

编辑

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

ECS 禁用 ECS v1, v8 描述

主机

[host][name]

处理事件的 Logstash 主机的名称

序列

[event][sequence]

生成的事件的序列号

生成器输入配置选项

编辑

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

设置 输入类型 必需

count

数字

ecs_compatibility

字符串

lines

数组

message

字符串

threads

数字

另请参阅通用选项,查看所有输入插件支持的选项列表。

 

count

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

设置应生成多少消息。

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

ecs_compatibility

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

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

控制此插件与Elastic Common Schema (ECS)的兼容性。 有关详细信息,请参阅与 Elastic Common Schema (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 1,然后发送line 2,然后发送line 3,然后发送line 1,等等……

message

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

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

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

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

threads

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

通用选项

编辑

所有输入插件都支持以下配置选项

设置 输入类型 必需

add_field

哈希

codec

codec

enable_metric

布尔值

id

字符串

tags

数组

type

字符串

add_field

编辑
  • 值类型为哈希
  • 默认值为{}

向事件添加一个字段

codec

编辑
  • 值类型为codec
  • 默认值为"plain"

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

enable_metric

编辑

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

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

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

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

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

tags

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

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

这有助于后续处理。

type

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

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

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

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

如果您尝试在已经有类型的事件上设置类型(例如,当您将事件从 shipper 发送到 indexer 时),则新的输入不会覆盖现有类型。 在 shipper 上设置的类型会随事件的生命周期保留,即使发送到另一个 Logstash 服务器也是如此。