Couchdb_changes 输入插件

编辑

Couchdb_changes 输入插件

编辑
  • 插件版本: v3.1.6
  • 发布日期: 2019-04-15
  • 更新日志

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

获取帮助

编辑

如有关于插件的问题,请在Discuss论坛中开帖。如遇错误或有功能请求,请在Github中开一个 issue。有关 Elastic 支持的插件列表,请参阅Elastic 支持矩阵

描述

编辑

此 CouchDB 输入允许您自动从 CouchDB _changes URI 流式传输事件。此外,任何“未来”的更改也将自动流式传输,从而可以轻松地将 CouchDB 数据与任何目标位置同步

插入和删除

编辑

您可以使用事件元数据来允许文档删除。所有非删除操作都视为插入

从特定序列开始

编辑

CouchDB 输入将最后一个序列号值存储在由 sequence_path 定义的位置。您可以使用此事实在特定序列处开始或恢复流。

Couchdb_changes 输入配置选项

编辑

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

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

 

always_reconnect

编辑

重新连接标志。如果为 true,则在失败后始终尝试重新连接

ca_file

编辑
  • 值类型是路径
  • 此设置没有默认值。

用于验证证书的 CA 证书文件的路径

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

要连接到的 CouchDB 数据库。必需参数。

heartbeat

编辑
  • 值类型是数字
  • 默认值是 1000

Logstash 连接到 CouchDB 的 _changes,使用 feed=continuous。心跳是 Logstash 将 ping CouchDB 以确保连接保持的频率(以毫秒为单位)。除非您知道自己在做什么,否则不建议更改此设置。

host

编辑
  • 值类型是字符串
  • 默认值是 "localhost"

您的 CouchDB 实例的 IP 或主机名

ignore_attachments

编辑

未来功能!在实施之前,更改此默认值不会执行任何操作。

忽略与 CouchDB 文档关联的附件。

initial_sequence

编辑
  • 值类型是数字
  • 此设置没有默认值。

如果未指定,Logstash 将尝试从 sequence_path 文件中读取最后一个序列号。如果该文件为空或不存在,它将从 0(开头)开始。

如果您指定此值,则预期您仅在特殊情况下进行初始读取时才这样做,并且之后您将取消设置此值。

keep_id

编辑

保留输出中的 CouchDB 文档 id "_id" 值。

keep_revision

编辑

保留输出中的 CouchDB 文档修订版 "_rev" 值。

password

编辑
  • 值类型是密码
  • 默认值是 nil

如果需要身份验证才能连接到 CouchDB,则为密码

port

编辑
  • 值类型是数字
  • 默认值是 5984

您的 CouchDB 实例的端口。

reconnect_delay

编辑
  • 值类型是数字
  • 默认值是 10

重新连接延迟:重新连接尝试之间的时间,以秒为单位。

secure

编辑

安全地(通过 https)连接到 CouchDB 的 _changes feed。默认值:false(通过 http)

sequence_path

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

存储 _changes 流中最后一个序列号的文件路径。如果未设置,它将写入 $HOME/.couchdb_seq

timeout

编辑
  • 值类型是数字
  • 此设置没有默认值。

超时:在终止连接之前等待新数据的毫秒数。如果设置了超时,它将禁用心跳配置选项。

username

编辑

如果需要身份验证才能连接到 CouchDB,则为用户名

通用选项

编辑

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

设置 输入类型 必需

add_field

哈希

codec

codec

enable_metric

布尔值

id

字符串

tags

数组

type

字符串

add_field

编辑
  • 值类型是哈希
  • 默认值是 {}

向事件添加字段

codec

编辑

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

enable_metric

编辑

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

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

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

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

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

tags

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

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

这有助于以后的处理。

type

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

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

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

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

如果您尝试在已经有类型的事件上设置类型(例如,当您从托运人向索引器发送事件时),则新输入不会覆盖现有类型。在托运人处设置的类型会一直伴随该事件,即使发送到另一个 Logstash 服务器也是如此。