› ›

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`

编辑

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

以“旧名称”⇒“新名称”的形式配置重命名的 Redis 命令。Redis 允许重命名或禁用其协议中的命令，请参见：https://redis.ac.cn/topics/security

`data_type`

编辑

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

指定列表或频道。如果 data_type 为 list，则我们将 BLPOP 键。如果 data_type 为 channel，则我们将订阅该键。如果 data_type 为 pattern_channel，则我们将 PSUBSCRIBE 该键。

`db`

编辑

值类型为数字
默认值为 0

Redis 数据库编号。

`host`

编辑

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

Redis 服务器的主机名。

`path`

编辑

值类型为字符串
此设置没有默认值。
如果同时指定，则 path 将覆盖 Host 配置。

Redis 服务器的 Unix 套接字路径。

`key`

编辑

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

Redis 列表或频道的名称。

`password`

编辑

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

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

`port`

编辑

值类型为数字
默认值为 6379

要连接的端口。

`ssl`

编辑

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

启用 SSL 支持。

`threads`

编辑

值类型为数字
默认值为 1

要启动的输入实例数，每个实例都在其自己的线程上。从一个增加到多个以提高从 Redis 中使用消息的并发性。

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

`timeout`

编辑

值类型为数字
默认值为 5

初始连接超时（秒）。

常用选项

编辑

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

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

`add_field`

编辑

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

向事件添加字段

`codec`

编辑

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

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

`enable_metric`

编辑

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

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

`id`

编辑

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

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

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

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

`tags`

编辑

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

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

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

`type`

编辑

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

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

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

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

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

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