logstash-filter-mutate 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MmZhMDNmZDM5MGVmMGEwNTM4N2ZlMTlmZmIyNmZkODU5MmRiNzliMA==
-  data.tar.gz: !binary |-
-    MjE0Mzc3M2QyOTczN2Q3NDIyM2EyZGUwMmEzZTM5M2FjOWZhNjc3Mw==
+SHA1:
+  metadata.gz: e1a18fa5b241d8d58dd013933b60a702dcfdc288
+  data.tar.gz: d33b112ef930d1000bbaf69be4b7cc323855aa95
 SHA512:
-  metadata.gz: !binary |-
-    NGVlZWVmNjcwNWI0NTA2YWEzOGZiZmJmYjUzNGU0ODQ3NjFhMTFlZjBlZGNm
-    MTE4NjAxYzU2YTUwY2JjMGE2NmNmZjUzNWU5ZmI0MWQzMjM3ZGMyYWZmMGI3
-    YTU5NTAwNjcyOGNjZjE1ZDI2OTMxY2ExOTA3MzRjMzNlZTUyOWE=
-  data.tar.gz: !binary |-
-    M2JiODBlMzk1YTdhYzJjNGZmOGZhYzllNTQxZTNlNWIwYzNhYzE2YmZmMDA1
-    ZDJmYjk2ZWU5M2JiNzA0OWQyOGE0OTBjNGRiMDdjMTM2NGRlMTUyNzY4Zjkz
-    YzNlOTJjZTlkYzYxZDZlN2RmZTFjZDIxMzYwNzYxNDg3ODQ0M2I=
+  metadata.gz: f292e896bf3cf0ab5a13c0870193e1a77cc2dc55bb35b3502d36a3b38f2d445472cb531deaa6cece61647e2465038a444fd570860986f74f5d9740a59b7d5e44
+  data.tar.gz: 7ad094fff3b4c5212dff464f314a67f2fe6d3e85e312464bbd427561702cf63cbe2e1c0130f330bde9597200a7cc05bd936c547914d4eca26774f491ab9c9a06

data/Gemfile

@@ -1,3 +1,3 @@
-source 'http://rubygems.org'
-gem 'rake'
-gem 'gem_publisher'
+source 'https://rubygems.org'
+gemspec
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012-2014 Elasticsearch <http://www.elasticsearch.org>
+
+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/Rakefile

@@ -4,3 +4,4 @@ task :default do
   system("rake -T")
 end
 
+require "logstash/devutils/rake"

data/lib/logstash/filters/mutate.rb

@@ -5,7 +5,7 @@ require "logstash/namespace"
 # The mutate filter allows you to perform general mutations on fields. You
 # can rename, remove, replace, and modify fields in your events.
 #
-# TODO(sissel): Support regexp replacements like String#gsub ?
+# TODO(sissel): Support regexp replacements like `String#gsub` ?
 class LogStash::Filters::Mutate < LogStash::Filters::Base
   config_name "mutate"
   milestone 3
@@ -13,7 +13,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   # Rename one or more fields.
   #
   # Example:
-  #
+  # [source,ruby]
   #     filter {
   #       mutate {
   #         # Renames the 'HOSTORIP' field to 'client_ip'
@@ -25,14 +25,14 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   # Remove one or more fields.
   #
   # Example:
-  #
+  # [source,ruby]
   #     filter {
   #       mutate {
   #         remove => [ "client" ]  # Removes the 'client' field
   #       }
   #     }
   #
-  # This option is deprecated, instead use remove_field option available in all
+  # This option is deprecated, instead use `remove_field` option available in all
   # filters.
   config :remove, :validate => :array, :deprecated => true
 
@@ -40,7 +40,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   # to help you build a new value from other parts of the event.
   #
   # Example:
-  #
+  # [source,ruby]
   #     filter {
   #       mutate {
   #         replace => { "message" => "%{source_host}: My new message" }
@@ -52,7 +52,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   # then no action will be taken.
   #
   # Example:
-  #
+  # [source,ruby]
   #     filter {
   #       mutate {
   #         update => { "sample" => "My new message" }
@@ -67,7 +67,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   # Valid conversion targets are: integer, float, string.
   #
   # Example:
-  #
+  # [source,ruby]
   #     filter {
   #       mutate {
   #         convert => { "fieldname" => "integer" }
@@ -84,7 +84,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   # Be aware of escaping any backslash in the config file.
   #
   # Example:
-  #
+  # [source,ruby]
   #     filter {
   #       mutate {
   #         gsub => [
@@ -103,7 +103,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   # Convert a string to its uppercase equivalent.
   #
   # Example:
-  #
+  # [source,ruby]
   #     filter {
   #       mutate {
   #         uppercase => [ "fieldname" ]
@@ -114,7 +114,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   # Convert a string to its lowercase equivalent.
   #
   # Example:
-  #
+  # [source,ruby]
   #     filter {
   #       mutate {
   #         lowercase => [ "fieldname" ]
@@ -126,7 +126,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   # fields.
   #
   # Example:
-  #
+  # [source,ruby]
   #     filter {
   #       mutate {
   #          split => { "fieldname" => "," }
@@ -137,7 +137,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   # Join an array with a separator character. Does nothing on non-array fields.
   #
   # Example:
-  #
+  # [source,ruby]
   #    filter {
   #      mutate {
   #        join => { "fieldname" => "," }
@@ -148,7 +148,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   # Strip whitespace from field. NOTE: this only works on leading and trailing whitespace.
   #
   # Example:
-  #
+  # [source,ruby]
   #     filter {
   #       mutate {
   #          strip => ["field1", "field2"]
@@ -158,12 +158,13 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
 
   # Merge two fields of arrays or hashes.
   # String fields will be automatically be converted into an array, so:
-  #   array + string will work
-  #   string + string will result in an 2 entry array in dest_field
-  #   array and hash will not work
-  #
+  # ==========================
+  #   `array` + `string` will work
+  #   `string` + `string` will result in an 2 entry array in `dest_field`
+  #   `array` and `hash` will not work
+  # ==========================
   # Example:
-  #
+  # [source,ruby]
   #     filter {
   #       mutate {
   #          merge => { "dest_field" => "added_field" }
@@ -390,21 +391,19 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   private
   def merge(event)
     @merge.each do |dest_field, added_fields|
-      #When multiple calls, added_field is an array
-      added_fields = [ added_fields ] if ! added_fields.is_a?(Array)
-      added_fields.each do |added_field|
+      # When multiple calls, added_field is an array
+      Array(added_fields).each do |added_field|
         if event[dest_field].is_a?(Hash) ^ event[added_field].is_a?(Hash)
-          @logger.error("Not possible to merge an array and a hash: ",
-                        :dest_field => dest_field,
-                        :added_field => added_field )
+          @logger.error("Not possible to merge an array and a hash: ", :dest_field => dest_field, :added_field => added_field )
           next
         end
-        if event[dest_field].is_a?(Hash) #No need to test the other
+
+        if event[dest_field].is_a?(Hash)
+          # No need to test the other
           event[dest_field].update(event[added_field])
         else
-          event[dest_field] = [event[dest_field]] if ! event[dest_field].is_a?(Array)
-          event[added_field] = [event[added_field]] if ! event[added_field].is_a?(Array)
-         event[dest_field].concat(event[added_field])
+          event[dest_field] = Array(event[dest_field])
+          event[dest_field].concat(Array(event[added_field]))
         end
       end
     end

data/logstash-filter-mutate.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-mutate'
-  s.version         = '0.1.0'
+  s.version         = '0.1.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "The mutate filter allows you to perform general mutations on fields. You can rename, remove, replace, and modify fields in your events."
-  s.description     = "The mutate filter allows you to perform general mutations on fields. You can rename, remove, replace, and modify fields in your events."
+  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         = ["Elasticsearch"]
-  s.email           = 'richard.pijnenburg@elasticsearch.com'
-  s.homepage        = "http://logstash.net/"
+  s.email           = 'info@elasticsearch.com'
+  s.homepage        = "http://www.elasticsearch.org/guide/en/logstash/current/index.html"
   s.require_paths = ["lib"]
 
   # Files
@@ -17,10 +17,12 @@ Gem::Specification.new do |s|
   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" }
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
 
   # Gem dependencies
   s.add_runtime_dependency 'logstash', '>= 1.4.0', '< 2.0.0'
-
+  s.add_runtime_dependency 'logstash-patterns-core'
+  s.add_runtime_dependency 'logstash-filter-grok'
+  s.add_development_dependency 'logstash-devutils'
 end
 

data/spec/filters/mutate_spec.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require "spec_helper"
+require "logstash/devutils/rspec/spec_helper"
 require "logstash/filters/mutate"
 
 describe LogStash::Filters::Mutate do
@@ -254,5 +254,104 @@ describe LogStash::Filters::Mutate do
       ]
     end
   end
+
+  describe "merge string field into inexisting field" do
+    config '
+      filter {
+        mutate {
+          merge => [ "list", "foo" ]
+        }
+      }'
+
+    sample("foo" => "bar") do
+      insist { subject["list"] } == ["bar"]
+      insist { subject["foo"] } == "bar"
+    end
+  end
+
+  describe "merge string field into empty array" do
+    config '
+      filter {
+        mutate {
+          merge => [ "list", "foo" ]
+        }
+      }'
+
+    sample("foo" => "bar", "list" => []) do
+      insist { subject["list"] } == ["bar"]
+      insist { subject["foo"] } == "bar"
+    end
+  end
+
+  describe "merge string field into existing array" do
+    config '
+      filter {
+        mutate {
+          merge => [ "list", "foo" ]
+        }
+      }'
+
+    sample("foo" => "bar", "list" => ["baz"]) do
+      insist { subject["list"] } == ["baz", "bar"]
+      insist { subject["foo"] } == "bar"
+    end
+  end
+
+  describe "merge non empty array field into existing array" do
+    config '
+      filter {
+        mutate {
+          merge => [ "list", "foo" ]
+        }
+      }'
+
+    sample("foo" => ["bar"], "list" => ["baz"]) do
+      insist { subject["list"] } == ["baz", "bar"]
+      insist { subject["foo"] } == ["bar"]
+    end
+  end
+
+  describe "merge empty array field into existing array" do
+    config '
+      filter {
+        mutate {
+          merge => [ "list", "foo" ]
+        }
+      }'
+
+    sample("foo" => [], "list" => ["baz"]) do
+      insist { subject["list"] } == ["baz"]
+      insist { subject["foo"] } == []
+    end
+  end
+
+  describe "merge array field into string field" do
+    config '
+      filter {
+        mutate {
+          merge => [ "list", "foo" ]
+        }
+      }'
+
+    sample("foo" => ["bar"], "list" => "baz") do
+      insist { subject["list"] } == ["baz", "bar"]
+      insist { subject["foo"] } == ["bar"]
+    end
+  end
+
+  describe "merge string field into string field" do
+    config '
+      filter {
+        mutate {
+          merge => [ "list", "foo" ]
+        }
+      }'
+
+    sample("foo" => "bar", "list" => "baz") do
+      insist { subject["list"] } == ["baz", "bar"]
+      insist { subject["foo"] } == "bar"
+    end
+  end
+
 end
 

metadata

@@ -1,76 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-mutate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Elasticsearch
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-10-25 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash
+  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: logstash-patterns-core
+  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: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-filter-grok
+  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: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0
-description: The mutate filter allows you to perform general mutations on fields.
-  You can rename, remove, replace, and modify fields in your events.
-email: richard.pijnenburg@elasticsearch.com
+        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: info@elasticsearch.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
 - Rakefile
 - lib/logstash/filters/mutate.rb
 - logstash-filter-mutate.gemspec
-- rakelib/publish.rake
-- rakelib/vendor.rake
 - spec/filters/mutate_spec.rb
-homepage: http://logstash.net/
+homepage: http://www.elasticsearch.org/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
 metadata:
   logstash_plugin: 'true'
-  group: filter
-post_install_message: 
+  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.1
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.4.4
+signing_key:
 specification_version: 4
-summary: The mutate filter allows you to perform general mutations on fields. You
-  can rename, remove, replace, and modify fields in your events.
+summary: The mutate filter allows you to perform general mutations on fields. You can rename, remove, replace, and modify fields in your events.
 test_files:
 - spec/filters/mutate_spec.rb

data/rakelib/publish.rake

@@ -1,9 +0,0 @@
-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

@@ -1,169 +0,0 @@
-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