logstash-filter-zeromq 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3dcdef0b8b0bcd244c53f52988a55af838825ef
-  data.tar.gz: 0d5bf5f6fa3781c2a0a9d7a82dd312d882e4cf59
+  metadata.gz: 3336ef335289b2e7206f8ba04432bf589503e9f5
+  data.tar.gz: bcc8a759d9c2b371e073420b02046d6b157730be
 SHA512:
-  metadata.gz: 936eff3ec8d09106d1186e69a5efc0f689b221961eebb18dc2b4f2d8b03e595da41314ca4c9c7cc19d2384b97400426e702528c5ab6bf009e9f54f158f03c7d9
-  data.tar.gz: d53c4b023a10ac06d8726d0a6f9171a503de0fe74a538550f8543374eeddc3fec2397eb324752a58290a956e1ba617d3b317238287b163b4c82cc0953022cafa
+  metadata.gz: 63a39e68ce51e635d9c3cfd1401c2c29e5f2d2b0d12e8b46bcebf11b3cca6f283448b908bb04ba5876cb89e5a15ad90cfdbee88bcda52a64ed8cf9cd87df0efd
+  data.tar.gz: c1513c4c39cd5700a55e2670299bb1a092b608bb362a50bb404c7dcdcc717e6f6a936274cae5820a57f41a9e605f4942edaf0eabc0b449aa655a5084e5ef666d

data/CONTRIBUTORS

@@ -0,0 +1,17 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Aaron Mildenstein (untergeek)
+* Colin Surprenant (colinsurprenant)
+* John E. Vincent (lusis)
+* Jordan Sissel (jordansissel)
+* Pete Fritchman (fetep)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+* Tom Howe (turtlebender)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,95 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to me that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/filters/zeromq.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 require "logstash/filters/base"
 require "logstash/namespace"
+require "logstash/json"
 
 # 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"
@@ -13,11 +14,10 @@ require "logstash/namespace"
 #
 # 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. 
+# REQ/REP. bunde
 class LogStash::Filters::ZeroMQ < LogStash::Filters::Base
 
   config_name "zeromq"
-  milestone 1
 
   # 0mq socket address to connect or bind
   # Please note that inproc:// will not work with logstash
@@ -38,10 +38,10 @@ class LogStash::Filters::ZeroMQ < LogStash::Filters::Base
 
   # timeout in milliseconds on which to wait for a reply.
   config :timeout, :validate => :number, :default => 500
-  
+
   # 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, 
+  # for receiving, the total blocking time is up to retries X timeout,
   # which by default is 3 X 500 = 1500ms
   config :retries, :validate => :number, :default => 3
 
@@ -118,13 +118,13 @@ class LogStash::Filters::ZeroMQ < LogStash::Filters::Base
   #will return a boolean for success, and a string containing one of several things:
   #  - empty string: response from server
   #  - updated string: response from server
-  #  - original message: could not send request or get response from server in time 
+  #  - original message: could not send request or get response from server in time
   private
   def send_recv(message)
     success = false
     @retries.times do
       @logger.debug("0mq: sending", :request => message)
-      rc = @zsocket.send_string(message) 
+      rc = @zsocket.send_string(message)
       if ZMQ::Util.resultcode_ok?(rc)
         success = true
         break
@@ -137,13 +137,13 @@ class LogStash::Filters::ZeroMQ < LogStash::Filters::Base
     #if we did not succeed log it and fail here.
     if not success
       @logger.warn("0mq: error sending message (zmq_errno = #{ZMQ::Util.errno}, zmq_error_string = '#{ZMQ::Util.error_string}'")
-      return success, message 
+      return success, message
     end
 
     #now get reply
     reply = ''
     success = false
-    @retries.times do 
+    @retries.times do
       @logger.debug("0mq: polling for reply for #{@timeout}ms.")
       #poll the socket. If > 0, something to read. If < 0, error. If zero, loop
       num_readable = @poller.poll(@timeout)
@@ -160,12 +160,12 @@ class LogStash::Filters::ZeroMQ < LogStash::Filters::Base
         connect
       end
     end # @retries.times
-     
+
     #if we maxed out on number of retries, then set reply to message so that
     #the event isn't cancelled. we want to carry on if the server is down.
-    if not success 
+    if not success
       @logger.warn("0mq: did not receive reply (zmq_errno = #{ZMQ::Util.errno}, zmq_error_string = '#{ZMQ::Util.error_string}'")
-      return success, message 
+      return success, message
     end
 
     return success, reply
@@ -193,7 +193,7 @@ class LogStash::Filters::ZeroMQ < LogStash::Filters::Base
         event[@field] = event.sprintf(reply)
         filter_matched(event)
       else
-        reply = JSON.parse(reply)
+        reply = LogStash::Json.load(reply)
         event.overwrite(reply)
       end
       filter_matched(event)

data/lib/logstash/util/zeromq.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+require 'ffi-rzmq'
+require "logstash/namespace"
+
+module LogStash::Util::ZeroMQ
+  CONTEXT = ZMQ::Context.new
+  # LOGSTASH-400
+  # see https://github.com/chuckremes/ffi-rzmq/blob/master/lib/ffi-rzmq/socket.rb#L93-117
+  STRING_OPTS = %w{IDENTITY SUBSCRIBE UNSUBSCRIBE}
+
+  def context
+    CONTEXT
+  end
+
+  def setup(socket, address)
+    if server?
+      error_check(socket.bind(address), "binding to #{address}")
+    else
+      error_check(socket.connect(address), "connecting to #{address}")
+    end
+    @logger.info("0mq: #{server? ? 'connected' : 'bound'}", :address => address)
+  end
+
+  def error_check(rc, doing)
+    unless ZMQ::Util.resultcode_ok?(rc)
+      @logger.error("ZeroMQ error while #{doing}", { :error_code => rc })
+      raise "ZeroMQ Error while #{doing}"
+    end
+  end # def error_check
+
+  def setopts(socket, options)
+    options.each do |opt,value|
+      sockopt = opt.split('::')[1]
+      option = ZMQ.const_defined?(sockopt) ? ZMQ.const_get(sockopt) : ZMQ.const_missing(sockopt)
+      unless STRING_OPTS.include?(sockopt)
+        begin
+          Float(value)
+          value = value.to_i
+        rescue ArgumentError
+          raise "#{sockopt} requires a numeric value. #{value} is not numeric"
+        end
+      end # end unless
+      error_check(socket.setsockopt(option, value),
+              "while setting #{opt} == #{value}")
+    end # end each
+  end # end setopts
+end # module LogStash::Util::ZeroMQ

data/logstash-filter-zeromq.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-zeromq'
-  s.version         = '0.1.2'
+  s.version         = '0.1.3'
   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/plugin install gemname. This gem is not a stand-alone program"

metadata

@@ -1,18 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-zeromq
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-11-19 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: logstash
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -20,7 +19,10 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
-  requirement: !ruby/object:Gem::Requirement
+  name: logstash
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -28,36 +30,34 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
-  name: ffi-rzmq
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.0.0
+  name: ffi-rzmq
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: logstash-devutils
   prerelease: false
   type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
 email: info@elasticsearch.com
 executables: []
@@ -65,9 +65,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CONTRIBUTORS
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - lib/logstash/filters/zeromq.rb
+- lib/logstash/util/zeromq.rb
 - logstash-filter-zeromq.gemspec
 - spec/filters/zeromq_spec.rb
 homepage: http://www.elasticsearch.org/guide/en/logstash/current/index.html
@@ -92,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.4
+rubygems_version: 2.1.9
 signing_key:
 specification_version: 4
 summary: ZeroMQ filter. This is a way to send an event externally for filtering