Couchdb_changes input plugin
editCouchdb_changes input plugin
edit- Plugin version: v3.1.6
- Released on: 2019-04-15
- Changelog
For other versions, see the Versioned plugin docs.
Getting help
editFor questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
Description
editThis CouchDB input allows you to automatically stream events from the CouchDB _changes URI. Moreover, any "future" changes will automatically be streamed as well making it easy to synchronize your CouchDB data with any target destination
Upsert and delete
editYou can use event metadata to allow for document deletion. All non-delete operations are treated as upserts
Starting at a Specific Sequence
editThe CouchDB input stores the last sequence number value in location defined by sequence_path
.
You can use this fact to start or resume the stream at a particular sequence.
Couchdb_changes Input Configuration Options
editThis plugin supports the following configuration options plus the Common options described later.
Setting | Input type | Required |
---|---|---|
No |
||
a valid filesystem path |
No |
|
Yes |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
Also see Common options for a list of options supported by all input plugins.
always_reconnect
edit- Value type is boolean
-
Default value is
true
Reconnect flag. When true, always try to reconnect after a failure
ca_file
edit- Value type is path
- There is no default value for this setting.
Path to a CA certificate file, used to validate certificates
db
edit- This is a required setting.
- Value type is string
- There is no default value for this setting.
The CouchDB db to connect to. Required parameter.
heartbeat
edit- Value type is number
-
Default value is
1000
Logstash connects to CouchDB’s _changes with feed=continuous The heartbeat is how often (in milliseconds) Logstash will ping CouchDB to ensure the connection is maintained. Changing this setting is not recommended unless you know what you are doing.
ignore_attachments
edit- Value type is boolean
-
Default value is
true
Future feature! Until implemented, changing this from the default will not do anything.
Ignore attachments associated with CouchDB documents.
initial_sequence
edit- Value type is number
- There is no default value for this setting.
If unspecified, Logstash will attempt to read the last sequence number
from the sequence_path
file. If that is empty or non-existent, it will
begin with 0 (the beginning).
If you specify this value, it is anticipated that you will only be doing so for an initial read under special circumstances and that you will unset this value afterwards.
keep_id
edit- Value type is boolean
-
Default value is
false
Preserve the CouchDB document id "_id" value in the output.
keep_revision
edit- Value type is boolean
-
Default value is
false
Preserve the CouchDB document revision "_rev" value in the output.
password
edit- Value type is password
-
Default value is
nil
Password, if authentication is needed to connect to CouchDB
reconnect_delay
edit- Value type is number
-
Default value is
10
Reconnect delay: time between reconnect attempts, in seconds.
secure
edit- Value type is boolean
-
Default value is
false
Connect to CouchDB’s _changes feed securely (via https) Default: false (via http)
sequence_path
edit- Value type is string
- There is no default value for this setting.
File path where the last sequence number in the _changes
stream is stored. If unset it will write to $HOME/.couchdb_seq
Common options
editThese configuration options are supported by all input plugins:
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
codec
edit- Value type is codec
-
Default value is
"plain"
The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.
enable_metric
edit- Value type is boolean
-
Default value is
true
Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.
id
edit- Value type is string
- There is no default value for this setting.
Add a unique ID
to the plugin configuration. If no ID is specified, Logstash will generate one.
It is strongly recommended to set this ID in your configuration. This is particularly useful
when you have two or more plugins of the same type, for example, if you have 2 couchdb_changes inputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
input { couchdb_changes { id => "my_plugin_id" } }
Variable substitution in the id
field only supports environment variables
and does not support the use of values from the secret store.
tags
edit- Value type is array
- There is no default value for this setting.
Add any number of arbitrary tags to your event.
This can help with processing later.
type
edit- Value type is string
- There is no default value for this setting.
Add a type
field to all events handled by this input.
Types are used mainly for filter activation.
The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.
If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.