logstash-filter-rest 0.1.1

checksums.yaml

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

data/CONTRIBUTORS

@@ -0,0 +1,11 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Aaron Mildenstein (untergeek)
+* Pier-Hugues Pellerin (ph)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 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
+
+    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/README.md

@@ -0,0 +1,58 @@
+# Logstash REST Filter
+
+This is a filter plugin for [Logstash](https://github.com/elasticsearch/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+This logstash filter provides an easy way to access RESTful Resources within logstash. It can be used to post data to a REST API or to gather data and save it in your log file.
+
+## Usage
+### 1. Installation
+You can use the built in plugin tool of Logstash to install the filter:
+```
+$LS_HOME/bin/plugin install logstash-filter-rest
+```
+
+Or you can build it yourself:
+```
+git clone https://github.com/lucashenning/logstash-filter-rest.git
+bundle install
+gem build logstash-filter-rest.gemspec
+$LS_HOME/bin/plugin install logstash-filter-rest-0.1.0.gem
+```
+
+### 2. Filter Configuration
+Add the following inside the filter section of your logstash configuration:
+
+```sh
+rest {
+  url => "http://icanhazip.com"     # string (required)
+  json => true                      # boolean (optional, default = false)
+  method => "post"                  # string (optional, default = "get")
+  header => {                       # hash (optional)
+    'key1' => 'value1'
+    'key2' => 'value2'
+    'key3' => '%{somefield}'
+  }
+  params => {                       # hash (optional, only available for method => "post")
+    'key1' => 'value1'
+    'key2' => 'value2'
+    'key3' => '%{somefield}'
+  }
+}
+```
+### 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
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/Rakefile

@@ -0,0 +1 @@
+require "logstash/devutils/rake"

data/lib/logstash/filters/rest.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+# Logstash REST Filter
+# This filter calls a defined URL and saves the answer into a specified field.
+#
+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}'
+  #	}
+  #   }
+  # }
+  #
+  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 :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
+	
+	if json == true
+	   h = JSON.parse(response)
+	   h.each do |key, value|
+		event[key] = value
+	   end
+	else
+       	   event['response'] = response.strip
+	end
+	
+    filter_matched(event)    
+  end # def filter
+end # class LogStash::Filters::Rest

data/logstash-filter-rest.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-rest'
+  s.version         = '0.1.1'
+  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"
+  s.authors = ["Lucas Henning"]
+  s.email = 'mail@hurb.de'
+  s.homepage = "https://github.com/lucashenning/logstash-filter-rest/"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  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 "rest-client", '>= 1.8.0'
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/filters/rest_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require "logstash/filters/rest"
+
+describe LogStash::Filters::Rest do
+  describe "Set to Rest Filter" do
+    let(:config) do <<-CONFIG
+      filter {
+        rest {
+          url => "http://icanhazip.com"
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "some text") do
+      expect(subject).to include("message")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-rest
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Lucas Henning
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/filters/rest.rb
+- logstash-filter-rest.gemspec
+- spec/filters/rest_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lucashenning/logstash-filter-rest/
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.6
+signing_key:
+specification_version: 4
+summary: This filter requests data from a RESTful Web Service.
+test_files:
+- spec/filters/rest_spec.rb
+- spec/spec_helper.rb