« Meetup 输入插件 Puppet_facter 输入插件 »
Elastic 文档 ›Logstash 参考 [8.14] ›输入插件

管道输入插件

编辑

管道输入插件编辑

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

有关其他版本，请参阅 版本化插件文档。

获取帮助编辑

如果您对插件有任何疑问，请在 讨论 论坛中发起主题。对于错误或功能请求，请在 Github 中提交问题。有关 Elastic 支持的插件列表，请参阅 Elastic 支持矩阵。

描述编辑

从长时间运行的命令管道流式传输事件。

默认情况下，假定每个事件为一行。如果您想连接多行，则需要使用多行编解码器。

与 Elastic 通用模式 (ECS) 的兼容性编辑

此插件添加了有关事件源的额外字段。如果您想确保这些字段与 ECS 兼容，请配置 ecs_compatibility 选项。

这些字段是在事件被相应的编解码器解码后添加的，不会覆盖现有值。

ECS 已禁用 ECS v1, v8 描述

主机

[host][name]

处理事件的 Logstash 主机的名称

命令

[process][command_line]

插件运行的命令

管道输入配置选项编辑

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

设置 输入类型 必需

命令

字符串

是

ecs_compatibility

字符串

否

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

 

command编辑

  • 这是一个必需的设置。
  • 值类型为 字符串
  • 此设置没有默认值。

要运行并从中读取事件的命令，一次一行。

示例

input {
  pipe {
    command => "echo ¡Hola!"
  }
}

ecs_compatibility编辑

  • 值类型为 字符串

  • 支持的值为

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

控制此插件与 Elastic 通用模式 (ECS) 的兼容性。有关详细信息，请参阅 与 Elastic 通用模式 (ECS) 的兼容性。

示例输出: ECS 已启用

{
    "@timestamp"=>2021-11-16T09:18:45.306Z,
    "message" => "¡Hola!",
    "process" => {
        "command_line" => "echo '¡Hola!'"
    },
    "host" => {
        "name" => "deus-ex-machina"
    }
}

示例输出: ECS 已禁用

{
    "@timestamp"=>2021-11-16T09:18:45.306Z,
    "message" => "¡Hola!",
    "command" => "echo '¡Hola!'",
    "host" => "deus-ex-machina"
}

通用选项编辑

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

设置 输入类型 必需

add_field

hash

否

enable_metric

布尔值

否

id

字符串

否

tags

数组

否

type

字符串

否

详细信息编辑

 

add_field编辑

  • 值类型为 hash
  • 默认值为 {}

向事件添加字段

enable_metric编辑

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

id编辑

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

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

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

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

tags编辑

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

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

这可以帮助以后进行处理。

type编辑

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

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

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

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

如果您尝试在已经具有类型的事件上设置类型（例如，当您从发送器发送事件到索引器时），那么新的输入将不会覆盖现有的类型。在发送器处设置的类型会一直保留在该事件中，即使它被发送到另一个 Logstash 服务器也是如此。

« Meetup 输入插件 Puppet_facter 输入插件 »