logstash-filter-kv 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTZmNmRlZDE1NWJmNmViNjYwZDE0NjY5ZmY2Mjk0MWEzNjBhODZkYQ==
-  data.tar.gz: !binary |-
-    MGY0OTJiMWNlNDQ5ZjJlZmM5YzczODI5ZTEwZjMwZjBiNGY5MjZkNA==
+SHA1:
+  metadata.gz: 6ca5fa85eabb6bf32ae3a03dfb9c26950faef085
+  data.tar.gz: 96cfc42fa04f19849cf791b527045785f79ec665
 SHA512:
-  metadata.gz: !binary |-
-    NzgxZTMxNzIzNzk1OTc4NGFhYTQ1MTVmYzJjZmE4MzMyMGFmMGVhYjk2M2Rm
-    MGUyMjM4NGM1MmQ5MWJhNGJjOTQxYmI5MzU0M2JlYjI0MmYxNzMwZTg3Mjdh
-    ZWMxNmI0ZjlhMDE0YTY2YTUwM2IyYzY0NzIxYWU5OWY2ZTA3ZmI=
-  data.tar.gz: !binary |-
-    MDE3MzIzOGQ1ZGJmNmJjNzNjZjgzZjZjYzg0MWRmNTNhMjU0NzZjMTJjY2M4
-    MTZiZDRlNTUwYzQ4ODllZGNiZjUzNDRiYWVjODlhNTI5Mzg2ZjNmZjVlZThh
-    Y2RiMjNjMjYyMmVlNjRmODE3NDk4NTQyZDI4NWFiNGQxZGY5NWQ=
+  metadata.gz: 708d8e0d40e512a82e700ba0ca2e5df6fa1e464fa315c09d6c2b0cd9db6f41c2ecc5b5a58cfb97ddcec7bec2f92a312503527546e054e60a4b166e0376e6f20e
+  data.tar.gz: e3bbe7e9065e17f1f83b38a928cff43492148f4b7b769c3853340a9182b89ea014d832d3780cb5da72379bca79c72d39706652e4bf629131dae8583759871f05

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/kv.rb

@@ -3,28 +3,28 @@ require "logstash/filters/base"
 require "logstash/namespace"
 
 # This filter helps automatically parse messages (or specific event fields)
-# which are of the 'foo=bar' variety.
-#
-# For example, if you have a log message which contains 'ip=1.2.3.4
-# error=REFUSED', you can parse those automatically by configuring:
+# which are of the `foo=bar` variety.
 #
+# For example, if you have a log message which contains `ip=1.2.3.4
+# error=REFUSED`, you can parse those automatically by configuring:
+# [source,ruby]
 #     filter {
 #       kv { }
 #     }
 #
-# The above will result in a message of "ip=1.2.3.4 error=REFUSED" having
+# The above will result in a message of `ip=1.2.3.4 error=REFUSED` having
 # the fields:
 #
-# * ip: 1.2.3.4
-# * error: REFUSED
+# * `ip: 1.2.3.4`
+# * `error: REFUSED`
 #
 # This is great for postfix, iptables, and other types of logs that
-# tend towards 'key=value' syntax.
+# tend towards `key=value` syntax.
 #
 # You can configure any arbitrary strings to split your data on,
-# in case your data is not structured using '=' signs and whitespace.
+# in case your data is not structured using `=` signs and whitespace.
 # For example, this filter can also be used to parse query parameters like
-# 'foo=bar&baz=fizz' by setting the `field_split` parameter to "&".
+# `foo=bar&baz=fizz` by setting the `field_split` parameter to `&`.
 class LogStash::Filters::KV < LogStash::Filters::Base
   config_name "kv"
   milestone 2
@@ -34,10 +34,10 @@ class LogStash::Filters::KV < LogStash::Filters::Base
   # logs).
   #
   # These characters form a regex character class and thus you must escape special regex
-  # characters like '[' or ']' using '\'.
-  #
-  # For example, to strip '<', '>', '[', ']' and ',' characters from values:
+  # characters like `[` or `]` using `\`.
   #
+  # For example, to strip `<`, `>`, `[`, `]` and `,` characters from values:
+  # [source,ruby]
   #     filter {
   #       kv {
   #         trim => "<>\[\],"
@@ -49,10 +49,10 @@ class LogStash::Filters::KV < LogStash::Filters::Base
   # keys are wrapped in brackets or start with space.
   #
   # These characters form a regex character class and thus you must escape special regex
-  # characters like '[' or ']' using '\'.
-  #
-  # For example, to strip '<' '>' '[' ']' and ',' characters from keys:
+  # characters like `[` or `]` using `\`.
   #
+  # For example, to strip `<` `>` `[` `]` and `,` characters from keys:
+  # [source,ruby]
   #     filter {
   #       kv {
   #         trimkey => "<>\[\],"
@@ -63,52 +63,52 @@ class LogStash::Filters::KV < LogStash::Filters::Base
   # A string of characters to use as delimiters for parsing out key-value pairs.
   #
   # These characters form a regex character class and thus you must escape special regex
-  # characters like '[' or ']' using '\'.
+  # characters like `[` or `]` using `\`.
   #
   # #### Example with URL Query Strings
   #
   # For example, to split out the args from a url query string such as
-  # '?pin=12345~0&d=123&e=foo@bar.com&oq=bobo&ss=12345':
-  #
+  # `?pin=12345~0&d=123&e=foo@bar.com&oq=bobo&ss=12345`:
+  # [source,ruby]
   #     filter {
   #       kv {
   #         field_split => "&?"
   #       }
   #     }
   #
-  # The above splits on both "&" and "?" characters, giving you the following
+  # The above splits on both `&` and `?` characters, giving you the following
   # fields:
   #
-  # * pin: 12345~0
-  # * d: 123
-  # * e: foo@bar.com
-  # * oq: bobo
-  # * ss: 12345
+  # * `pin: 12345~0`
+  # * `d: 123`
+  # * `e: foo@bar.com`
+  # * `oq: bobo`
+  # * `ss: 12345`
   config :field_split, :validate => :string, :default => ' '
 
 
   # A string of characters to use as delimiters for identifying key-value relations.
   #
   # These characters form a regex character class and thus you must escape special regex
-  # characters like '[' or ']' using '\'.
+  # characters like `[` or `]` using `\`.
   #
   # For example, to identify key-values such as
-  # 'key1:value1 key2:value2':
-  #
+  # `key1:value1 key2:value2`:
+  # [source,ruby]
   #     filter { kv { value_split => ":" } }
   config :value_split, :validate => :string, :default => '='
 
   # A string to prepend to all of the extracted keys.
   #
   # For example, to prepend arg_ to all keys:
-  #
+  # [source,ruby]
   #     filter { kv { prefix => "arg_" } }
   config :prefix, :validate => :string, :default => ''
 
-  # The field to perform 'key=value' searching on
+  # The field to perform `key=value` searching on
   #
   # For example, to process the `not_the_message` field:
-  #
+  # [source,ruby]
   #     filter { kv { source => "not_the_message" } }
   config :source, :validate => :string, :default => "message"
 
@@ -118,15 +118,16 @@ class LogStash::Filters::KV < LogStash::Filters::Base
   # event, as individual fields.
   #
   # For example, to place all keys into the event field kv:
-  #
+  # [source,ruby]
   #     filter { kv { target => "kv" } }
   config :target, :validate => :string
 
   # An array specifying the parsed keys which should be added to the event.
   # By default all keys will be added.
   #
-  # For example, consider a source like "Hey, from=<abc>, to=def foo=bar". 
-  # To include "from" and "to", but exclude the "foo" key, you could use this configuration:
+  # For example, consider a source like `Hey, from=<abc>, to=def foo=bar`. 
+  # To include `from` and `to`, but exclude the `foo` key, you could use this configuration:
+  # [source,ruby]
   #     filter {
   #       kv {
   #         include_keys => [ "from", "to" ]
@@ -137,8 +138,9 @@ class LogStash::Filters::KV < LogStash::Filters::Base
   # An array specifying the parsed keys which should not be added to the event.
   # By default no keys will be excluded.
   #
-  # For example, consider a source like "Hey, from=<abc>, to=def foo=bar". 
-  # To exclude "from" and "to", but retain the "foo" key, you could use this configuration:
+  # For example, consider a source like `Hey, from=<abc>, to=def foo=bar`. 
+  # To exclude `from` and `to`, but retain the `foo` key, you could use this configuration:
+  # [source,ruby]
   #     filter {
   #       kv {
   #         exclude_keys => [ "from", "to" ]
@@ -148,7 +150,7 @@ class LogStash::Filters::KV < LogStash::Filters::Base
 
   # A hash specifying the default keys and their values which should be added to the event
   # in case these keys do not exist in the source field being parsed.
-  #
+  # [source,ruby]
   #     filter {
   #       kv {
   #         default_keys => [ "from", "logstash@example.com",

data/logstash-filter-kv.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-kv'
-  s.version         = '0.1.0'
+  s.version         = '0.1.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This filter helps automatically parse messages (or specific event fields) which are of the 'foo=bar' variety."
-  s.description     = "This filter helps automatically parse messages (or specific event fields) which are of the 'foo=bar' variety."
+  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,11 @@ 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_development_dependency 'logstash-devutils'
 end
 

data/spec/filters/kv_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require "logstash/devutils/rspec/spec_helper"
 require "logstash/filters/kv"
 
 describe LogStash::Filters::KV do

metadata

@@ -1,76 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-kv
 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-11-02 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !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
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.4.0
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
-description: This filter helps automatically parse messages (or specific event fields)
-  which are of the 'foo=bar' variety.
-email: richard.pijnenburg@elasticsearch.com
+  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: info@elasticsearch.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
 - Rakefile
 - lib/logstash/filters/kv.rb
 - logstash-filter-kv.gemspec
-- rakelib/publish.rake
-- rakelib/vendor.rake
 - spec/filters/kv_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: This filter helps automatically parse messages (or specific event fields)
-  which are of the 'foo=bar' variety.
+summary: This filter helps automatically parse messages (or specific event fields) which are of the 'foo=bar' variety.
 test_files:
 - spec/filters/kv_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