logstash-filter-bytes2human 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b2708a5f0cfd2893814460ac226abc56cbc84e5
+  data.tar.gz: a7f06a7280e707c3f28bf673f10b6339834c6feb
+SHA512:
+  metadata.gz: 1c84be25afb9800da3df8e50f3de387a3190b02f82917379fd8dbb32bde430856b68c2cf9c53fc1a4fa3af711c161fd76b98f11a73352b7aa465b00b404b7c46
+  data.tar.gz: 7feb4061871d719e74f8e967500b0fbc9f62cc57b1c0f9fdb965bd2d1bd43c92579ffbb26829028dc5a24e36f4fab827a8cb9901d6f0e042620e74a682728167

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012-2015 Elastics.co <http://www.elastics.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/README.md

@@ -0,0 +1,86 @@
+# 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.
+
+## 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.org/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 logstash-users@googlegroups.com mailing list.
+
+## 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/Rakefile

@@ -0,0 +1,2 @@
+require "logstash/devutils/rake"
+require "logstash/devutils/rake"

data/lib/logstash/filters/bytes2human.rb

@@ -0,0 +1,80 @@
+require "logstash/filters/base"
+require "logstash/filters/bytes2human/filesize"
+require "logstash/namespace"
+
+# The bytes2human filter allows conversion from text (e.g. 2.5 GB) to integer bytes
+# or from integer bytes to human readable form
+# It understands MB, MiB etc.
+
+class LogStash::Filters::Bytes2Human < LogStash::Filters::Base
+  config_name "bytes2human"
+
+  # The fields which should be converted, and the direction to convert (human, bytes)
+  # Example:
+  #
+  #     filter {
+  #       bytes2human {
+  #         # Converts 'data_size' field from 2.4 KB to 2400
+  #         convert => { "data_size" => "bytes" }
+  #       }
+  #     }
+  #     
+  # or
+  #
+  #     filter {
+  #       bytes2human {
+  #         # Converts 'data_size' field from 123456 to "123.456 MB"
+  #         convert => { "data_size" => "human" }
+  #       }
+  #     }
+  config :convert, :validate => :hash
+
+  public
+  def register
+    valid_directions = %w(human bytes)
+    @convert.nil? or @convert.each do |field, direction|
+      if !valid_directions.include?(direction)
+        @logger.error("Invalid conversion direction", "direction" => direction, "expected one of" => valid_directions )
+        # TODO: RCL 2014-03-19 propper 'configuration broken' exception
+        raise "Bad configuration, aborting."
+      end
+    end # @convert.each
+  end # def register
+
+  public
+  def filter(event)
+    return unless filter?(event)
+    convert(event) if @convert
+    filter_matched(event)
+  end # def filter
+
+  def convert(event)
+    @convert.each do |field, direction|
+      next unless event.include?(field)
+      original = event[field]
+      
+      if original.nil?
+        next
+      elsif original.is_a?(Hash)
+        @logger.debug("I don't know how to type convert a hash, skipping",
+                      :field => field, :value => original)
+        next
+      elsif original.is_a?(Array)
+        if direction == "human"
+          value = original.map { |v| Filesize.from(v.to_s + " B").pretty.force_encoding("UTF-8") }
+        else
+          value = original.map { |v| Filesize.from(v).to_i }
+        end
+      else
+        if direction == "human"
+          value = Filesize.from(original.to_s + " B").pretty.force_encoding("UTF-8")
+        else
+          value = Filesize.from(original).to_i;
+        end
+      end
+      event[field] = value
+    end
+  end # def convert
+
+end # class LogStash::Filters::Bytes2Human
+

data/lib/logstash/filters/bytes2human/filesize.rb

@@ -0,0 +1,200 @@
+# This module was based on and modified from:
+# https://github.com/dominikh/filesize/blob/master/lib/filesize.rb
+# Copyright (c) 2015 Robin Clarke
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+class Filesize
+  TYPE_PREFIXES ||= {
+    # Unit prefixes used for SI file sizes.
+    SI: %w{k M G T P E Z Y},
+    # Unit prefixes used for binary file sizes.
+    BINARY: %w{Ki Mi Gi Ti Pi Ei Zi Yi}
+  }
+
+  # @deprecated Please use TYPE_PREFIXES[:SI] instead
+  PREFIXES ||= TYPE_PREFIXES[:SI]
+
+  # Set of rules describing file sizes according to SI units.
+  SI ||= {
+    :regexp => /^([\d,.]+)?\s?([kmgtpezy]?)b$/i,
+    :multiplier => 1000,
+    :prefixes => TYPE_PREFIXES[:SI],
+    :presuffix => '' # deprecated
+  }
+  # Set of rules describing file sizes according to binary units.
+  BINARY ||= {
+    :regexp => /^([\d,.]+)?\s?(?:([kmgtpezy])i)?b$/i,
+    :multiplier => 1024,
+    :prefixes => TYPE_PREFIXES[:BINARY],
+    :presuffix => 'i' # deprecated
+  }
+
+  # @param [Number] size A file size, in bytes.
+  # @param [SI, BINARY] type Which type to use for conversions.
+  def initialize(size, type = BINARY)
+    @bytes = size.to_i
+    @type  = type
+  end
+
+  # @return [Number] Returns the size in bytes.
+  def to_i
+    @bytes
+  end
+  alias_method :to_int, :to_i
+
+  # @param [String] unit Which unit to convert to.
+  # @return [Float] Returns the size in a given unit.
+  def to(unit = 'B')
+    to_parts = self.class.parse(unit)
+    prefix   = to_parts[:prefix]
+
+    if prefix == 'B' or prefix.empty?
+      return to_i.to_f
+    end
+
+    to_type = to_parts[:type]
+    size    = @bytes
+
+    pos = (@type[:prefixes].map { |s| s[0].downcase }.index(prefix.downcase) || -1) + 1
+
+    size = size/(to_type[:multiplier].to_f**(pos)) unless pos < 1
+  end
+  alias_method :to_f, :to
+
+  # @param (see #to_f)
+  # @return [String] Same as {#to_f}, but as a string, with the unit appended.
+  # @see #to_f
+  def to_s(unit = 'B')
+    "%.2f %s" % [to(unit).to_f.to_s, unit]
+  end
+
+  # Same as {#to_s} but with an automatic determination of the most
+  # sensible unit.
+  #
+  # @return [String]
+  # @see #to_s
+  def pretty
+    size = @bytes
+    if size < @type[:multiplier]
+      unit = "B"
+    else
+      pos = (Math.log(size) / Math.log(@type[:multiplier])).floor
+      pos = @type[:prefixes].size-1 if pos > @type[:prefixes].size - 1
+
+      unit = @type[:prefixes][pos-1] + "B"
+    end
+
+    to_s(unit)
+  end
+
+  # @return [Filesize]
+  def +(other)
+    self.class.new(@bytes + other.to_i, @type)
+  end
+
+  # @return [Filesize]
+  def -(other)
+    self.class.new(@bytes - other.to_i, @type)
+  end
+
+  # @return [Filesize]
+  def *(other)
+    self.class.new(@bytes * other.to_i, @type)
+  end
+
+  # @return [Filesize]
+  def /(other)
+    result = @bytes / other.to_f
+    if other.is_a? Filesize
+      result
+    else
+      self.class.new(result, @type)
+    end
+  end
+
+  # @return [Boolean]
+  def ==(other)
+    other.is_a?(self.class) && other.to_i == self.to_i
+  end
+
+  # @return [Array<self, other>]
+  # @api private
+  def coerce(other)
+    return self, other
+  end
+
+  class << self
+    # Parses a string, which describes a file size, and returns a
+    # Filesize object.
+    #
+    # @param [String] arg A file size to parse.
+    # @raise [ArgumentError] Raised if the file size cannot be parsed properly.
+    # @return [Filesize]
+    def from(arg)
+      parts  = parse(arg)
+      prefix = parts[:prefix]
+      size   = parts[:size]
+      type   = parts[:type]
+
+      raise ArgumentError, "Unparseable filesize" unless type
+
+      offset = (type[:prefixes].map { |s| s[0].downcase }.index(prefix.downcase) || -1) + 1
+
+      new(size * (type[:multiplier] ** (offset)), type)
+    end
+
+    # @return [Hash<:prefix, :size, :type>]
+    # @api private
+    def parse(string)
+      type = nil
+      # in this order, so we prefer si :)
+      [SI, BINARY].each { |_type|
+        if string =~ _type[:regexp]
+          type    =  _type
+          break
+        end
+      }
+
+      prefix = $2 || ''
+      size   = ($1 || 0).to_f
+
+      return { :prefix => prefix, :size => size, :type => type}
+    end
+  end
+
+  # The size of a floppy disk
+  Floppy ||= Filesize.from("1474 KiB")
+  # The size of a CD
+  CD     ||= Filesize.from("700 MB")
+  # The size of a common DVD
+  DVD_5  ||= Filesize.from("4.38 GiB")
+  # The same as a DVD 5
+  DVD    ||= DVD_5
+  # The size of a single-sided dual-layer DVD
+  DVD_9  ||= Filesize.from("7.92 GiB")
+  # The size of a double-sided single-layer DVD
+  DVD_10 ||= DVD_5 * 2
+  # The size of a double-sided DVD, combining a DVD-9 and a DVD-5
+  DVD_14 ||= DVD_9 + DVD_5
+  # The size of a double-sided dual-layer DVD
+  DVD_18 ||= DVD_14 * 2
+  # The size of a Zip disk
+  ZIP    ||= Filesize.from("100 MB")
+end

data/logstash-filter-bytes2human.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-filter-bytes2human'
+  s.version         = '0.1.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Convert to and from human readable bytes."
+  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         = ["Elastics.co"]
+  s.email           = 'info@elastics.co'
+  s.homepage        = "http://www.elastics.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+
+  # 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", '>= 1.4.0', '< 2.0.0'
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/filters/bytes2human_spec.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/filters/bytes2human"
+
+describe LogStash::Filters::Bytes2Human do
+   
+  describe "To Bytes" do
+    # The logstash config.
+    config <<-CONFIG
+      filter {  bytes2human { convert => { "size" => "bytes" } } }
+    CONFIG
+  
+    describe "should convert from kb" do
+      sample( "size" => "10kb" ) do
+        expect( subject["size"] ).to eq( 10000 )
+      end
+    end
+    
+    describe "should convert from mb" do
+      sample( "size" => "10MB" ) do
+        expect( subject["size"] ).to eq( 10000000 )
+      end
+    end
+    
+    describe "should convert from gb" do
+      sample( "size" => "10gb" ) do
+        expect( subject["size"] ).to eq( 10000000000 )
+      end
+    end
+
+
+    describe "should convert from tb" do
+      sample( "size" => "10.4tb" ) do
+        expect( subject["size"] ).to eq( 10400000000000 )
+      end
+    end
+
+
+    describe "should convert from mib" do
+      sample( "size" => "10.4mib" ) do
+        expect( subject["size"] ).to eq( 10905190 )
+      end
+    end
+
+    describe "should round to nearest byte - partial bytes don't exist" do
+      sample( "size" => "1.54321kb" ) do
+        expect( subject["size"] ).to eq( 1543 )
+      end
+    end
+    
+    describe "should deal undefined" do
+      sample( "size_not" => 123 ) do
+        expect( subject["size"] ).to be_nil
+      end
+    end
+  end
+  
+  describe "To Human" do
+    # The logstash config.
+    config <<-CONFIG
+      filter {  bytes2human { convert => { "size" => "human" } } }
+    CONFIG
+  
+    describe "should convert integer to KB" do
+      sample( "size" => 123456 ) do
+        expect( subject["size"] ).to eq( "123.46 kB" )
+      end
+    end
+    
+    describe "should convert string to MB" do
+      sample( "size" => "987654321" ) do
+        expect( subject["size"] ).to eq( "987.65 MB" )
+      end
+    end
+    
+    describe "should deal with a zero value" do
+      sample( "size" => 0 ) do
+        expect( subject["size"] ).to eq( "0.00 B" )
+      end
+    end
+    
+    describe "should deal undefined" do
+      sample( "size_not" => 123 ) do
+        expect( subject["size"] ).to be_nil
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-bytes2human
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elastics.co
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !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 gemname. This gem is not a stand-alone program
+email: info@elastics.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/filters/bytes2human.rb
+- lib/logstash/filters/bytes2human/filesize.rb
+- logstash-filter-bytes2human.gemspec
+- spec/filters/bytes2human_spec.rb
+homepage: http://www.elastics.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: Convert to and from human readable bytes.
+test_files:
+- spec/filters/bytes2human_spec.rb