logstash-output-riemann 3.0.2 → 3.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ddef2da19103721e1c9a9c69b7a004740f8be359
-  data.tar.gz: 5c22e0427e4e94fe5342aa075364b0a50921ae2d
+SHA256:
+  metadata.gz: aff75bfc4567e237667e2d2c5da80a18d3224141745b8a56e84caf8199baa321
+  data.tar.gz: 9e68a91cdc5363fef2ac012de91beba80e3ef245959ead2c4643667b1316e7b5
 SHA512:
-  metadata.gz: effb3fe07304e098091a1d681689cb75721177d1439a50e890900a06e4827c0104a4c286381d0367891e6af6bcc9e1cfea42fd37a70c7a09829219b352299e64
-  data.tar.gz: 14ca70679a969eeaebeb9bbc56ff3a831f83c600772393efa8edfc5fb80cf32d83eb07a606a8a6853a1f77e35669c15b1377085ad8a35d5abaa60211c84769a7
+  metadata.gz: 63ec344661e0722a9b4d30be5ad01a6493ea830173f8a2bcaf2d42bbcf4550660affd52b0a05df42cbde2edc36607bff74a096b33e30e76c77d0ad1ede1d68c4
+  data.tar.gz: a5c17a9bd144e36192812701d6caef82067cc47e80f739b7f121f58e68954e81890d2fa686dc0cee3993dd112b5302d8c17f55ac6ad68fc77113280d05afb355

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 3.0.7
+  - Updated riemann-client gem to 0.2.6 to benefit timeout support [#26](https://github.com/logstash-plugins/logstash-output-riemann/pull/26)
+
+## 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)
+
+## 3.0.4
+  - Docs: Set the default_codec doc attribute.
+
+## 3.0.3
+  - Update gemspec summary
+
 ## 3.0.2
   - Fix some documentation issues
 

data/CONTRIBUTORS

@@ -4,6 +4,7 @@ reports, or in general have helped logstash along its way.
 Contributors:
 * Aaron Mildenstein (untergeek)
 * Cameron Stokes (clstokes)
+* Colin Surprenant (colinsurprenant)
 * John E. Vincent (lusis)
 * Jonas Tehler (jegt)
 * Jordan Sissel (jordansissel)

data/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
 
-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
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-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.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   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/docs/index.asciidoc

@@ -1,5 +1,6 @@
 :plugin: riemann
 :type: output
+:default_codec: plain
 
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
@@ -31,7 +32,9 @@ outputs
 You can learn about Riemann here:
 
 * http://riemann.io/
+
 You can see the author talk about it here:
+
 * http://vimeo.com/38377415
 
 
@@ -85,7 +88,9 @@ All nested logstash fields will be mapped to riemann fields containing all paren
 separated by dots and the deepest value.
 
 As an example, the logstash event:
+
 [source,ruby]
+-----
    {
      "@timestamp":"2013-12-10T14:36:26.151+0000",
      "@version": 1,
@@ -95,14 +100,19 @@ As an example, the logstash event:
                        "key": "value"
                      }
    }
+-----
+
 Is mapped to this riemann event:
+
 [source,ruby]
+-----
   {
     :time 1386686186,
     :host host.domain.com,
     :message log message,
     :nested_field.key value
   }
+-----
 
 It can be used in conjunction with or independent of the riemann_event option.
 When used with the riemann_event any duplicate keys receive their value from
@@ -149,12 +159,14 @@ Any other field set here will be passed to Riemann as an event attribute.
 
 Example:
 [source,ruby]
+-----
     riemann {
         riemann_event => {
             "metric"  => "%{metric}"
             "service" => "%{service}"
         }
     }
+-----
 
 `metric` and `ttl` values will be coerced to a floating point value.
 Values which cannot be coerced will zero (0.0).
@@ -175,4 +187,6 @@ in the Riemann event
 
 
 [id="plugins-{type}s-{plugin}-common-options"]
-include::{include_path}/{type}.asciidoc[]
+include::{include_path}/{type}.asciidoc[]
+
+:default_codec!:

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,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-riemann'
-  s.version         = '3.0.2'
+  s.version         = '3.0.7'
   s.licenses        = ['Apache License (2.0)']
-  s.summary         = "Riemann is a network event stream processing system."
+  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"
   s.authors         = ["Elastic"]
   s.email           = 'info@elastic.co'
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   # Gem dependencies
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
 
-  s.add_runtime_dependency 'riemann-client', ['0.2.1']
+  s.add_runtime_dependency 'riemann-client', "~> 0.2.6"
 
   s.add_development_dependency 'logstash-devutils'
   s.add_development_dependency "logstash-codec-plain"

data/spec/outputs/riemann_spec.rb

@@ -16,7 +16,7 @@ describe "outputs/riemann" do
         expect {
           output = LogStash::Plugin.lookup("output", "riemann").new("protocol" => "fake")
           output.register
-          }.to raise_error
+          }.to raise_error(LogStash::ConfigurationError)
       end
 
       it "should not error out if set to [tcp]" do
@@ -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.2
+  version: 3.0.7
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -33,17 +33,17 @@ dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.6
   name: riemann-client
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.6
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -72,7 +72,9 @@ dependencies:
     - - ">="
       - !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/logstash-plugin install gemname. This gem is not a stand-alone program
+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
 email: info@elastic.co
 executables: []
 extensions: []
@@ -110,9 +112,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
-summary: Riemann is a network event stream processing system.
+summary: Sends metrics to Riemann
 test_files:
 - spec/outputs/riemann_spec.rb