logstash-codec-collectd 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MDA5OTAxYjlhNjRhZGNkZTU2YzA4NDk4OTVmMjIxN2NlMmM1MzYyMA==
-  data.tar.gz: !binary |-
-    ZTk0NzIyYWFmNTM5Y2I4OTJmNzQyOTE0ZTg5N2ZhY2RlMDFkOGIzYg==
+SHA1:
+  metadata.gz: b4e60562ff9d570e40a3f6cf758eb0a3a2fe5018
+  data.tar.gz: 302a157f4baa7d20848bfdd201c1d54d6743c859
 SHA512:
-  metadata.gz: !binary |-
-    ZDkxYTgxODI4NWMxZTRkYWNjN2ZlMzU2ZTNhYTU4ZDc1ZTZmNTQyZTA0YmVh
-    NDJmNzU1ZjUzMTllOGM1ZDU5Nzg3MmI5ZDAzYzk3MmYyYTQyNzUwNTYzNGYx
-    NmZkOWE1YTdkMGZlZTMzOWY0ZWMwOWI5OTZiZWRmOTMxMjk3ZjQ=
-  data.tar.gz: !binary |-
-    ZmViMDg2NjA1Njc0Y2RmYTgyYjM5MTQ4ODQ1NmU0ZTMzMzU2ZTJjMTJiODE0
-    OTAyNzk5Y2MzOTU2YjEwN2YzYmFiMTlhYjQwYWE3YTlkYTc1Y2EzNjdiOTEy
-    NjA5OTJjYTE0OTRhYjY4ZmRhZGU0MjJmYTcyZTczNDA3ZTBlOTA=
+  metadata.gz: 8d664c539f7bbb81d121d5654ab5ca584bfc8fe6211cad8c3b62601df2a91c4cbca98de8e1f3dbe452b14bf79a49378f3d893a6f46ce527e689aad61693fecbb
+  data.tar.gz: 53fcc5e548d4db964c86791c0c9823b09e456d8a52d28b4442c2ec1b9fbe9ddc6d619a6618966d7e16601158c6a9d283a036d3ad3440156458dd6f43f6cd4df5

data/Gemfile

@@ -1,4 +1,3 @@
-source 'http://rubygems.org'
-gem 'rake'
-gem 'gem_publisher'
-gem 'archive-tar-minitar' 
+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

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

data/lib/logstash/codecs/collectd.rb

@@ -6,10 +6,16 @@ require "logstash/errors"
 require "tempfile"
 require "time"
 
-# Read events from the connectd binary protocol over the network via udp.
+class ProtocolError < LogStash::Error; end
+class HeaderError < LogStash::Error; end
+class EncryptionError < LogStash::Error; end
+class NaNError < LogStash::Error; end
+
+# Read events from the collectd binary protocol over the network via udp.
 # See https://collectd.org/wiki/index.php/Binary_protocol
 #
 # Configuration in your Logstash configuration file can be as simple as:
+# [source,ruby]
 #     input {
 #       udp {
 #         port => 28526
@@ -18,8 +24,8 @@ require "time"
 #       }
 #     }
 #
-# A sample collectd.conf to send to Logstash might be:
-#
+# A sample `collectd.conf` to send to Logstash might be:
+# [source,xml]
 #     Hostname    "host.example.com"
 #     LoadPlugin interface
 #     LoadPlugin load
@@ -34,14 +40,8 @@ require "time"
 #         </Server>
 #     </Plugin>
 #
-# Be sure to replace "10.0.0.1" with the IP of your Logstash instance.
+# Be sure to replace `10.0.0.1` with the IP of your Logstash instance.
 #
-
-class ProtocolError < LogStash::Error; end
-class HeaderError < LogStash::Error; end
-class EncryptionError < LogStash::Error; end
-class NaNError < LogStash::Error; end
-
 class LogStash::Codecs::Collectd < LogStash::Codecs::Base
   config_name "collectd"
   milestone 1
@@ -106,37 +106,38 @@ class LogStash::Codecs::Collectd < LogStash::Codecs::Base
   SECURITY_SIGN = "Sign"
   SECURITY_ENCR = "Encrypt"
 
-  # File path(s) to collectd types.db to use.
+  # File path(s) to collectd `types.db` to use.
   # The last matching pattern wins if you have identical pattern names in multiple files.
-  # If no types.db is provided the included types.db will be used (currently 5.4.0).
+  # If no types.db is provided the included `types.db` will be used (currently 5.4.0).
   config :typesdb, :validate => :array
 
-  # Prune interval records.  Defaults to true.
+  # Prune interval records.  Defaults to `true`.
   config :prune_intervals, :validate => :boolean, :default => true
 
-  # Security Level. Default is "None". This setting mirrors the setting from the
-  # collectd [Network plugin](https://collectd.org/wiki/index.php/Plugin:Network)
+  # Security Level. Default is `None`. This setting mirrors the setting from the
+  # collectd https://collectd.org/wiki/index.php/Plugin:Network[Network plugin]
   config :security_level, :validate => [SECURITY_NONE, SECURITY_SIGN, SECURITY_ENCR],
     :default => "None"
   
-  # What to do when a value in the event is NaN (Not a Number)
-  # - change_value (default): Change the NaN to the value of the nan_value option and add nan_tag as a tag
-  # - warn: Change the NaN to the value of the nan_value option, print a warning to the log and add nan_tag as a tag
-  # - drop: Drop the event containing the NaN (this only drops the single event, not the whole packet)
+  # What to do when a value in the event is `NaN` (Not a Number)
+  #
+  # - change_value (default): Change the `NaN` to the value of the nan_value option and add `nan_tag` as a tag
+  # - warn: Change the `NaN` to the value of the nan_value option, print a warning to the log and add `nan_tag` as a tag
+  # - drop: Drop the event containing the `NaN` (this only drops the single event, not the whole packet)
   config :nan_handling, :validate => ['change_value','warn','drop'], :default => 'change_value'
   
-  # Only relevant when nan_handeling is set to 'change_value'
+  # Only relevant when `nan_handeling` is set to `change_value`
   # Change NaN to this configured value
   config :nan_value, :validate => :number, :default => 0
   
-  # The tag to add to the event if a NaN value was found
+  # The tag to add to the event if a `NaN` value was found
   # Set this to an empty string ('') if you don't want to tag
   config :nan_tag, :validate => :string, :default => '_collectdNaN'
 
   # Path to the authentication file. This file should have the same format as
-  # the [AuthFile](http://collectd.org/documentation/manpages/collectd.conf.5.shtml#authfile_filename)
-  # in collectd. You only need to set this option if the security_level is set to
-  # "Sign" or "Encrypt"
+  # the http://collectd.org/documentation/manpages/collectd.conf.5.shtml#authfile_filename[AuthFile]
+  # in collectd. You only need to set this option if the `security_level` is set to
+  # `Sign` or `Encrypt`
   config :authfile, :validate => :string
 
   public

data/logstash-codec-collectd.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-codec-collectd'
-  s.version         = '0.1.0'
+  s.version         = '0.1.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Read events from the connectd binary protocol"
-  s.description     = "Read events from the connectd binary protocol"
+  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.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" => "codec" }
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "codec" }
 
   # Gem dependencies
   s.add_runtime_dependency 'logstash', '>= 1.4.0', '< 2.0.0'
 
+  s.add_development_dependency 'logstash-devutils'
 end
 

data/spec/codecs/{collectd.rb → collectd_spec.rb}

@@ -1,3 +1,4 @@
+require "logstash/devutils/rspec/spec_helper"
 require "logstash/codecs/collectd"
 require "logstash/event"
 require "insist"

metadata

@@ -1,36 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: logstash-codec-collectd
 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-30 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: Read events from the connectd binary protocol
+  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: richard.pijnenburg@elasticsearch.com
 executables: []
 extensions: []
@@ -38,38 +52,37 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
 - Rakefile
 - lib/logstash/codecs/collectd.rb
 - logstash-codec-collectd.gemspec
-- rakelib/publish.rake
-- rakelib/vendor.rake
-- spec/codecs/collectd.rb
+- spec/codecs/collectd_spec.rb
 - vendor/types.db
-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: codec
-post_install_message: 
+  logstash_group: codec
+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: Read events from the connectd binary protocol
 test_files:
-- spec/codecs/collectd.rb
+- spec/codecs/collectd_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 response.code != "200"
-      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