For other versions, see theVersioned plugin docs.
For 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.
This CouchDB input allows you to automatically stream events from theCouchDB _changes URI.Moreover, any "future" changes will automatically be streamed as well making it easy to synchronizeyour CouchDB data with any target destination
# Upsert and deleteYou can use event metadata to allow for document deletion.All non-delete operations are treated as upserts
# Starting at a Specific SequenceThe 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.
This 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 allinput plugins.
trueReconnect flag. When true, always try to reconnect after a failure
Path to a CA certificate file, used to validate certificates
The CouchDB db to connect to.Required parameter.
1000Logstash connects to CouchDB’s _changes with feed=continuousThe heartbeat is how often (in milliseconds) Logstash will pingCouchDB to ensure the connection is maintained. Changing thissetting is not recommended unless you know what you are doing.
trueFuture feature! Until implemented, changing this from the defaultwill not do anything.
Ignore attachments associated with CouchDB documents.
If unspecified, Logstash will attempt to read the last sequence numberfrom the sequence_path file. If that is empty or non-existent, it willbegin with 0 (the beginning).
If you specify this value, it is anticipated that you willonly be doing so for an initial read under special circumstancesand that you will unset this value afterwards.
falsePreserve the CouchDB document id "_id" value in theoutput.
falsePreserve the CouchDB document revision "_rev" value in theoutput.
nilPassword, if authentication is needed to connect toCouchDB
10Reconnect delay: time between reconnect attempts, in seconds.
falseConnect to CouchDB’s _changes feed securely (via https)Default: false (via http)
File path where the last sequence number in the _changesstream is stored. If unset it will write to $HOME/.couchdb_seq
Timeout: Number of milliseconds to wait for new data beforeterminating the connection. If a timeout is set it will disablethe heartbeat configuration option.
nilUsername, if authentication is needed to connect toCouchDB
The following configuration options are supported by all input plugins:
"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.
trueDisable or enable metric logging for this specific plugin instanceby default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.
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 usefulwhen 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" }}
Add any number of arbitrary tags to your event.
This can help with processing later.
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 canalso use the type to search for it in Kibana.
If you try to set a type on an event that already has one (forexample when you send an event from a shipper to an indexer) thena new input will not override the existing type. A type set atthe shipper stays with that event for its life evenwhen sent to another Logstash server.