logstash-filter-alter 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjcyZWNhOGI5MTk2ODA4ODg3YmY5ZjRhMTJiODFhMTgxZDQ5YmZiMA==
+  data.tar.gz: !binary |-
+    MGJlOGJmN2FjZDk5OWFlODEyMzViMDY3ZDZiZjlkYTFlNzEzNTExNA==
+SHA512:
+  metadata.gz: !binary |-
+    Mzc3YzkzYjBhN2ZjMzIwMjNkZTcyNjA4MDNjZmU5Yjg5MmZkOTczZDFiNjdh
+    MTcyZTgwNmRkNjBmZmU1YmRmMmM4ODAzMzI2OWJjNmE3NWJkOGVmZDg5YjFl
+    YjE3OTA0MmM1MWY4OGI5NDY5ZjBmNmE5ZjRkODczN2Q0ZmVkMzg=
+  data.tar.gz: !binary |-
+    MmU0YjdiOTlhYzc2OTZjMWRjMDIzYTM5OWYzOTJiOThmYWRjNzJhNGJhYjE3
+    MmIwZmIxM2NiNjNlMWY2MjA4YTAyM2MzMDQ5MzRjMTYxZjMzOWU4NWUwMWE5
+    ZGY0YjRkOGUzNDE5YTM1ZGJhOTZhMDFmM2E3Y2E5MWJjYzAwZDQ=

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+Gemfile.lock
+.bundle
+vendor

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+gem 'rake'
+gem 'gem_publisher'

data/Rakefile

@@ -0,0 +1,6 @@
+@files=[]
+
+task :default do
+  system("rake -T")
+end
+

data/lib/logstash/filters/alter.rb

@@ -0,0 +1,174 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+
+# The alter filter allows you to do general alterations to fields 
+# that are not included in the normal mutate filter. 
+#
+#
+# NOTE: The functionality provided by this plugin is likely to
+# be merged into the 'mutate' filter in future versions.
+class LogStash::Filters::Alter < LogStash::Filters::Base
+  config_name "alter"
+  milestone 1
+  
+  # Change the content of the field to the specified value
+  # if the actual content is equal to the expected one.
+  #
+  # Example:
+  #
+  #     filter {
+  #       alter {
+  #         condrewrite => [ 
+  #              "field_name", "expected_value", "new_value",
+  #              "field_name2", "expected_value2, "new_value2",
+  #              ....
+  #            ]
+  #       }
+  #     }
+  config :condrewrite, :validate => :array
+  
+  # Change the content of the field to the specified value
+  # if the content of another field is equal to the expected one.
+  #
+  # Example:
+  #
+  #     filter {
+  #       alter {
+  #         condrewriteother => [ 
+  #              "field_name", "expected_value", "field_name_to_change", "value",
+  #              "field_name2", "expected_value2, "field_name_to_change2", "value2",
+  #              ....
+  #         ]
+  #       }
+  #     }
+  config :condrewriteother, :validate => :array
+  
+  # Sets the value of field_name to the first nonnull expression among its arguments.
+  #
+  # Example:
+  #
+  #     filter {
+  #       alter {
+  #         coalesce => [
+  #              "field_name", "value1", "value2", "value3", ...
+  #         ]
+  #       }
+  #     }
+  config :coalesce, :validate => :array
+  
+  public
+  def register 
+    @condrewrite_parsed = []
+    @condrewrite.nil? or @condrewrite.each_slice(3) do |field, expected, replacement|
+      if [field, expected, replacement].any? {|n| n.nil?}
+        @logger.error("Invalid condrewrte configuration. condrewrite has to define 3 elements per config entry", :field => field, :expected => expected, :replacement => replacement)
+        raise "Bad configuration, aborting."
+      end
+      @condrewrite_parsed << {
+        :field        => field,
+        :expected       => expected,
+        :replacement  => replacement
+      }
+    end # condrewrite
+    
+    @condrewriteother_parsed = []
+    @condrewriteother.nil? or @condrewriteother.each_slice(4) do |field, expected, replacement_field, replacement_value|
+      if [field, expected, replacement_field, replacement_value].any? {|n| n.nil?}
+        @logger.error("Invalid condrewrteother configuration. condrewriteother has to define 4 elements per config entry", :field => field, :expected => expected, :replacement_field => replacement_field, :replacement_value => replacement_value)
+        raise "Bad configuration, aborting."
+      end
+      @condrewriteother_parsed << {
+        :field        => field,
+        :expected       => expected,
+        :replacement_field  => replacement_field,
+        :replacement_value => replacement_value
+      }
+    end # condrewriteother
+    
+    @coalesce_parsed = []
+    @coalesce.nil? or if not @coalesce.is_a?(Array) or @coalesce.length < 2
+      @logger.error("Invalid coalesce configuration. coalesce has to define one Array of at least 2 elements")
+      raise "Bad configuration, aborting."
+    else
+      @coalesce_parsed << {
+        :field  => @coalesce.slice!(0),
+        :subst_array => @coalesce
+      }
+    end
+    
+       
+  end # def register
+  
+  public
+  def filter(event)
+    return unless filter?(event)
+
+    condrewrite(event) if @condrewrite
+    condrewriteother(event) if @condrewriteother
+    coalesce(event) if @coalesce
+
+    filter_matched(event)
+  end # def filter
+  
+  private
+  def condrewrite(event)
+    @condrewrite_parsed.each do |config|
+      field = config[:field]
+      expected = config[:expected]
+      replacement = config[:replacement]
+
+      if event[field].is_a?(Array)
+        event[field] = event[field].map do |v|
+          if v == event.sprintf(expected)
+            v = event.sprintf(replacement)
+          else
+            v
+          end
+        end
+      else
+        if event[field] == event.sprintf(expected)
+          event[field] = event.sprintf(replacement)
+        end
+      end
+    end # @condrewrite_parsed.each
+  end # def condrewrite
+  
+  private
+  def condrewriteother(event)
+    @condrewriteother_parsed.each do |config|
+      field = config[:field]
+      expected = config[:expected]
+      replacement_field = config[:replacement_field]
+      replacement_value = config[:replacement_value]
+
+      if event[field].is_a?(Array)
+        event[field].each do |v|
+          if v == event.sprintf(expected)
+            event[replacement_field] = event.sprintf(replacement_value)
+          end
+        end
+      else
+        if event[field] == event.sprintf(expected)
+          event[replacement_field] = event.sprintf(replacement_value)
+        end
+      end
+    end # @condrewriteother_parsed.each
+  end # def condrewriteother
+  
+  private
+  def coalesce(event)
+    @coalesce_parsed.each do |config|
+      field = config[:field]
+      subst_array = config[:subst_array]
+      
+      substitution_parsed = subst_array.map { |x| event.sprintf(x) }
+      not_nul_index = substitution_parsed.find_index { |x| not x.nil? and not x.eql?("nil") and not (not x.index("%").nil? && x.match(/%\{[^}]\}/).nil?) }
+      if not not_nul_index.nil?
+        event[field] = substitution_parsed[not_nul_index]
+      end
+    end # @coalesce_parsed.each
+  end # def coalesce
+  
+end # class LogStash::Filters::Alter

data/logstash-filter-alter.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-filter-alter'
+  s.version         = '0.1.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "The alter filter allows you to do general alterations to fields that are not included in the normal mutate filter"
+  s.description     = "The alter filter allows you to do general alterations to fields that are not included in the normal mutate filter"
+  s.authors         = ["Elasticsearch"]
+  s.email           = 'richard.pijnenburg@elasticsearch.com'
+  s.homepage        = "http://logstash.net/"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+
+  # 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", "group" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency 'logstash', '>= 1.4.0', '< 2.0.0'
+
+end
+

data/rakelib/publish.rake

@@ -0,0 +1,9 @@
+require "gem_publisher"
+
+desc "Publish gem to RubyGems.org"
+task :publish_gem do |t|
+  gem_file = Dir.glob(File.expand_path('../*.gemspec',File.dirname(__FILE__))).first
+  gem = GemPublisher.publish_if_updated(gem_file, :rubygems)
+  puts "Published #{gem}" if gem
+end
+

data/rakelib/vendor.rake

@@ -0,0 +1,169 @@
+require "net/http"
+require "uri"
+require "digest/sha1"
+
+def vendor(*args)
+  return File.join("vendor", *args)
+end
+
+directory "vendor/" => ["vendor"] do |task, args|
+  mkdir task.name
+end
+
+def fetch(url, sha1, output)
+
+  puts "Downloading #{url}"
+  actual_sha1 = download(url, output)
+
+  if actual_sha1 != sha1
+    fail "SHA1 does not match (expected '#{sha1}' but got '#{actual_sha1}')"
+  end
+end # def fetch
+
+def file_fetch(url, sha1)
+  filename = File.basename( URI(url).path )
+  output = "vendor/#{filename}"
+  task output => [ "vendor/" ] do
+    begin
+      actual_sha1 = file_sha1(output)
+      if actual_sha1 != sha1
+        fetch(url, sha1, output)
+      end
+    rescue Errno::ENOENT
+      fetch(url, sha1, output)
+    end
+  end.invoke
+
+  return output
+end
+
+def file_sha1(path)
+  digest = Digest::SHA1.new
+  fd = File.new(path, "r")
+  while true
+    begin
+      digest << fd.sysread(16384)
+    rescue EOFError
+      break
+    end
+  end
+  return digest.hexdigest
+ensure
+  fd.close if fd
+end
+
+def download(url, output)
+  uri = URI(url)
+  digest = Digest::SHA1.new
+  tmp = "#{output}.tmp"
+  Net::HTTP.start(uri.host, uri.port, :use_ssl => (uri.scheme == "https")) do |http|
+    request = Net::HTTP::Get.new(uri.path)
+    http.request(request) do |response|
+      fail "HTTP fetch failed for #{url}. #{response}" if [200, 301].include?(response.code)
+      size = (response["content-length"].to_i || -1).to_f
+      count = 0
+      File.open(tmp, "w") do |fd|
+        response.read_body do |chunk|
+          fd.write(chunk)
+          digest << chunk
+          if size > 0 && $stdout.tty?
+            count += chunk.bytesize
+            $stdout.write(sprintf("\r%0.2f%%", count/size * 100))
+          end
+        end
+      end
+      $stdout.write("\r      \r") if $stdout.tty?
+    end
+  end
+
+  File.rename(tmp, output)
+
+  return digest.hexdigest
+rescue SocketError => e
+  puts "Failure while downloading #{url}: #{e}"
+  raise
+ensure
+  File.unlink(tmp) if File.exist?(tmp)
+end # def download
+
+def untar(tarball, &block)
+  require "archive/tar/minitar"
+  tgz = Zlib::GzipReader.new(File.open(tarball))
+  # Pull out typesdb
+  tar = Archive::Tar::Minitar::Input.open(tgz)
+  tar.each do |entry|
+    path = block.call(entry)
+    next if path.nil?
+    parent = File.dirname(path)
+    
+    mkdir_p parent unless File.directory?(parent)
+
+    # Skip this file if the output file is the same size
+    if entry.directory?
+      mkdir path unless File.directory?(path)
+    else
+      entry_mode = entry.instance_eval { @mode } & 0777
+      if File.exists?(path)
+        stat = File.stat(path)
+        # TODO(sissel): Submit a patch to archive-tar-minitar upstream to
+        # expose headers in the entry.
+        entry_size = entry.instance_eval { @size }
+        # If file sizes are same, skip writing.
+        next if stat.size == entry_size && (stat.mode & 0777) == entry_mode
+      end
+      puts "Extracting #{entry.full_name} from #{tarball} #{entry_mode.to_s(8)}"
+      File.open(path, "w") do |fd|
+        # eof? check lets us skip empty files. Necessary because the API provided by
+        # Archive::Tar::Minitar::Reader::EntryStream only mostly acts like an
+        # IO object. Something about empty files in this EntryStream causes
+        # IO.copy_stream to throw "can't convert nil into String" on JRuby
+        # TODO(sissel): File a bug about this.
+        while !entry.eof?
+          chunk = entry.read(16384)
+          fd.write(chunk)
+        end
+          #IO.copy_stream(entry, fd)
+      end
+      File.chmod(entry_mode, path)
+    end
+  end
+  tar.close
+  File.unlink(tarball) if File.file?(tarball)
+end # def untar
+
+def ungz(file)
+
+  outpath = file.gsub('.gz', '')
+  tgz = Zlib::GzipReader.new(File.open(file))
+  begin
+    File.open(outpath, "w") do |out|
+      IO::copy_stream(tgz, out)
+    end
+    File.unlink(file)
+  rescue
+    File.unlink(outpath) if File.file?(outpath)
+   raise
+  end
+  tgz.close
+end
+
+desc "Process any vendor files required for this plugin"
+task "vendor" do |task, args|
+
+  @files.each do |file| 
+    download = file_fetch(file['url'], file['sha1'])
+    if download =~ /.tar.gz/
+      prefix = download.gsub('.tar.gz', '').gsub('vendor/', '')
+      untar(download) do |entry|
+        if !file['files'].nil?
+          next unless file['files'].include?(entry.full_name.gsub(prefix, ''))
+          out = entry.full_name.split("/").last
+        end
+        File.join('vendor', out)
+      end
+    elsif download =~ /.gz/
+      ungz(download)
+    end
+  end
+
+end

data/spec/filters/alter_spec.rb

@@ -0,0 +1,95 @@
+require "spec_helper"
+require "logstash/filters/alter"
+
+describe LogStash::Filters::Alter do
+
+  describe "condrewrite with static values" do
+    config <<-CONFIG
+    filter {
+      alter {
+        condrewrite => ["rewrite-me", "hello", "goodbye"]
+      }
+    }
+    CONFIG
+
+    sample("rewrite-me"  => "hello") do
+      insist { subject["rewrite-me"] } == "goodbye"
+    end
+
+    sample("rewrite-me"  => "greetings") do
+      insist { subject["rewrite-me"] } == "greetings"
+    end
+  end
+
+  describe "condrewrite with dynamic values" do
+    config <<-CONFIG
+    filter {
+      alter {
+        condrewrite => ["rewrite-me", "%{test}", "%{rewrite-value}"]
+      }
+    }
+    CONFIG
+
+    sample("rewrite-me"  => "hello", "test" => "hello",
+           "rewrite-value" => "goodbye") do
+      insist { subject["rewrite-me"] } == "goodbye"
+    end
+
+    sample("rewrite-me"  => "hello") do
+      insist { subject["rewrite-me"] } == "hello"
+    end
+
+    sample("rewrite-me"  => "%{test}") do
+      insist { subject["rewrite-me"] } == "%{rewrite-value}"
+    end
+
+    sample("rewrite-me"  => "hello", "test" => "hello") do
+      insist { subject["rewrite-me"] } == "%{rewrite-value}"
+    end
+
+    sample("rewrite-me"  => "greetings", "test" => "hello") do
+      insist { subject["rewrite-me"] } == "greetings"
+    end
+  end
+
+  describe "condrewriteother" do
+    config <<-CONFIG
+    filter {
+      alter {
+        condrewriteother => ["test-me", "hello", "rewrite-me","goodbye"]
+      }
+    }
+    CONFIG
+
+    sample("test-me"  => "hello") do
+      insist { subject["rewrite-me"] } == "goodbye"
+    end
+
+    sample("test-me"  => "hello", "rewrite-me"  => "hello2") do
+      insist { subject["rewrite-me"] } == "goodbye"
+    end
+
+    sample("test-me"  => "greetings") do
+      insist { subject["rewrite-me"] }.nil?
+    end
+
+    sample("test-me"  => "greetings",
+      "rewrite-me"  => "hello2") do
+      insist { subject["rewrite-me"] } == "hello2"
+    end
+  end
+
+  describe "coalesce" do
+    config <<-CONFIG
+    filter {
+      alter {
+        coalesce => ["coalesce-me", "%{non-existing-field}", "mydefault"]
+      }
+    }
+    CONFIG
+
+    sample("coalesce-me"  => "Hello") do
+      insist { subject["coalesce-me"] } == "mydefault" 
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-alter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elasticsearch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: The alter filter allows you to do general alterations to fields that
+  are not included in the normal mutate filter
+email: richard.pijnenburg@elasticsearch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/logstash/filters/alter.rb
+- logstash-filter-alter.gemspec
+- rakelib/publish.rake
+- rakelib/vendor.rake
+- spec/filters/alter_spec.rb
+homepage: http://logstash.net/
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  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.1
+signing_key: 
+specification_version: 4
+summary: The alter filter allows you to do general alterations to fields that are
+  not included in the normal mutate filter
+test_files:
+- spec/filters/alter_spec.rb