Couchdb_changes 输入插件

编辑

Couchdb_changes 输入插件

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

对于其他版本,请参阅 版本化插件文档

获取帮助

编辑

如有关于插件的问题,请在 Discuss 论坛中发起主题讨论。对于错误或功能请求,请在 Github 中提交问题。有关 Elastic 支持的插件列表,请参阅 Elastic 支持矩阵

描述

编辑

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

Upsert 和删除

编辑

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

从特定序列开始

编辑

CouchDB 输入插件将最后一个序列号值存储在由 sequence_path 定义的位置。您可以利用此特性从特定序列开始或恢复流。

Couchdb_changes 输入配置选项

编辑

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

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

 

always_reconnect

编辑

重新连接标志。如果为 true,则在发生故障后始终尝试重新连接。

ca_file

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

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

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

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

heartbeat

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

Logstash 使用 feed=continuous 连接到 CouchDB 的 _changes。心跳是指 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 提要。默认: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。当您有两个或多个相同类型的插件时,这尤其有用,例如,如果您有两个 couchdb_changes 输入。在这种情况下,添加命名 ID 将有助于在使用监控 API 时监控 Logstash。

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

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

tags

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

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

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

type

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

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

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

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

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