Redis 输出插件编辑

  • 插件版本: v5.0.0
  • 发布日期: 2019-01-11
  • 变更日志

有关其他版本,请参阅 版本化插件文档.

获取帮助编辑

如果您对插件有任何疑问,请在 Discuss 论坛中发布主题。对于错误或功能请求,请在 Github 中创建问题。有关 Elastic 支持的插件列表,请参阅 Elastic 支持矩阵.

描述编辑

此输出将使用 RPUSH 将事件发送到 Redis 队列。RPUSH 命令在 Redis v0.0.7+ 中受支持。使用 PUBLISH 到频道需要至少 v1.3.8+。虽然您可能能够使这些 Redis 版本工作,但最佳性能和稳定性将在更新的稳定版本中找到。建议使用版本 2.6.0+。

有关更多信息,请参阅 Redis 主页

Redis 输出配置选项编辑

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

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

 

batch编辑

如果要让 Redis 批量处理值并发送 1 个 RPUSH 命令而不是每个值一个命令来推送到列表中,则将其设置为 true。请注意,这目前仅适用于 data_type="list" 模式。

如果为 true,我们每 "batch_events" 个事件或 "batch_timeout" 秒(以先到者为准)发送一个 RPUSH。仅支持 data_type 为 "list"。

batch_events编辑

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

如果 batch 设置为 true,则我们为 RPUSH 排队的事件数。

batch_timeout编辑

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

如果 batch 设置为 true,则在有待刷新事件时,RPUSH 命令之间的最大时间量。

congestion_interval编辑

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

检查拥塞的频率。默认值为一秒。零表示在每个事件上检查。

congestion_threshold编辑

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

如果 Redis data_typelist 并且包含超过 @congestion_threshold 个项目,则阻塞直到有人使用它们并减少拥塞,否则如果没有任何使用者,Redis 将耗尽内存,除非它已配置了 OOM 保护。但即使使用 OOM 保护,单个 Redis 列表也可以阻止 Redis 的所有其他用户,直到 Redis CPU 使用量达到允许的最大 RAM 大小。默认值为 0 表示此限制已禁用。仅支持 list Redis data_type

data_type编辑

  • 值可以是以下任何一个:listchannel
  • 此设置没有默认值。

列表或频道。如果 data_type 为列表,则我们将对 key 设置 RPUSH。如果 data_type 为频道,则我们将对 key 发布。

db编辑

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

Redis 数据库编号。

host编辑

  • 值类型为 数组
  • 默认值为 ["127.0.0.1"]

Redis 服务器的主机名(s)。可以在任何主机名上指定端口,这将覆盖全局端口配置。如果主机列表是一个数组,Logstash 将随机选择一个主机进行连接,如果该主机断开连接,它将选择另一个主机。

例如

    "127.0.0.1"
    ["127.0.0.1", "127.0.0.2"]
    ["127.0.0.1:6380", "127.0.0.1"]

key编辑

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

Redis 列表或频道的名称。动态名称在此处有效,例如 logstash-%{type}

password编辑

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

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

port编辑

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

要连接的默认端口。可以在任何主机名上覆盖。

reconnect_interval编辑

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

重新连接到失败的 Redis 连接的间隔

shuffle_hosts编辑

在 Logstash 启动期间对主机列表进行洗牌。

timeout编辑

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

Redis 初始连接超时时间(以秒为单位)。

通用选项编辑

以下配置选项由所有输出插件支持

设置 输入类型 必需

enable_metric

布尔值

id

字符串

enable_metric编辑

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

id编辑

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

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

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

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