« Couchdb_changes 输入插件 Elastic Agent 输入插件 »

› ›

死信队列输入插件

编辑

死信队列输入插件

编辑

插件版本：v2.0.1
发布日期：2024-09-04
变更日志

对于其他版本，请参阅版本化插件文档。

获取帮助

编辑

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

描述

编辑

Logstash 输入插件，用于从 Logstash 的死信队列读取事件。

input {
  dead_letter_queue {
    path => "/var/logstash/data/dead_letter_queue"
    start_timestamp => "2017-04-04T23:40:37"
  }
}

有关在死信队列中处理事件的更多信息，请参阅死信队列。

死信队列输入配置选项

编辑

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

设置	输入类型	必需
`clean_consumed`	布尔值	否
`commit_offsets`	布尔值	否
`路径`	有效的系统文件路径	是
`pipeline_id`	字符串	否
`sincedb_path`	字符串	否
`start_timestamp`	字符串	否

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

`clean_consumed`

编辑

值类型为布尔值
默认值为 false

设置为 true 时，此选项会删除已读取的 DLQ 段。此功能要求 commit_offsets 设置为 true。否则，您将收到配置错误。此功能在 Logstash 8.4.0 及更高版本中可用。如果此设置为 true 且您使用的是低于 8.4.0 的 Logstash 版本，则您将收到配置错误。

`commit_offsets`

编辑

值类型为布尔值
默认值为 true

指定此输入在处理事件时是否应提交偏移量。通常，当您希望多次迭代死信队列中的事件但不想保存状态时，您会指定 false。这是您在探索死信队列中的事件时的情况。

`path`

编辑

这是必需的设置。
值类型为路径
此设置没有默认值。

由 Logstash 实例创建的死信队列目录的路径。这是读取“死”事件的路径，通常在原始 Logstash 实例中使用设置 path.dead_letter_queue 进行配置。

`pipeline_id`

编辑

值类型为字符串
默认值为 "main"

您要从中读取事件的管道的 ID。

`sincedb_path`

编辑

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

将写入磁盘的 sincedb 数据库文件（跟踪死信队列的当前位置）的路径。默认情况下，会将 sincedb 文件写入 <path.data>/plugins/inputs/dead_letter_queue。

此值必须是文件路径，而不是目录路径。

`start_timestamp`

编辑

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

您要从其开始处理事件的 ISO8601 格式的时间戳。例如，2017-04-04T23:40:37。

通用选项

编辑

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

设置	输入类型	必需
`add_field`	哈希	否
`codec`	codec	否
`enable_metric`	布尔值	否
`id`	字符串	否
`tags`	数组	否
`type`	字符串	否

`add_field`

编辑

值类型为哈希
默认值为 {}

向事件添加字段

`codec`

编辑

值类型为 codec
默认值为 "plain"

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

`enable_metric`

编辑

值类型为布尔值
默认值为 true

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

`id`

编辑

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

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

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

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

`tags`

编辑

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

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

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

`type`

编辑

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

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

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

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

如果您尝试在已存在类型的事件上设置类型（例如，当您从发货程序发送事件到索引程序时），则新的输入不会覆盖现有类型。在发货程序中设置的类型将与该事件保持一致，即使它被发送到另一个 Logstash 服务器也是如此。

« Couchdb_changes 输入插件 Elastic Agent 输入插件 »