logstash-filter-rest 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a94fca67a197ad30fca3782583513944208a718d
-  data.tar.gz: 2220544e6212c28180aee679701c5b1d30639db0
+  metadata.gz: e8c8d2b4220c5092406a81cda2f4f0701062c7f2
+  data.tar.gz: 1f8fb32dc101b4dd2c2e451c18340d5ed779fa85
 SHA512:
-  metadata.gz: 9f40441ed6c6c920a264b7de52cf4d04d96b72b171f03df9ef4371deb0eb34260dcc7ac400e439d34d74cd2e440533b359aef9b6b463bb8447ac1f8b13d0a790
-  data.tar.gz: fa852b78a2bcf66ba6aea78d4fd9546420d3eed72483869282b7222b2fb69fc82a571d685768a221f4e5c22e351a47a643f11a4af74e558556a3517e3982441e
+  metadata.gz: ed36752171106b82c479e530766930d0c744b59e7ae735ef2185fe05095a930bd2f066def5fb186da1a592dd928612c8ab59c9baecbf23a5470025d4b4dfcd1c
+  data.tar.gz: d72839c3c82dfa05efa8fcf3db97f5030d7ff96c3f82ada876405240cf397ec967ba0bc8e6e1bcec1a9150c6c4b0e8df0a37325133ee41d944528a2a0a871dfa

data/README.md

@@ -10,7 +10,7 @@ This logstash filter provides an easy way to access RESTful Resources within log
 
 ## Usage
 ### 1. Installation
-You can use the built in plugin tool of Logstash to install the filter:
+You can use the built-in plugin tool of Logstash to install the filter:
 ```
 $LS_HOME/bin/plugin install logstash-filter-rest
 ```
@@ -28,18 +28,19 @@ Add the following inside the filter section of your logstash configuration:
 
 ```sh
 rest {
-  url => "http://icanhazip.com"     # string (required)
+  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}'
+    "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}'
+    "key1" => "value1"
+    "key2" => "value2"
+    "key3" => "%{somefield}"        # Please set sprintf to true if you want to use field references
   }
 }
 ```

data/lib/logstash/filters/rest.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
 require "logstash/filters/base"
 require "logstash/namespace"
+require "json"
+require "rest_client"
 
 # Logstash REST Filter
 # This filter calls a defined URL and saves the answer into a specified field.
@@ -10,55 +12,88 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
   # Usage:
   #
   # filter {
-  #   rest {
-  #     url => "http://example.com"
-  #	header => {
-  #		'key1' => 'value1'
-  #		'key2' => 'value2'
-  #		'key3' => '%{somefield}'
-  #	}
-  #	method => "post"
-  #     json => true
-  #	params => {
-  #		'key1' => 'value1'
-  #		'key2' => 'value2'
-  #		'key3' => '%{somefield}'
-  #	}
-  #   }
+  # 	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}'
+  #			}
+  #   	}
   # }
   #
   config_name "rest"
   
-  # Replace the message with this value.
   config :url, :validate => :string, :required => true
   config :method, :validate => :string, :default => "get"
   config :json, :validate => :boolean, :default => false
+  config :sprintf, :validate => :boolean, :default => false
   config :header, :validate => :hash, :default => {  }
   config :params, :validate => :hash, :default => {  }
 
   public
   def register
-    require "json"
-    require "rest_client"
-    @resource = RestClient::Resource.new(@url, :headers => @header)
+
   end # def register
 
   public
   def filter(event)
     return unless filter?(event)
-	if method == "get"
-       		response = @resource.get()
-	else
-		response = @resource.post(@params)
-	end
+    
+	begin
+		
+		if sprintf == true
+			begin
+				# sprintf values
+				@url = event.sprintf(@url)
+				@header.each do |key, value|
+					@header[key] = event.sprintf(value)
+				end
+				@params.each do |key, value|
+					@params[key] = event.sprintf(value)
+				end
+			rescue
+				@logger.error("Error during sprintf", :url => url, :method => method, :json => json, :header => header, :params => params)
+				@logger.error("Rest Error Message:", :message => $!.message)
+				@logger.error("Backtrace:", :backtrace => $!.backtrace)
+			end
+		end
 	
-	if json == true
-	   h = JSON.parse(response)
-	   h.each do |key, value|
-		event[key] = value
-	   end
-	else
-       	   event['response'] = response.strip
+		case method
+		when "get"
+			response = RestClient.get @url, @header
+		when "post"
+			response = RestClient.post @url, @params, @header
+		else
+			response = "invalid method"	
+			@logger.error("Invalid method:", :method => method)
+		end
+		
+		if json == true
+			begin
+				h = JSON.parse(response)
+				h.each do |key, value|
+					event[key] = value
+				end
+			rescue
+				event['jsonerror'] = "unable to parse json"
+			end
+		else
+			event['response'] = response.strip
+		end
+	rescue
+		@logger.error("Error in Rest Filter. Parameters:", :url => url, :method => method, :json => json, :header => header, :params => params)
+		@logger.error("Rest Error Message:", :message => $!.message)
+		@logger.error("Backtrace:", :backtrace => $!.backtrace)
+		event['resterror'] = "Rest Filter Error. Please see Logstash Error Log for further information."
 	end
 	
     filter_matched(event)    

data/logstash-filter-rest.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-rest'
-  s.version         = '0.1.1'
+  s.version         = '0.1.2'
   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"
@@ -18,7 +18,8 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency "logstash-core", '>= 1.5.0', '< 2.0.0'
   s.add_runtime_dependency "rest-client", '>= 1.8.0'
+  s.add_runtime_dependency 'logstash-codec-json'
   s.add_development_dependency 'logstash-devutils'
 end

metadata

@@ -1,63 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-rest
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Lucas Henning
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: logstash-core
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.5.0
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
-  requirement: !ruby/object:Gem::Requirement
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.5.0
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
   name: rest-client
+  prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: 1.8.0
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '0'
+  name: logstash-codec-json
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: logstash-devutils
   prerelease: false
   type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !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/plugin install gemname. This gem is not a stand-alone program
 email: mail@hurb.de
 executables: []
@@ -95,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key:
 specification_version: 4
 summary: This filter requests data from a RESTful Web Service.