logstash-output-riemann 3.0.5 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85caaf3052157cbfd5d02c408e0527af63114d130545dddd04c8e0d69ebe576b
-  data.tar.gz: 37ad79c4b0ccc29bf1f29d9261db0719eb06090fa80d123efb2dd9beb38935f8
+  metadata.gz: 9ddddc40b53622a112fae7d25ea1213cec31fb04e74b9cdc63e1166d1077305a
+  data.tar.gz: 50a5b1ad896329d8b7cd9c22abbc263a1d9e7adee5c62dd589ee9fd57b1c03d6
 SHA512:
-  metadata.gz: 5374862b1d760372a45784b881a180324e5a920a95ff1b797b970e2d181c16942dbcbaf37b32cb4fb8c122911126f05eabbd24b6ad87c5b2126a434996187925
-  data.tar.gz: 5c0873f32eb125e97e52bb6003777a96723e68da32ecff5327f2f502afb18fb8762cd2e9db80812e60a82965c3bc62518dee62511156a459c226c43a9c68fc5f
+  metadata.gz: f5146f3b43a15f1fe804c1318631f6f8058dfae6dfc28aaed53c4b82debdb732572d2c10956e9649e0fb833515720219dd0573dbe43b1b228717c6029622f783
+  data.tar.gz: 3ce91213a6d974b4d8bad414659a6c8a8b046ad9868f9bbea461b4c6ad8c1e889388d29994ea29d7bd0e805d4f008b12b34a630a14d2fd69221059f3b8f85bf1

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 3.0.6
+  - Fix values from "riemann_event" not overwriting those from "map_fields".
+    [#22](https://github.com/logstash-plugins/logstash-output-riemann/issues/22)
+  - Fix ttl, metric sometimes being sent as string, not float.
+    [#23](https://github.com/logstash-plugins/logstash-output-riemann/issues/23)
+
 ## 3.0.5
   - Fix formatting in doc for conversion to --asciidoctor [#21](https://github.com/logstash-plugins/logstash-output-riemann/pull/21)
 

data/lib/logstash/outputs/riemann.rb

@@ -132,24 +132,37 @@ class LogStash::Outputs::Riemann < LogStash::Outputs::Base
     # Let's build us an event, shall we?
     r_event = Hash.new
 
+    # Always copy "message" to Riemann's "description" field.
     r_event[:description] = event.get("message")
 
+    # Directly map all other fields, if requested. Note that the "message" field
+    # will also be mapped this way, so if it's present, it will become a
+    # redundant copy of "description".
+    if @map_fields == true
+      r_event.merge! map_fields(nil, event.to_hash)
+    end
+
+    # Fields specified in the "riemann_event" configuration option take
+    # precedence over mapped fields.
     if @riemann_event
       @riemann_event.each do |key, val|
-        if ["ttl","metric"].include?(key)
-          r_event[key.to_sym] = event.sprintf(val).to_f
-        else
-          r_event[key.to_sym] = event.sprintf(val)
-        end
+        r_event[key.to_sym] = event.sprintf(val)
       end
     end
-    if @map_fields == true
-      r_event.merge! map_fields(nil, event.to_hash)
-    end
+
+    # Riemann event attributes are always strings, with a few critical
+    # exceptions. "ttl" and "metric" should be sent as float values.
+    r_event[:ttl] = r_event[:ttl].to_f if r_event[:ttl]
+    r_event[:metric] = r_event[:metric].to_f if r_event[:metric]
+
+    # Similarly, event _time_ in Riemann was historically an integer value.
+    # While current Riemann versions support sub-second time resolution in the
+    # form of a float, we currently ensure that we send an integer value, as
+    # expected by Riemann versions earlier than 0.2.13.
+    r_event[:time] = event.timestamp.to_i
+
     r_event[:tags] = event.get("tags") if event.get("tags").is_a?(Array)
     r_event[:host] = event.sprintf(@sender)
-    # riemann doesn't handle floats so we reduce the precision here
-    r_event[:time] = event.timestamp.to_i
 
     return r_event
   end

data/logstash-output-riemann.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-riemann'
-  s.version         = '3.0.5'
+  s.version         = '3.0.6'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Sends metrics to Riemann"
   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"

data/spec/outputs/riemann_spec.rb

@@ -90,6 +90,49 @@ describe "outputs/riemann" do
         output.sender = "%{test_hostname}"
         expect(output.build_riemann_formatted_event(event)).to eq expected_data
       end
+
+      it "will overwrite mapped fields with their equivalent configuration options" do
+        mapped_fields = {
+          "description" => "old description",
+          "metric" => 1.0,
+          "service" => "old service",
+          "state" => "old state",
+          "ttl" => 1,
+        }
+
+        configuration_options = {
+          "description" => "new description",
+          "metric" => 2.0,
+          "service" => "new service",
+          "state" => "new state",
+          "ttl" => 2,
+        }
+
+        incoming_event = LogStash::Event.new(mapped_fields)
+        output.riemann_event = configuration_options
+        outgoing_event = output.build_riemann_formatted_event(incoming_event)
+
+        expect(outgoing_event[:description]).to eq("new description")
+        expect(outgoing_event[:metric]).to eq(2.0)
+        expect(outgoing_event[:service]).to eq("new service")
+        expect(outgoing_event[:state]).to eq("new state")
+        expect(outgoing_event[:ttl]).to eq(2)
+      end
+
+      it "will set float values for ttl and metric from string values in fields" do
+        mapped_fields = {
+          "ttl" => "300",
+          "metric" => "423.5"
+        }
+
+        incoming_event = LogStash::Event.new(mapped_fields)
+        outgoing_event = output.build_riemann_formatted_event(incoming_event)
+
+        expect(outgoing_event[:ttl]).to be_a(Float)
+        expect(outgoing_event[:ttl]).to eq(300)
+        expect(outgoing_event[:metric]).to be_a(Float)
+        expect(outgoing_event[:metric]).to eq(423.5)
+      end
     end
 
     context "without map_fields" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-riemann
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.0.6
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2020-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement