logstash-output-riemann 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2ea250e17584a63e3fe0913f3163184563f70dc
-  data.tar.gz: f7f14e55e1945b721075272918a53107755d4c94
+  metadata.gz: 9a6691d3d4600fd420f3d6f9559a24d8ff71a429
+  data.tar.gz: 7124df74d4c3889c25c0689a8a4700f5141c6b0a
 SHA512:
-  metadata.gz: 239a290f27a0191afdf2628e4a57107d316c2d0070e1cc88c3e8fbacbb13c477da253f45f30a945a40157dafcf1ae0b4473802ebbf4bd3316ad9173d12c31f06
-  data.tar.gz: 90bf0f4d401c035e2f617903eb8137c87168124f61be5f03a8f68a6f5904e1cacb5407c0c15f47a86d56e4b909b20b9d0e0a309f97f5fad84ea4c928d11f8136
+  metadata.gz: e1b77bed0fa58c719c8a85f34f6e402eea96abfc96255096a00136aa72e550bad90d5420cffcc3a9ef53338ba2e5a44ca25fc4cdb73ff7653691c6029c7aba3c
+  data.tar.gz: b5f42724566690d3a1edcdafab9163c513b23b635a31c9e44ce8c88b5434fc118394d417b498eb361d6c015525ee23094254eeb061eb400c56d7b294028c5088

data/CONTRIBUTORS

@@ -11,6 +11,7 @@ Contributors:
 * Marc Fournier (mfournier)
 * Pier-Hugues Pellerin (ph)
 * Richard Pijnenburg (electrical)
+* Jacob Hitze (jhitze)
 
 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

data/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -13,7 +13,7 @@ Logstash provides infrastructure to automatically generate documentation for thi
 
 ## Need Help?
 
-Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
 
 ## Developing
 

data/lib/logstash/outputs/riemann.rb

@@ -107,23 +107,30 @@ class LogStash::Outputs::Riemann < LogStash::Outputs::Base
 
   public
   def map_fields(parent, fields)
-    fields.each {|key, val|
-      if !key.start_with?("@")
-        field = parent.nil? ? key : parent + '.' + key
-        contents = val                            
-        if contents.is_a?(Hash)                                     
-          map_fields(field, contents)                                       
-        else                                                                                  
-          @my_event[field.to_sym] = contents                                                          
-        end
+    this_level = Hash.new
+    fields.each do |key, contents|
+      next if key.start_with?("@")
+      field = parent.nil? ? key : "#{parent}.#{key}"                         
+      if contents.is_a?(Hash)                                     
+        this_level.merge! map_fields(field, contents)                                       
+      else                                                                                  
+        this_level[field.to_sym] = contents                                                          
       end
-    }                 
+    end
+    return this_level
   end
 
   public
   def receive(event)
     return unless output?(event)
 
+    r_event = build_riemann_formatted_event(event)
+    
+    @logger.debug("Riemann event: ", :riemann_event => r_event)
+    send_to_riemann(r_event)
+  end # def receive
+
+  def build_riemann_formatted_event(event)
     # Let's build us an event, shall we?
     r_event = Hash.new
     r_event[:host] = event.sprintf(@sender)
@@ -140,18 +147,21 @@ class LogStash::Outputs::Riemann < LogStash::Outputs::Base
       end
     end
     if @map_fields == true
-      @my_event = Hash.new
-      map_fields(nil, event)
-      r_event.merge!(@my_event) {|key, val1, val2| val1}
+      r_event.merge! map_fields(nil, event.to_hash)
     end
     r_event[:tags] = event["tags"] if event["tags"].is_a?(Array)
-    @logger.debug("Riemann event: ", :riemann_event => r_event)
+
+    return r_event
+  end
+
+  def send_to_riemann(riemann_formatted_event)
     begin
       proto_client = @client.instance_variable_get("@#{@protocol}")
       @logger.debug("Riemann client proto: #{proto_client.to_s}")
-      proto_client << r_event
+      proto_client << riemann_formatted_event
     rescue Exception => e
       @logger.debug("Unhandled exception", :error => e)
     end
-  end # def receive
+  end # def send_to_riemann
+
 end # class LogStash::Outputs::Riemann

data/logstash-output-riemann.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-riemann'
-  s.version         = '0.1.4'
+  s.version         = '0.2.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Riemann is a network event stream processing system."
   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"
@@ -25,5 +25,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'riemann-client', ['0.2.1']
 
   s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency "logstash-codec-plain"
 end
 

data/spec/outputs/riemann_spec.rb

@@ -1 +1,114 @@
 require "logstash/devutils/rspec/spec_helper"
+require "logstash/plugin"
+require "logstash/json"
+
+describe "outputs/riemann" do
+
+  context "registration" do
+
+    it "should register" do
+      output = LogStash::Plugin.lookup("output", "riemann").new
+      expect {output.register}.not_to raise_error
+    end
+
+    context "protocol" do
+      it "should fail if not set to [tcp] or [udp]" do
+        expect {
+          output = LogStash::Plugin.lookup("output", "riemann").new("protocol" => "fake")
+          output.register
+          }.to raise_error
+      end
+
+      it "should not error out if set to [tcp]" do
+        expect {
+          output = LogStash::Plugin.lookup("output", "riemann").new("protocol" => "tcp")
+          output.register
+          }.not_to raise_error
+      end
+
+      it "should not error out if set to [udp]" do
+        expect {
+          output = LogStash::Plugin.lookup("output", "riemann").new("protocol" => "udp")
+          output.register
+          }.not_to raise_error
+      end
+
+    end
+  end
+
+  context "receive" do
+
+    output = LogStash::Plugin.lookup("output", "riemann").new
+    data = {"message"=>"hello", "@version"=>"1", "@timestamp"=>"2015-06-03T23:34:54.076Z", "host"=>"vagrant-ubuntu-trusty-64"}
+    event = LogStash::Event.new data
+
+    it "should accept the event" do
+
+      expect{
+        output.receive event
+        }.not_to raise_error
+    end
+
+  end
+
+  context "map_fields" do
+
+    context "with basic data" do
+
+      it "will return keys that do not start with @ sign." do
+        data = {"message"=>"hello", "@version"=>"1", "@timestamp"=>"2015-06-03T23:34:54.076Z", "host"=>"vagrant-ubuntu-trusty-64"}
+        expected_data = {:message=>"hello", :host=>"vagrant-ubuntu-trusty-64"}
+        output = LogStash::Plugin.lookup("output", "riemann").new
+        expect(output.map_fields(nil, data)).to eq expected_data
+      end
+
+      it "will return a hash of nested values" do
+        data = {"message"=>"hello", "node_info" => {"name" => "node1", "status" => "up"}, "@version"=>"1", "@timestamp"=>"2015-06-03T23:34:54.076Z", "host"=>"vagrant-ubuntu-trusty-64"}
+        expected_data = {:message =>"hello", :host =>"vagrant-ubuntu-trusty-64", :"node_info.name" => "node1", :"node_info.status" => "up"}
+        output = LogStash::Plugin.lookup("output", "riemann").new
+        expect(output.map_fields(nil, data)).to eq expected_data
+      end
+
+    end
+  end
+
+  context "build_riemann_formatted_event" do
+
+    context "with map_fields" do
+
+      it "will return symboled hash with at least :host, :time, and :description" do
+        data = {"message"=>"hello", "node_info" => {"name" => "node1", "status" => "up"}, "@version"=>"1", "@timestamp"=>"2015-06-03T23:34:54.076Z", "host"=>"vagrant-ubuntu-trusty-64"}
+        expected_data = {:time=>1433374494, :message =>"hello", :description =>"hello", :host =>"vagrant-ubuntu-trusty-64", :"node_info.name" => "node1", :"node_info.status" => "up"}
+        event = LogStash::Event.new data
+        output = LogStash::Plugin.lookup("output", "riemann").new("map_fields" => "true")
+        expect(output.build_riemann_formatted_event(event)).to eq expected_data
+      end
+
+    end
+
+    context "without map_fields" do
+
+      it "will return symboled hash with at least :host, :time, and :description" do
+        data = {"message"=>"hello", "node_info" => {"name" => "node1", "status" => "up"}, "@version"=>"1", "@timestamp"=>"2015-06-03T23:34:54.076Z", "host"=>"vagrant-ubuntu-trusty-64"}
+        expected_data = {:time=>1433374494, :description =>"hello", :host =>"vagrant-ubuntu-trusty-64"}
+        event = LogStash::Event.new data
+        output = LogStash::Plugin.lookup("output", "riemann").new
+        expect(output.build_riemann_formatted_event(event)).to eq expected_data
+      end
+
+    end
+
+    context "with tags" do
+
+      it "will return a symboled tags with multiple tags" do
+        data = {"tags"=> ["good_enough", "smart_enough", "doggone_it", "people_like_me"], "message"=>"hello", "node_info" => {"name" => "node1", "status" => "up"}, "@version"=>"1", "@timestamp"=>"2015-06-03T23:34:54.076Z", "host"=>"vagrant-ubuntu-trusty-64"}
+        expected_data = {:tags => ["good_enough", "smart_enough", "doggone_it", "people_like_me"], :time=>1433374494, :description =>"hello", :host =>"vagrant-ubuntu-trusty-64"}
+        event = LogStash::Event.new data
+        output = LogStash::Plugin.lookup("output", "riemann").new
+        expect(output.build_riemann_formatted_event(event)).to eq expected_data
+      end
+
+    end
+
+  end
+end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-riemann
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -19,10 +20,7 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
-  name: logstash-core
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -30,34 +28,50 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
+  name: riemann-client
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.2.1
-  name: riemann-client
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.2.1
-- !ruby/object:Gem::Dependency
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-devutils
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
 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: []
@@ -65,9 +79,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
+- NOTICE.TXT
 - README.md
 - Rakefile
 - lib/logstash/outputs/riemann.rb