logstash-filter-rest 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 798eff3d04ef565f8b78b1692b53f05a3d823271
-  data.tar.gz: 94d72901fbfea799a846785bd63fbe3d85fd6349
+  metadata.gz: d1b60b569aa8944cc187b1119df43ed5ed5b6a87
+  data.tar.gz: d192256c5722bc8dd4508a0025d5efcbf636e7b1
 SHA512:
-  metadata.gz: 777e34a187f60db34636e69380432f020daf8dc9c7928252ea2938d65a5f35f27f8146cd40831eb7ab9eec66c4b0a3f47fd6c1f3d5003cb92eee65e2b6ecf237
-  data.tar.gz: c8a295158a7dad5737cc5ddec33d53c1ab8d3e6c6f81d05980b126617d4ccfcd74fae0cce0cd50a7702486b04368fafffeb1a12cf1302206410fc4d85efe7b3f
+  metadata.gz: b2a68e2559564025924b531cf04cf72e80b82d62bc2402b4799cc55f878e1bc13255be9ceb6cb45714344c970a6990902fb31c9ad63e08249877bcc16b8ef406
+  data.tar.gz: dc9eab7e46af8e7ff74f4d3edebcba5a2617c2c2653f086677131d39fa4e106736d25cad13098708a98da15a30735bf107faad2825c93485c1b51973a640860b

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.5.4
+
+  - update `gemspec` to work with logstash 5.5
+
+## 0.5.3
+  - freeze all instance variables
+  - fix parallel processing by creating a `deep_clone` for each event
+  - use `LogStash::Util.deep_clone` for object cloning
+  - only dump body as json, if json is enabled in config (default)
+  - delete empty target testcase, as catched by upper logstash `LogStash::ConfigurationError`
+  - fix `sprintf` find and merge for more complex structures
+
 ## 0.5.2
   - Fix behavior, where a referenced field (`%{...}`) has `ruby` chars
   (i.e., consisting of `:`)

data/README.md

@@ -1,4 +1,4 @@
-# Logstash REST Filter [![Build Status](https://travis-ci.org/gandalfb/logstash-filter-rest.svg?branch=version%2Flogstash-5)](https://travis-ci.org/gandalfb/logstash-filter-rest)
+# Logstash REST Filter [![Build Status](https://travis-ci.org/gandalfb/logstash-filter-rest.svg?branch=master)](https://travis-ci.org/gandalfb/logstash-filter-rest)
 
 This is a filter plugin for [Logstash](https://github.com/elasticsearch/logstash).
 

data/lib/logstash/filters/rest.rb

@@ -18,6 +18,10 @@ end
 
 #  Monkey Patch Array with deep freeze
 class Array
+  def compact
+    delete_if { |v| v.respond_to?(:each) ? v.compact.empty? : v.nil? }
+  end
+
   def deep_freeze
     each { |j| j.deep_freeze if j.respond_to? :deep_freeze }
     freeze
@@ -127,11 +131,12 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
   public
 
   def register
-    @request = normalize_request(@request)
+    @request = normalize_request(@request).deep_freeze
     @sprintf_fields = find_sprintf(
-      Marshal.load(Marshal.dump(@request))
+      LogStash::Util.deep_clone(@request)
     ).deep_freeze
-    @target = normalize_target(@target)
+    @sprintf_needed = !@sprintf_fields.empty?
+    @target = normalize_target(@target).freeze
   end # def register
 
   private
@@ -208,8 +213,10 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
   private
 
   def request_http(request)
-    request[2][:body] = LogStash::Json.dump(request[2][:body]) if request[2].key?(:body)
-    @logger.debug? && @logger.debug('Fetching request',
+    if request[2].key?(:body) && @json
+      request[2][:body] = LogStash::Json.dump(request[2][:body])
+    end
+    @logger.debug? && @logger.debug('fetching request',
                                     :request => request)
 
     method, url, *request_opts = request
@@ -247,9 +254,9 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
   private
 
   def field_intrpl(intrpl_fields, event)
-    return intrpl_fields if intrpl_fields.empty?
-    return event.sprintf(intrpl_fields) unless intrpl_fields.respond_to?(:each)
     case intrpl_fields
+    when String
+      result = event.sprintf(intrpl_fields)
     when Array
       result = []
       intrpl_fields.each do |v|
@@ -260,6 +267,8 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
       intrpl_fields.each do |k, v|
         result[k] = field_intrpl(v, event)
       end
+    else
+      result = intrpl_fields
     end
     result
   end
@@ -268,43 +277,40 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
 
   def filter(event)
     return unless filter?(event)
-    @logger.debug? && @logger.debug('Parsing event fields',
-                                    :sprintf_fields => @sprintf_fields)
-    parsed_request_fields = field_intrpl(@sprintf_fields, event)
-    parsed_request_fields.each do |v|
-      case v
-      when Hash
-        @request[2].merge!(v)
-      when String
-        @request[1] = v
-      end
+    request = LogStash::Util.deep_clone(@request)
+    @logger.debug? && @logger.debug('processing request',
+                                    :request => request,
+                                    :sprintf_needed => @sprintf_needed)
+
+    if @sprintf_needed
+      request = field_intrpl(request, event)
+      @logger.debug? && @logger.debug('interpolated request',
+                                      :request => request)
     end
-    @logger.debug? && @logger.debug('Parsed request',
-                                    :request => @request)
 
     client_error = nil
     begin
-      code, body = request_http(@request)
+      code, body = request_http(request)
     rescue StandardError => e
       client_error = e
     end
 
     if !client_error && code.between?(200, 299)
-      @logger.debug? && @logger.debug('Success received',
+      @logger.debug? && @logger.debug('success received',
                                       :code => code, :body => body)
       process_response(body, event)
     else
-      @logger.debug? && @logger.debug('Http error received',
+      @logger.debug? && @logger.debug('http error received',
                                       :code => code, :body => body,
                                       :client_error => client_error)
       if @fallback.empty?
-        @logger.error('Error in Rest filter',
-                      :request => @request, :json => @json,
+        @logger.error('error in rest filter',
+                      :request => request, :json => @json,
                       :code => code, :body => body,
                       :client_error => client_error)
         @tag_on_rest_failure.each { |tag| event.tag(tag) }
       else
-        @logger.debug? && @logger.debug('Setting fallback',
+        @logger.debug? && @logger.debug('setting fallback',
                                         :fallback => @fallback)
         event.set(@target, @fallback)
       end

data/logstash-filter-rest.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-rest'
-  s.version = '0.5.2'
+  s.version = '0.5.4'
   s.licenses = ['Apache License (2.0)']
   s.summary = 'This filter requests data from a RESTful Web Service.'
   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 logstash-filter-rest. This gem is not a stand-alone program'
@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
 
   # Gem dependencies
   s.add_runtime_dependency 'logstash-core-plugin-api', '>= 1.60', '<= 2.99'
-  s.add_runtime_dependency 'logstash-mixin-http_client', '>= 2.2.4', '< 5.0.0'
+  s.add_runtime_dependency 'logstash-mixin-http_client', '>= 5.0.0', '< 6.0.0'
 
   s.add_development_dependency 'logstash-devutils', '>= 0', '< 2.0.0'
 end

data/spec/filters/rest_spec.rb

@@ -277,17 +277,46 @@ describe LogStash::Filters::Rest do
       expect(subject.get('rest')).to_not include('fallback')
     end
   end
-  describe 'fallback' do
+  describe 'Set to Rest Filter Post with body sprintf nested params' do
     let(:config) do <<-CONFIG
       filter {
         rest {
           request => {
-            url => 'http://jsonplaceholder.typicode.com/users/0'
-          }
-          json => true
-          fallback => {
-            'fallback1' => true
-            'fallback2' => true
+            url => 'https://jsonplaceholder.typicode.com/posts'
+            method => 'post'
+            body => {
+              key1 => [
+                {
+                  "filterType" => "text"
+                  "text" => "salmon"
+                  "boolean" => false
+                },
+                {
+                  "filterType" => "unique"
+                }
+              ]
+              key2 => [
+                {
+                  "message" => "123%{message}"
+                  "boolean" => true
+                }
+              ]
+              key3 => [
+                {
+                  "text" => "%{message}123"
+                  "filterType" => "text"
+                  "number" => 44
+                },
+                {
+                  "filterType" => "unique"
+                  "null" => nil
+                }
+              ]
+              userId => "%{message}"
+            }
+            headers => {
+              'Content-Type' => 'application/json'
+            }
           }
           target => 'rest'
         }
@@ -295,14 +324,23 @@ describe LogStash::Filters::Rest do
     CONFIG
     end
 
-    sample('message' => 'some text') do
+    sample('message' => '42') do
       expect(subject).to include('rest')
-      expect(subject.get('rest')).to include('fallback1')
-      expect(subject.get('rest')).to include('fallback2')
-      expect(subject.get('rest')).to_not include('id')
+      expect(subject.get('rest')).to include('key1')
+      expect(subject.get('[rest][key1][0][boolean]')).to eq('false')
+      expect(subject.get('[rest][key1][1][filterType]')).to eq('unique')
+      expect(subject.get('[rest][key2][0][message]')).to eq('12342')
+      expect(subject.get('[rest][key2][0][boolean]')).to eq('true')
+      expect(subject.get('[rest][key3][0][text]')).to eq('42123')
+      expect(subject.get('[rest][key3][0][filterType]')).to eq('text')
+      expect(subject.get('[rest][key3][0][number]')).to eq(44)
+      expect(subject.get('[rest][key3][1][filterType]')).to eq('unique')
+      expect(subject.get('[rest][key3][1][null]')).to eq('nil')
+      expect(subject.get('[rest][userId]')).to eq(42)
+      expect(subject.get('rest')).to_not include('fallback')
     end
   end
-  describe 'empty target exception' do
+  describe 'fallback' do
     let(:config) do <<-CONFIG
       filter {
         rest {
@@ -314,16 +352,20 @@ describe LogStash::Filters::Rest do
             'fallback1' => true
             'fallback2' => true
           }
-          target => ''
+          target => 'rest'
         }
       }
     CONFIG
     end
+
     sample('message' => 'some text') do
-      expect { subject }.to raise_error(LogStash::ConfigurationError)
+      expect(subject).to include('rest')
+      expect(subject.get('rest')).to include('fallback1')
+      expect(subject.get('rest')).to include('fallback2')
+      expect(subject.get('rest')).to_not include('id')
     end
   end
-  describe 'missing target exception' do
+  describe 'empty target exception' do
     let(:config) do <<-CONFIG
       filter {
         rest {
@@ -335,6 +377,7 @@ describe LogStash::Filters::Rest do
             'fallback1' => true
             'fallback2' => true
           }
+          target => ''
         }
       }
     CONFIG

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-rest
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors:
 - Lucas Henning
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-12 00:00:00.000000000 Z
+date: 2017-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -36,10 +36,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.4
+        version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.0
   name: logstash-mixin-http_client
   prerelease: false
   type: :runtime
@@ -47,10 +47,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.4
+        version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements: