logstash-filter-rest 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8c8d2b4220c5092406a81cda2f4f0701062c7f2
-  data.tar.gz: 1f8fb32dc101b4dd2c2e451c18340d5ed779fa85
+  metadata.gz: a5964c6a51327b4953e168e475062fe91d8d1abc
+  data.tar.gz: 9210f9fe34adddca81b46f7104ba7d52ed5658d3
 SHA512:
-  metadata.gz: ed36752171106b82c479e530766930d0c744b59e7ae735ef2185fe05095a930bd2f066def5fb186da1a592dd928612c8ab59c9baecbf23a5470025d4b4dfcd1c
-  data.tar.gz: d72839c3c82dfa05efa8fcf3db97f5030d7ff96c3f82ada876405240cf397ec967ba0bc8e6e1bcec1a9150c6c4b0e8df0a37325133ee41d944528a2a0a871dfa
+  metadata.gz: f2147cf903f6e68c9f55861bce661bf163722518f2d652229a1a5cb6d75492726734f22d017115e0a8e2d8851002893e53f572ef1b7f769fc3e5ee25cba2184e
+  data.tar.gz: ea49d12ba7097e89161e4cafb05fad46447664d315cf5a172545bc02639ec6841c2cf3b9a6fa86f5e6cdcedb518b6addb06d3ba9f6ea09af25e1b1f0c28244b1

data/README.md

@@ -31,7 +31,7 @@ rest {
   url => "http://example.com"       # string (required, with field reference: "http://example.com?id=%{id}")
   json => true                      # boolean (optional, default = false)
   method => "post"                  # string (optional, default = "get")
-  sprintf => true                   # boolean (optional, default = false, set this to true if you want to use field references in url, header or params
+  sprintf => true                   # boolean (optional, default = false, set this to true if you want to use field references in url, header or params)
   header => {                       # hash (optional)
     "key1" => "value1"
     "key2" => "value2"
@@ -42,11 +42,9 @@ rest {
     "key2" => "value2"
     "key3" => "%{somefield}"        # Please set sprintf to true if you want to use field references
   }
+  response_key => "my_key"          # string (optional, default = "rest_response")
 }
 ```
-### 3. Accessing the result
-If you are expecting a single output and 'json => false' you will get a logstash field called 'response' which contains the result.
-If 'json => true' you will get a new logstash field for each key.
 
 ## Contributing
 

data/lib/logstash/filters/rest.rb

@@ -11,25 +11,25 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
 
   # Usage:
   #
-  # filter {
-  # 	rest {
-  # 		url => "http://example.com"
-  #			method => "post"
-  # 		json => true
-  #			sprintf => true
-  #			params => {
-  #				'key1' => 'value1'
-  #				'key2' => 'value2'
-  #				'key3' => '%{somefield}'
-  #			}
-  # 		header => {
-  #				'key1' => 'value1'
-  #				'key2' => 'value2'
-  #				'key3' => '%{somefield}'
-  #			}
-  #   	}
-  # }
+  #  rest {
+  #  url => "http://example.com"       # string (required, with field reference: "http://example.com?id=%{id}")
+  #  json => true                      # boolean (optional, default = false)
+  #  method => "post"                  # string (optional, default = "get")
+  #  sprintf => true                   # boolean (optional, default = false, set this to true if you want to use field references in url, header or params)
+  #  header => {                       # hash (optional)
+  #    "key1" => "value1"
+  #    "key2" => "value2"
+  #    "key3" => "%{somefield}"        # Please set sprintf to true if you want to use field references
+  #  }
+  #  params => {                       # hash (optional, only available for method => "post")
+  #    "key1" => "value1"
+  #    "key2" => "value2"
+  #    "key3" => "%{somefield}"        # Please set sprintf to true if you want to use field references
+  #  }
+  #  response_key => "my_key"          # string (optional, default = "rest_response")
+  #  }
   #
+  
   config_name "rest"
   
   config :url, :validate => :string, :required => true
@@ -38,6 +38,7 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
   config :sprintf, :validate => :boolean, :default => false
   config :header, :validate => :hash, :default => {  }
   config :params, :validate => :hash, :default => {  }
+  config :response_key, :validate => :string, :default => "rest_response"
 
   public
   def register
@@ -80,14 +81,19 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
 		if json == true
 			begin
 				h = JSON.parse(response)
-				h.each do |key, value|
-					event[key] = value
+				if response_key == ""
+					h.each do |key, value|
+						event[key] = value
+					end
+				else
+					event[response_key] = { }
+					event[response_key] = h
 				end
 			rescue
 				event['jsonerror'] = "unable to parse json"
 			end
 		else
-			event['response'] = response.strip
+			event[@response_key] = response.strip
 		end
 	rescue
 		@logger.error("Error in Rest Filter. Parameters:", :url => url, :method => method, :json => json, :header => header, :params => params)

data/logstash-filter-rest.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-rest'
-  s.version         = '0.1.2'
+  s.version         = '0.1.3'
   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/plugin install gemname. This gem is not a stand-alone program"

data/spec/filters/rest_spec.rb

@@ -6,14 +6,15 @@ describe LogStash::Filters::Rest do
     let(:config) do <<-CONFIG
       filter {
         rest {
-          url => "http://icanhazip.com"
+          url => "http://jsonplaceholder.typicode.com/users/1"
+	  json => true
         }
       }
     CONFIG
     end
 
     sample("message" => "some text") do
-      expect(subject).to include("message")
+      expect(subject).to include("rest_response")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-rest
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Lucas Henning
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-23 00:00:00.000000000 Z
+date: 2015-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement