logstash-filter-lookup 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 648fc623dcabd4838334920e90a147340b8f52b1
+  data.tar.gz: df85b912d6514fbac058f07a7869d93fb07d09e7
+SHA512:
+  metadata.gz: fbb7168f862eca20a989adc0cd8d4195557c7ca437eb4e09cdc1c62c856e29cf5f48acf122d4aae240cebc4e8ecde4028091c0730ad42cfe93169eeda10f6d8c
+  data.tar.gz: b388ae388123da3b6f9c6ea24d20728f171c049f8cee1e386d135932d0088c657e4944bc4e3076d85e68aae3e00e3ac8e56b6967135c6392523b3c37f532b421

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0
+Initialized logstash-filter-lookup. Formerly called logstash-filter-webservicemap

data/CONTRIBUTORS

@@ -0,0 +1,16 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Based on logstash-filter-translate
+Formerly called logstash-filter-webservicemap
+Forked from the pull Request for logstash-filter-translate and separated from there.
+credits to: https://github.com/logstash-plugins/logstash-filter-translate
+the PR that never merged to: https://github.com/logstash-plugins/logstash-filter-translate/pull/7
+
+Contributors:
+* Angel Luis Lopez Monterroso (angel9484)
+
+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,6 @@
+source 'https://rubygems.org'
+gemspec
+
+group :test, :development do
+  gem 'webmock'
+end

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/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,144 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/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.
+
+## Example
+### 1. Web Service Example
+See examples/webservice/java
+
+### 2. Logstash config example
+```
+input {
+	stdin{}
+}
+filter {
+	lookup {
+		field => "message"
+		map_url => "http://localhost:8080/json"
+		destination => "dest"
+		refresh_interval => 10
+	}
+}
+output {
+	stdout{
+
+	}
+}
+```
+### 3. Execution example
+Install with bin/plugin install logstash-filter-lookup
+```sh
+bin/logstash -f config/myconf.conf --log logstash.log --debug
+```
+
+### 4. Results
+#### Input
+200
+
+#### Output
+```
+{
+    :timestamp=>"2016-03-13T10:41:50.264000+0100", 
+    :message=>"output received", 
+    :event=>{
+        "message"=>"200", 
+        "@version"=>"1", 
+        "@timestamp"=>"2016-03-13T09:41:49.493Z", 
+        "host"=>"Mac-mini-de-angel.local", 
+        "dest"=>"OK"
+    }, 
+    :level=>:debug, 
+    :file=>"(eval)", 
+    :line=>"47", 
+    :method=>"output_func"
+}
+```
+
+### 5. Update
+bin/plugin update logstash-filter-lookup
+
+### 6. GEM
+https://rubygems.org/gems/logstash-filter-lookup
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## 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/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/filters/lookup.rb

@@ -0,0 +1,183 @@
+# encoding: utf-8
+require 'logstash/filters/base'
+require 'logstash/namespace'
+require 'open-uri'
+require 'digest/sha1'
+require 'json'
+require 'csv'
+
+# A general search and replace tool which uses a Web service with a YAML, CSV or JSON response to determine replacement values.
+#
+# The map entries can be specified with a Web service who your request produces a YML, CSV or JSON response.
+#
+# Operationally, if the event field specified in the `field` configuration
+# matches the EXACT contents of a map entry key, the field's value will be substituted
+# with the matched key's value from the map.
+#
+# By default, the lookup filter will replace the contents of the
+# maching event field (in-place). However, by using the `destination`
+# configuration item, you may also specify a target event field to
+# populate with the new mapd value.
+
+class LogStash::Filters::LookUp < LogStash::Filters::Base
+  config_name "lookup"
+  # The name of the logstash event field containing the value to be compared for a
+  # match by the map filter (e.g. `message`, `host`, `response_code`). 
+  # 
+  # If this field is an array, only the first value will be used.
+  config :field, :validate => :string, :required => true
+
+  # If the destination (or target) field already exists, this configuration item specifies
+  # whether the filter should skip mapping (default) or overwrite the target field
+  # value with the new mapping value.
+  config :override, :validate => :boolean, :default => false
+
+  # The full URI path of a Web service who generates an JSON, yml or CSV format response.
+  # requires to append as suffix the format type. Ex: http://localhost:8080/geoPoints?type=json
+  # http://localhost:8080/geoPoints/json
+  # http://localhost:8080/geoPoints/csv
+  # If no suffix matches, defaults to YAML
+  config :map_url, :validate => :string, :required => true
+
+  # When using a map file or url, this setting will indicate how frequently
+  # (in seconds) logstash will check the YAML file or url for updates.
+  config :refresh_interval, :validate => :number, :default => 300
+
+  # The destination field you wish to populate with the mapd code. The default
+  # is a field named `mapping`. Set this to the same value as source if you want
+  # to do a substitution, in this case filter will allways succeed. This will clobber
+  # the old value of the source field! 
+  config :destination, :validate => :string, :default => "mapping"
+
+  # In case no mapping occurs in the event (no matches), this will add a default
+  # mapping string, which will always populate `field`, if the match failed.
+  #
+  # For example, if we have configured `fallback => "no match"`, using this map:
+  # [source,ruby]
+  #     foo: bar
+  #
+  # Then, if logstash received an event with the field `foo` set to `bar`, the destination
+  # field would be set to `bar`. However, if logstash received an event with `foo` set to `nope`,
+  # then the destination field would still be populated, but with the value of `no match`.
+  # This configuration can be dynamic and include parts of the event using the `%{field}` syntax.
+  config :fallback, :validate => :string
+
+  def get_map
+    @my_map
+  end
+
+  def set_map(map)
+    @my_map = map;
+  end
+
+  public
+  def register
+    @my_map = {}
+    @next_refresh = Time.now + @refresh_interval
+    download_ws(@map_url, true)
+    @logger.debug? and @logger.debug("#{self.class.name}: map - ", :map => get_map)
+    type = 'Exact'
+    @logger.debug? and @logger.debug("#{self.class.name}: map mapping method - "+type)
+  end
+
+  # def register
+
+  def json_loader(data)
+    get_map.merge!(JSON.parse(File.read(data)))
+  end
+
+  def csv_loader(data)
+    data = CSV.read(data).inject(Hash.new) do |acc, v|
+      acc[v[0]] = v[1]
+      acc
+    end
+    get_map.merge!(data)
+  end
+
+  def yml_loader(data)
+    get_map.merge!(YAML.load_file(data))
+  end
+
+  def load_file(registering, extension, data)
+    begin
+      if extension.equal?('.json')
+        return json_loader(data)
+      elsif extension.end_with?('.csv')
+        return csv_loader(data)
+      end
+      yml_loader(data)
+    rescue Exception => _
+      if registering
+        raise "#{self.class.name}: Bad Syntax in map file #{file_name}"
+      else
+        @logger.warn("#{self.class.name}: Bad Syntax in map file, continuing with old map", :map_path => file_name)
+      end
+    end
+  end
+
+  def get_extension(path)
+    if path.end_with?('json')
+      return '.json'
+    elsif path.end_with?('csv')
+      return '.csv'
+    end
+    '.yml'
+  end
+
+  public
+  def download_ws(path, registering=false)
+    extension = get_extension(path)
+    temp_extension = '_temp'+extension;
+    file_name = Digest::SHA1.hexdigest path
+    begin
+      File.open(file_name+temp_extension, 'wb') do |saved_file|
+        open(path, 'rb') do |read_file|
+          saved_file.write(read_file.read)
+        end
+      end
+    rescue Exception => _
+      if registering
+        raise "#{self.class.name}: Failed to initialize with #{file_name} and path #{path}"
+      end
+      @logger.warn("#{self.class.name}: Something happened with URL. Continuing with old map", :map_path => file_name, :path => path)
+    end
+
+    begin
+      load_file(registering, extension, file_name+temp_extension)
+      FileUtils.mv(file_name+temp_extension, file_name+extension)
+    rescue Exception => _
+      FileUtils.rm_f(file_name+temp_extension)
+    end
+  end
+
+  # def download_yaml
+
+  public
+  def filter(event)
+    if @next_refresh < Time.now
+      download_ws(@map_url)
+      @next_refresh = Time.now + @refresh_interval
+      @logger.info('downloading and refreshing map file')
+    end
+
+    return unless event.include?(@field) # Skip mapping in case event does not have @event field.
+    return if event.include?(@destination) and not @override # Skip mapping in case @destination field already exists and @override is disabled.
+
+    begin
+      source = event[@field].is_a?(Array) ? event[@field].first.to_s : event[@field].to_s
+      matched = false
+      if get_map.include?(source)
+        event[@destination] = get_map[source]
+        matched = true
+      end
+
+      if not matched and @fallback
+        event[@destination] = event.sprintf(@fallback)
+        matched = true
+      end
+      filter_matched(event) if matched or @field == @destination
+    rescue Exception => e
+      @logger.error('Something went wrong when attempting to map from my_map', :exception => e, :field => @field, :event => event)
+    end
+  end # def filter
+end # class LogStash::Filters::LookUp

data/logstash-filter-lookup.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name            = 'logstash-filter-lookup'
+  s.version         = '1.2.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "A general search and replace tool which uses a configured web service to determine replacement values."
+  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 logstash-filter-lookup. This gem is not a stand-alone program. See https://github.com/angel9484/logstash-filter-lookup"
+  s.authors         = ["Elastic"]
+  s.email           = 'info@elastic.co'
+  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+
+  # 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", ">= 2.0.0", "<= 2.2.2"
+
+  s.add_development_dependency 'logstash-devutils', '~> 0'
+end

data/spec/filters/lookup_spec.rb

@@ -0,0 +1,135 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/filters/lookup"
+require "webmock/rspec"
+require 'digest/sha1'
+WebMock.disable_net_connect!(allow_localhost: true)
+
+describe LogStash::Filters::LookUp do
+
+  let(:config) { Hash.new }
+  subject { described_class.new(config) }
+
+  describe "webserver mapping" do
+      config <<-CONFIG
+      filter {
+          lookup {
+              field       => "status"
+              destination => "mapping"
+              map_url  => "http://dummyurl/"
+          }
+      }
+      CONFIG
+
+      RSpec.configure do |config|
+          hash = Digest::SHA1.hexdigest 'http://dummyurl/'
+          config.before(:each) do
+              FileUtils.rm_rf(hash+'.yml')
+              stub_request(:get, "http://dummyurl/").
+              with(:headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+              to_return(:status => 200, :body => "\
+                        '200': OK\n\
+                        '300': Redirect\n\
+                        '400': Client Error\n\
+                        '500': Server Error", :headers => {})
+          end
+          config.after(:all) do
+              FileUtils.rm_rf(hash+'.yml')
+          end
+      end
+
+      sample("status" => "200") do
+          insist { subject["mapping"] } == "OK"
+      end
+  end
+
+  describe "webserver mapping existing YML" do
+      config <<-CONFIG
+      filter {
+          lookup {
+              field       => "status"
+              destination => "mapping"
+              map_url  => "http://dummyurl/"
+          }
+      }
+      CONFIG
+
+      RSpec.configure do |config|
+        hash = Digest::SHA1.hexdigest 'http://dummyurl/'
+          config.before(:each) do
+              FileUtils.rm_rf(hash+'.yml')
+              File.open(hash+'.yml', 'wb') { |f| f.write("\
+                                                       '200': OKF\n\
+                                                       '300': Redirect\n\
+                                                       '400': Client Error\n\
+                                                       '500': Server Error") }
+              stub_request(:get, "http://dummyurl/").
+              with(:headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+              to_return(:status => 200, :body => "\
+                        '200': OK\n\
+                        '300': Redirect\n\
+                        '400': Client Error\n\
+                        '500': Server Error", :headers => {})
+          end
+          config.after(:all) do
+              FileUtils.rm_rf(hash+'.yml')
+          end
+      end
+
+      sample("status" => "200") do
+          insist { subject["mapping"] } == "OK"
+      end
+  end
+
+  describe "webserver mapping not valid" do
+      config <<-CONFIG
+      filter {
+          lookup {
+              field       => "status"
+              destination => "mapping"
+              map_url  => "http://dummyurl/"
+          }
+      }
+      CONFIG
+
+      RSpec.configure do |config|
+        hash = Digest::SHA1.hexdigest 'http://dummyurl/'
+          config.before(:each) do
+              FileUtils.rm_rf(hash+'.yml')
+              stub_request(:get, "http://dummyurl/").
+              with(:headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+              to_return(:status => 200, :body => "\
+                        '200': OK\n\
+                        '300': Redirect\n\
+                        '400', Client Error\n\
+                        '500': Server Error", :headers => {})
+          end
+          config.after(:all) do
+              FileUtils.rm_rf(hash+'.yml')
+          end
+      end
+
+      sample("status" => "200") do
+          insist { subject["mapping"] } == nil
+      end
+  end
+
+    context "allow sprintf" do
+      let(:config) do
+        {
+          "field"       => "status",
+          "destination" => "mapping",
+          "fallback" => "%{missing_mapping}",
+          "map_url"  => "http://dummyurl/"
+        }
+      end
+
+      let(:event) { LogStash::Event.new("status" => "200", "missing_mapping" => "missing no match") }
+
+      it "return the exact mapping" do
+        subject.register
+        subject.filter(event)
+        expect(event["mapping"]).to eq("missing no match")
+      end
+    end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-lookup
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !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 logstash-filter-lookup. This gem is not a stand-alone program. See https://github.com/angel9484/logstash-filter-lookup
+email: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/filters/lookup.rb
+- logstash-filter-lookup.gemspec
+- spec/filters/lookup_spec.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+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.5
+signing_key:
+specification_version: 4
+summary: A general search and replace tool which uses a configured web service to determine replacement values.
+test_files:
+- spec/filters/lookup_spec.rb