logstash-input-ganglia 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afff6d6653cf93e834f5eca6138e2d76b81107dc
-  data.tar.gz: 33c18b9a4701b3078477453497d47f33b1f6e577
+  metadata.gz: 71cfd820410aba1f3fcee3e1d1cd963192d863c1
+  data.tar.gz: 80457ceb8255e222c9a4263205b4f180359d69ea
 SHA512:
-  metadata.gz: b7bd5e21e738161fdf32b8342b1cb3ef9c2ee779dfe584081b061cdf94d59aa3d5ed01217a4d4fa668f0d1345d9472ec46ddf0d7f17933b1a0638b258c206289
-  data.tar.gz: e78ad3f0c154f413d6271ec27560c6f4f4b5927837691bfc55816fcb0c4549a3667abf08a997faec25f7edf64f0ee3515acd3b9dcbfeffa2a8f577c9ca587200
+  metadata.gz: 04113be3367ca462c08d3a69b79aede4eecc09d97f0619c8cddb7f0663d7effa2a29a7d752f05abd6fa6c61cd53093d0d7a3d33d7f15e5349056e6f3b1f221b3
+  data.tar.gz: 46ab77ddc51305944c38dd511e3307fcb7a97f74bcb6c04f6313ede4ce1e3da22e6a0fb9e165066e3c18ece35e60ea4d1d899dabed5cdd61b630adaad859785d

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# 1.0.1
+   - Add test to the plugin
+   - Fix dependencies and a bug with event generation to make the plugin
+     stable again.

data/README.md

@@ -1,15 +1,15 @@
 # Logstash Plugin
 
-This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+This is a plugin for [Logstash](https://github.com/elastic/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/).
+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.elastic.co/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
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
 
 ## Need Help?
 
@@ -83,4 +83,4 @@ Programming is not a required skill. Whatever you've seen about open source and
 
 It is more important to the community that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/ganglia.rb

@@ -1,11 +1,10 @@
 # encoding: utf-8
 require "date"
-require "logstash/filters/grok"
-require "logstash/filters/date"
 require "logstash/inputs/ganglia/gmondpacket"
 require "logstash/inputs/base"
 require "logstash/namespace"
 require "socket"
+require "stud/interval"
 
 # Read ganglia packets from the network via udp
 #
@@ -24,7 +23,6 @@ class LogStash::Inputs::Ganglia < LogStash::Inputs::Base
   public
   def initialize(params)
     super
-    @shutdown_requested = false
     BasicSocket.do_not_reverse_lookup = true
   end # def initialize
 
@@ -37,11 +35,11 @@ class LogStash::Inputs::Ganglia < LogStash::Inputs::Base
     begin
       udp_listener(output_queue)
     rescue => e
-      if !@shutdown_requested
+      if !stop?
         @logger.warn("ganglia udp listener died",
                      :address => "#{@host}:#{@port}", :exception => e,
         :backtrace => e.backtrace)
-        sleep(5)
+        Stud.stoppable_sleep(5) { stop? }
         retry
       end
     end # begin
@@ -51,17 +49,24 @@ class LogStash::Inputs::Ganglia < LogStash::Inputs::Base
   def udp_listener(output_queue)
     @logger.info("Starting ganglia udp listener", :address => "#{@host}:#{@port}")
 
-    if @udp
-      @udp.close_read
-      @udp.close_write
-    end
+    @udp.close if @udp
 
     @udp = UDPSocket.new(Socket::AF_INET)
     @udp.bind(@host, @port)
 
     @metadata = Hash.new if @metadata.nil?
-    loop do
-      packet, client = @udp.recvfrom(9000)
+    while !stop?
+      packet = ""
+      begin
+        packet, client = @udp.recvfrom_nonblock(9000)
+      rescue IO::WaitReadable
+       # The socket is still not active and readable so the
+       # read operation fails
+       packet = ""
+      end
+      # recvfrom_nonblock return packet == String.empty? when no data is in the buffers,
+      # we reused this same error code for IO:WaitReadable exception handler.
+      next if packet.empty?
       # TODO(sissel): make this a codec...
       e = parse_packet(packet)
       unless e.nil?
@@ -77,19 +82,16 @@ class LogStash::Inputs::Ganglia < LogStash::Inputs::Base
   private
 
   public
-  def teardown
-    @shutdown_requested = true
+  def stop
     close_udp
-    finished
   end
 
   private
   def close_udp
     if @udp
-      @udp.close_read rescue nil
-      @udp.close_write rescue nil
+      @udp.close
+      @udp = nil
     end
-    @udp = nil
   end
 
   public
@@ -109,15 +111,11 @@ class LogStash::Inputs::Ganglia < LogStash::Inputs::Base
 
       # Check if it was a valid data request
       return nil unless data
-
-      event=LogStash::Event.new
-
-      data["program"] = "ganglia"
-      event["log_host"] = data["hostname"]
+      props={ "program" => "ganglia", "log_host" => data["hostname"] }
       %w{dmax tmax slope type units}.each do |info|
-        event[info] = @metadata[data["name"]][info]
+        props[info] = @metadata[data["name"]][info]
       end
-      return event
+      return LogStash::Event.new(props)
     else
       # Skipping unknown packet types
       return nil

data/logstash-input-ganglia.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-ganglia'
-  s.version         = '1.0.0'
+  s.version         = '2.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Read ganglia packets from the network via udp"
   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"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
@@ -20,9 +20,12 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
-
+  s.add_runtime_dependency "logstash-core", "~> 2.0.0.snapshot"
+  s.add_runtime_dependency 'stud', '~> 0.0.22'
   s.add_runtime_dependency 'logstash-codec-plain'
+
   s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'gmetric'
+
 end
 

data/spec/inputs/ganglia_spec.rb

@@ -1 +1,66 @@
-require "logstash/devutils/rspec/spec_helper"
+# encoding: utf-8
+require_relative "../spec_helper"
+require "logstash/plugin"
+require "logstash/event"
+
+describe LogStash::Inputs::Ganglia do
+
+  let(:properties) { {:name => "foo" } }
+  let(:event)      { LogStash::Event.new(properties) }
+
+  it "should register without errors" do
+    plugin = LogStash::Plugin.lookup("input", "ganglia").new({})
+    expect { plugin.register }.to_not raise_error
+  end
+
+  describe "when interrupting the plugin" do
+    it_behaves_like "an interruptible input plugin" do
+      let(:config) { {} }
+    end
+  end
+
+  describe "connection" do
+    let(:nevents)  { 10 }
+    let(:port)     { rand(1024..65532) }
+
+    let(:conf) do
+      <<-CONFIG
+        input {
+          ganglia {
+            port => #{port}
+         }
+       }
+      CONFIG
+    end
+    let(:data) do
+      {  :name => 'pageviews',
+         :units => 'req/min',
+         :type => 'uint8',
+         :value => 7000,
+         :tmax => 60,
+         :dmax => 300,
+         :group => 'test' }
+    end
+
+    let(:client) { GangliaClient.new("0.0.0.0", port) }
+
+    let(:events) do
+      input(conf, nevents) do
+        nevents.times do |value|
+          client.send(data)
+        end
+      end
+    end
+
+    let(:event) { events[0] }
+
+    it "should receive and generate proper number of events" do
+      expect(events.count).to be(nevents)
+    end
+
+    it "should receive the correct data" do
+      expect(event["tmax"]).to eq(60)
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/ganglia"
+require "support/client"
+
+module GangliaHelpers
+
+  def setup_clients(number_of_clients, port)
+    number_of_clients.times.inject([]) do |clients|
+      clients << GangliaClient.new(localhost, port)
+    end
+  end
+
+  def input(config, size, &block)
+    pipeline = LogStash::Pipeline.new(config)
+    queue = Queue.new
+
+    pipeline.instance_eval do
+      # create closure to capture queue
+      @output_func = lambda { |event| queue << event }
+
+      # output_func is now a method, call closure
+      def output_func(event)
+        @output_func.call(event)
+      end
+    end
+
+    pipeline_thread = Thread.new { pipeline.run }
+    sleep 0.1 while !pipeline.ready?
+
+    block.call
+    sleep 0.1 while queue.size != size
+
+    result = size.times.inject([]) do |acc|
+      acc << queue.pop
+    end
+
+    pipeline.shutdown
+    pipeline_thread.join
+
+    result
+  end # def input
+
+end
+
+RSpec.configure do |c|
+  c.include GangliaHelpers
+end

data/spec/support/client.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require "socket"
+require "gmetric"
+
+class GangliaClient
+
+  attr_reader :addr, :port, :socket
+
+  def initialize(addr, port)
+    @addr   = addr
+    @port   = port
+    @socket = UDPSocket.new
+    socket.connect(addr, port)
+  end
+
+  def send(data={})
+    g = Ganglia::GMetric.pack(data)
+    @socket.send(g[0], 0)
+    @socket.send(g[1], 0)
+  end
+end

metadata

@@ -1,82 +1,104 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-ganglia
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.snapshot
   name: logstash-core
+  prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.0.snapshot
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 0.0.22
+  name: stud
   prerelease: false
   type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.22
 - !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
   name: logstash-devutils
+  prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: gmetric
   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@elastic.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - CHANGELOG.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
 - NOTICE.TXT
 - README.md
-- Rakefile
 - lib/logstash/inputs/ganglia.rb
 - lib/logstash/inputs/ganglia/gmondpacket.rb
 - lib/logstash/inputs/ganglia/xdr.rb
 - logstash-input-ganglia.gemspec
 - spec/inputs/ganglia_spec.rb
+- spec/spec_helper.rb
+- spec/support/client.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
@@ -99,9 +121,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Read ganglia packets from the network via udp
 test_files:
 - spec/inputs/ganglia_spec.rb
+- spec/spec_helper.rb
+- spec/support/client.rb

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-Gemfile.lock
-.bundle
-vendor

data/Rakefile

@@ -1,7 +0,0 @@
-@files=[]
-
-task :default do
-  system("rake -T")
-end
-
-require "logstash/devutils/rake"