› ›

Redis 输入插件

编辑

Redis 输入插件

编辑

插件版本：v3.7.1
发布日期：2024-08-01
更新日志

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

获取帮助

编辑

有关插件的问题，请在Discuss论坛中开启一个主题。有关错误或功能请求，请在Github中开启一个问题。有关 Elastic 支持的插件列表，请参考Elastic 支持矩阵。

描述

编辑

此输入将从 Redis 实例读取事件；它支持 Redis 通道和列表。Logstash 使用的列表命令（BLPOP）在 Redis v1.3.1+ 中支持，Logstash 使用的通道命令在 Redis v1.3.8+ 中找到。虽然您可能能够使这些 Redis 版本工作，但在较新的稳定版本中可以获得最佳性能和稳定性。建议使用 2.6.0+ 版本。

有关 Redis 的更多信息，请参阅https://redis.ac.cn/

batch_count 注意：如果您使用 batch_count 设置，您必须使用 Redis 2.6.0 或更高版本。任何较旧的版本都不支持批处理使用的操作。

Redis 输入配置选项

编辑

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

设置	输入类型	必需
`batch_count`	数字	否
`command_map`	哈希	否
`data_type`	字符串，可以是 `["list", "channel", "pattern_channel"]` 中的一个	是
`db`	数字	否
`host`	字符串	否
`path`	字符串	否
`key`	字符串	是
`password`	password	否
`port`	数字	否
`ssl`	布尔值	否
`threads`	数字	否
`timeout`	数字	否

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

`batch_count`

编辑

值类型是数字
默认值是125

使用 EVAL 从 Redis 返回的事件数。

`command_map`

编辑

值类型是哈希
此设置没有默认值。
键是默认命令名称，值是重命名的命令。

以 "oldname" ⇒ "newname" 的形式配置重命名的 redis 命令。Redis 允许在其协议中重命名或禁用命令，请参阅：https://redis.ac.cn/topics/security

`data_type`

编辑

这是一个必需的设置。
值可以是：list，channel，pattern_channel 中的任何一个
此设置没有默认值。

指定列表或通道。如果data_type是list，那么我们将 BLPOP 该键。如果data_type是channel，那么我们将 SUBSCRIBE 该键。如果data_type是pattern_channel，那么我们将 PSUBSCRIBE 该键。

`db`

编辑

值类型是数字
默认值是 0

Redis 数据库编号。

`host`

编辑

值类型是字符串
默认值是 "127.0.0.1"

您的 Redis 服务器的主机名。

`path`

编辑

值类型是字符串
此设置没有默认值。
如果同时指定了路径和主机配置，则路径将覆盖主机配置。

您的 Redis 服务器的 unix 套接字路径。

`key`

编辑

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

Redis 列表或通道的名称。

`password`

编辑

值类型是密码
此设置没有默认值。

用于身份验证的密码。默认情况下没有身份验证。

`port`

编辑

值类型是数字
默认值是 6379

要连接的端口。

`ssl`

编辑

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

启用 SSL 支持。

`threads`

编辑

值类型是数字
默认值是 1

要启动的输入实例数，每个实例都在其自己的线程上。从 1 增加可以提高从 Redis 消费消息的并发性。

当从通道消费时，增加线程数将导致重复消息，因为SUBSCRIBE会将每条消息传递给所有订阅者。

`timeout`

编辑

值类型是数字
默认值是 5

初始连接超时（秒）。

通用选项

编辑

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

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

`add_field`

编辑

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

向事件添加字段

`codec`

编辑

值类型是编解码器
默认值是 "json"

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

`enable_metric`

编辑

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

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

`id`

编辑

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

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

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

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

`tags`

编辑

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

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

这有助于稍后进行处理。

`type`

编辑

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

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

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

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

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

« Rabbitmq 输入插件 Relp 输入插件 »