管道输出插件

编辑
  • 插件版本:v3.0.6
  • 发布日期:2018-04-06
  • 更新日志

其他版本,请参见 版本化插件文档

获取帮助

编辑

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

描述

编辑

管道输出。

将事件输出到另一个程序的标准输入。您可以使用事件中的字段作为命令的一部分。警告:如果您不仔细处理每个事件的命令行,此功能可能会导致 Logstash 分离出多个子进程。

管道输出配置选项

编辑

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

设置 输入类型 必填

command

字符串

message_format

字符串

ttl

数字

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

 

command

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

启动并输出的命令行

message_format

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

将事件写入管道时使用的格式。此值支持任何字符串,并可以包含 %{name} 和其他动态字符串。

如果省略此设置,则事件的完整 JSON 表示形式将作为单行写入。

  • 值类型为 数字
  • 默认值为 10

关闭未被使用 TTL 秒的管道。-1 或 0 表示永不关闭。

常用选项

编辑

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

设置 输入类型 必填

codec

codec

enable_metric

布尔值

id

字符串

codec

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

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

enable_metric

编辑

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

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

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

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

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