› ›

Redis 输入插件

Redis 输入插件编辑

插件版本：v3.7.0
发布时间：2021-05-04
更新日志

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

获取帮助编辑

如果您对该插件有任何疑问，请在论坛中打开一个主题。对于错误或功能请求，请在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`编辑

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

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

`key`编辑

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

Redis 列表或通道的名称。

`password`编辑

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

用于身份验证的密码。默认情况下不进行身份验证。

`port`编辑

值类型为数字
默认值为6379

要连接的端口。

`ssl`编辑

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

启用 SSL 支持。

`threads`编辑

值类型为数字
默认值为1

`timeout`编辑

值类型为数字
默认值为5

初始连接超时（秒）。

通用选项编辑

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

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

详细信息编辑

`add_field`编辑

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

向事件添加字段

`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 输入插件 »

Redis 输入插件