logstash-filter-zeromq 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 805ec830b29b759a0a465eebe293a64bc30ab6ae
-  data.tar.gz: ef4b5ee14cd8c0b682aabfc371826d66def96099
+  metadata.gz: 19d2928eb0786bb730621f06018a08996eadc32f
+  data.tar.gz: 3804a64906fd0b521e7ee9c8e5477b33947fe04e
 SHA512:
-  metadata.gz: 944e34ba52961ce0460b5e772472d30e5ec6fde6562e9b62cc394f75a79ec9f84f647767e2fd13e13b693917db9b74e9a57a859b73a66a8ba220df6c8d2ef567
-  data.tar.gz: 5341e9f00aa37bf6a3e1021228a7249f579f6a6e3e57dd824ac49ea6ee86a7959e4004ff8beaec289f99dcf7f3db06f1077f3495957a5a231193547f47048690
+  metadata.gz: 8adaa3ff81db875997068035629b62b322aab07c8c7feae84c3bc60504f4ed39ebd840df11dcd408ea3ed6bff94a126a009b1a9cebc97d83e23cae07d2525920
+  data.tar.gz: 8d54862c183966262fcbdc16ef79c7898de02069f5cce1c142e89ef0447edf7d4619d05b65a926facbb88b21a499294dc945a39e6143ca52cc6e3b0a6418797e

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
-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,148 @@
+:plugin: zeromq
+:type: filter
+
+///////////////////////////////////////////
+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}"]
+
+=== Zeromq filter plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+ZeroMQ filter. This is the best way to send an event externally for filtering
+It works much like an exec filter would by sending the event "offsite"
+for processing and waiting for a response
+
+The protocol here is:
+  * REQ sent with JSON-serialized logstash event
+  * REP read expected to be the full JSON 'filtered' event
+  * - if reply read is an empty string, it will cancel the event.
+
+Note that this is a limited subset of the zeromq functionality in
+inputs and outputs. The only topology that makes sense here is:
+REQ/REP. bunde
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Zeromq Filter 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}-add_tag_on_timeout>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-address>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-field>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-mode>> |<<string,string>>, one of `["server", "client"]`|No
+| <<plugins-{type}s-{plugin}-retries>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-sentinel>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-sockopt>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-timeout>> |<<number,number>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+filter plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-add_tag_on_timeout"]
+===== `add_tag_on_timeout` 
+
+  * Value type is <<string,string>>
+  * Default value is `"zeromqtimeout"`
+
+tag to add if zeromq timeout expires before getting back an answer.
+If set to "" then no tag will be added.
+
+[id="plugins-{type}s-{plugin}-address"]
+===== `address` 
+
+  * Value type is <<string,string>>
+  * Default value is `"tcp://127.0.0.1:2121"`
+
+0mq socket address to connect or bind
+Please note that inproc:// will not work with logstash
+as we use a context per thread
+By default, filters connect
+
+[id="plugins-{type}s-{plugin}-field"]
+===== `field` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The field to send off-site for processing
+If this is unset, the whole event will be sent
+
+[id="plugins-{type}s-{plugin}-mode"]
+===== `mode` 
+
+  * Value can be any of: `server`, `client`
+  * Default value is `"client"`
+
+0mq mode
+server mode binds/listens
+client mode connects
+
+[id="plugins-{type}s-{plugin}-retries"]
+===== `retries` 
+
+  * Value type is <<number,number>>
+  * Default value is `3`
+
+number of retries, used for both sending and receiving messages.
+for sending, retries should return instantly.
+for receiving, the total blocking time is up to retries X timeout,
+which by default is 3 X 500 = 1500ms
+
+[id="plugins-{type}s-{plugin}-sentinel"]
+===== `sentinel` 
+
+  * Value type is <<string,string>>
+  * Default value is `""`
+
+A sentinel value to signal the filter to cancel the event
+If the peer returns the sentinel value, the event will be cancelled
+
+[id="plugins-{type}s-{plugin}-sockopt"]
+===== `sockopt` 
+
+  * Value type is <<hash,hash>>
+  * There is no default value for this setting.
+
+0mq socket options
+This exposes zmq_setsockopt
+for advanced tuning
+see http://api.zeromq.org/2-1:zmq-setsockopt for details
+
+This is where you would set values like:
+ZMQ::HWM - high water mark
+ZMQ::IDENTITY - named queues
+ZMQ::SWAP_SIZE - space for disk overflow
+ZMQ::SUBSCRIBE - topic filters for pubsub
+
+example: sockopt => ["ZMQ::HWM", 50, "ZMQ::IDENTITY", "my_named_queue"]
+
+[id="plugins-{type}s-{plugin}-timeout"]
+===== `timeout` 
+
+  * Value type is <<number,number>>
+  * Default value is `500`
+
+timeout in milliseconds on which to wait for a reply.
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-filter-zeromq.gemspec

@@ -2,7 +2,7 @@ Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-zeromq'
 
-  s.version         = '3.0.0'
+  s.version         = '3.0.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "ZeroMQ filter. This is a way to send an event externally for filtering"
   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"
@@ -12,7 +12,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-filter-zeromq
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-10 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +70,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/filters/zeromq.rb
 - logstash-filter-zeromq.gemspec
 - spec/filters/zeromq_spec.rb