logstash-input-couchdb_changes 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0153e41c5e8055b052c7e9df86cb80ce90e3d1da
-  data.tar.gz: 919a3ab0f89655e581c54ced25387868cadd2278
+  metadata.gz: 01a4f83f36f2e4573dfe46b7570fad4ae3813c27
+  data.tar.gz: 8e3fa464f42ada27c32d43e9b9c148d8363b1bec
 SHA512:
-  metadata.gz: a71d15df742fade2d8e4f81d39a86b47b7db686cb9e884b8c97a2a47531808f908be5b5d43af789fa5e962f55403c9117b7daa7560795c9da12f3707e9eaf5d0
-  data.tar.gz: 761760ca08110af46d709230d17bf627b674b4a19932c3c587315b494bfb8b136676321f6048d4b6db222fcc420c1d9bb322252f298d08df5ec2413ea6c84d59
+  metadata.gz: 43365ef85c7e03b310b00da96def8fb9d72f9a593fe6ffde31073ac208ca23d7a4fffe455e8c72d2317adde3f8fcbb25dfe5d4a923bb803484754ee3751778ba
+  data.tar.gz: 6c05da85068a064a89bee77365edf6343525c984992733f91752c01d39da48a0380b3c6043702f9676a96006641a7231e6ec4c06bf35b9bc5a676de0da910390

data/Gemfile

@@ -1,4 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logstash-mass_effect.gemspec
 gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,220 @@
+:plugin: couchdb_changes
+:type: input
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Couchdb_changes input plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+This CouchDB input allows you to automatically stream events from the
+CouchDB http://guide.couchdb.org/draft/notifications.html[_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
+You can use event metadata to allow for document deletion.
+All non-delete operations are treated as upserts
+
+### Starting at a Specific Sequence
+The 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.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Couchdb_changes Input Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-always_reconnect>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-ca_file>> |a valid filesystem path|No
+| <<plugins-{type}s-{plugin}-db>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-heartbeat>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-ignore_attachments>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-initial_sequence>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-keep_id>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-keep_revision>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
+| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-reconnect_delay>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-secure>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-sequence_path>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-timeout>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-username>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+input plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-always_reconnect"]
+===== `always_reconnect` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Reconnect flag.  When true, always try to reconnect after a failure
+
+[id="plugins-{type}s-{plugin}-ca_file"]
+===== `ca_file` 
+
+  * Value type is <<path,path>>
+  * There is no default value for this setting.
+
+Path to a CA certificate file, used to validate certificates
+
+[id="plugins-{type}s-{plugin}-db"]
+===== `db` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The CouchDB db to connect to.
+Required parameter.
+
+[id="plugins-{type}s-{plugin}-heartbeat"]
+===== `heartbeat` 
+
+  * Value type is <<number,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.
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host` 
+
+  * Value type is <<string,string>>
+  * Default value is `"localhost"`
+
+IP or hostname of your CouchDB instance
+
+[id="plugins-{type}s-{plugin}-ignore_attachments"]
+===== `ignore_attachments` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Future feature! Until implemented, changing this from the default
+will not do anything.
+
+Ignore attachments associated with CouchDB documents.
+
+[id="plugins-{type}s-{plugin}-initial_sequence"]
+===== `initial_sequence` 
+
+  * Value type is <<number,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.
+
+[id="plugins-{type}s-{plugin}-keep_id"]
+===== `keep_id` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Preserve the CouchDB document id "_id" value in the
+output.
+
+[id="plugins-{type}s-{plugin}-keep_revision"]
+===== `keep_revision` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Preserve the CouchDB document revision "_rev" value in the
+output.
+
+[id="plugins-{type}s-{plugin}-password"]
+===== `password` 
+
+  * Value type is <<password,password>>
+  * Default value is `nil`
+
+Password, if authentication is needed to connect to
+CouchDB
+
+[id="plugins-{type}s-{plugin}-port"]
+===== `port` 
+
+  * Value type is <<number,number>>
+  * Default value is `5984`
+
+Port of your CouchDB instance.
+
+[id="plugins-{type}s-{plugin}-reconnect_delay"]
+===== `reconnect_delay` 
+
+  * Value type is <<number,number>>
+  * Default value is `10`
+
+Reconnect delay: time between reconnect attempts, in seconds.
+
+[id="plugins-{type}s-{plugin}-secure"]
+===== `secure` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Connect to CouchDB's _changes feed securely (via https)
+Default: false (via http)
+
+[id="plugins-{type}s-{plugin}-sequence_path"]
+===== `sequence_path` 
+
+  * Value type is <<string,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`
+
+[id="plugins-{type}s-{plugin}-timeout"]
+===== `timeout` 
+
+  * Value type is <<number,number>>
+  * There is no default value for this setting.
+
+Timeout: Number of milliseconds to wait for new data before
+terminating the connection.  If a timeout is set it will disable
+the heartbeat configuration option.
+
+[id="plugins-{type}s-{plugin}-username"]
+===== `username` 
+
+  * Value type is <<string,string>>
+  * Default value is `nil`
+
+Username, if authentication is needed to connect to
+CouchDB
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-input-couchdb_changes.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-couchdb_changes'
-  s.version         = '3.1.1'
+  s.version         = '3.1.2'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This input captures the _changes stream from a CouchDB instance"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-couchdb_changes
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-20 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -127,6 +127,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/inputs/couchdb_changes.rb
 - logstash-input-couchdb_changes.gemspec
 - spec/inputs/ca_cert.pem