logstash-codec-bytes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a49c6efaf3841a405282e8cfc2d1463f6b76dc46
+  data.tar.gz: a14a4b7f11d9d7b13e776967c3d12a48fbf02ed9
+SHA512:
+  metadata.gz: 8589102994eb0363cf0b0b378a99cc76175172379103bfafd1f2f14096f5c0c6477be7ed754e9b857a92be2242748043216eb8f93bbda13ba8c783e194fdf19f
+  data.tar.gz: 5ab982e7fc74b073265fc37957924e8589a2d1b2f845baf25ee658eb5238ce3cc171106dc927e1a2d0eb2375d382a7871d369ce382647dc7ec903aed31e216e2

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 1.0.0 (2016-7-6)
+
+##### New Features
+
+* **plugin:** add bytes plugin ([15857144](https://github.com/lob/logstash-codec-bytes/commit/1585714491eda98931852dcc5d30f3a1a39107f1))
+

data/Gemfile

@@ -0,0 +1,3 @@
+#ruby=jruby-9.0.5.0
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,78 @@
+# logstash-codec-bytes
+
+[![Build Status](https://travis-ci.org/lob/logstash-codec-bytes.svg?branch=master)](https://travis-ci.org/lob/logstash-codec-bytes)
+[![Gem Version](https://badge.fury.io/rb/logstash-codec-bytes.svg)](http://badge.fury.io/rb/logstash-codec-bytes)
+[![Coverage Status](https://coveralls.io/repos/github/lob/logstash-codec-bytes/badge.svg?branch=master)](https://coveralls.io/github/lob/logstash-codec-bytes?branch=master)
+
+Logstash codec plugin to chunk an input into an event every specified number of bytes.
+
+## About
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is MIT, meaning you are pretty much free to use it however you want in whatever way.
+
+### Installation
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+$ bundle install
+```
+
+- Run tests
+
+```sh
+$ bundle exec rspec
+```
+
+### Running the Plugin in Logstash (version 2.3.x)
+
+- Install the plugin
+
+```sh
+bin/logstash-plugin install logstash-codec-bytes
+```
+
+- Run Logstash with the plugin
+
+```sh
+bin/logstash -e 'input { file { path => "/path/to/file" delimiter => "" codec => bytes { length => X } } }'
+```
+where length X is the number of bytes you want to read before emitting an event.
+
+Note: we recommend sending smaller, more frequent events into the bytes codec for the best performance. With the file input plugin above, we set the delimiter to "" because otherwise it defaults to emitting an event every \n character. If a file were only one line, the entire file would be fed into the bytes codec, leading to reduced performance.
+
+## Contributing
+
+Make sure you have JRuby and Bundler installed. Copy and paste the following commands in your projects directory.
+
+    git clone https://github.com/lob/logstash-codec-bytes.git
+    cd logstash-codec-bytes
+    bundle install
+
+### Contributing Instructions
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Make sure the tests pass
+6. Open up coverage/index.html in your browser and add tests if required
+7. Create new Pull Request
+
+=======================
+
+Copyright © 2016 Lob.com
+
+Released under the MIT License, which can be found in the repository in `LICENSE`.

data/lib/logstash/codecs/bytes.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+require "logstash/codecs/base"
+require "logstash/namespace"
+
+class LogStash::Codecs::Bytes < LogStash::Codecs::Base
+
+  # This codec will chunk input into parts of a
+  # specified length
+  #
+  # input {
+  #   file {
+  #     delimiter => ""
+  #     codec => bytes {
+  #       length => X
+  #     }
+  #   }
+  # }
+
+  config_name "bytes"
+
+  config :length, :validate => :number, :required => true
+
+  public
+  def register
+    @payload = []
+  end
+
+  public
+  def decode(data)
+    @payload += data.bytes.to_a
+
+    while @payload.length >= @length
+      line = @payload.slice!(0...@length).pack('c*')
+
+      yield LogStash::Event.new({ "message" => line })
+    end
+
+  end
+
+end

data/logstash-codec-bytes.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name          = "logstash-codec-bytes"
+  s.version       = "1.0.0"
+  s.licenses      = ["MIT"]
+  s.authors       = ["Lob"]
+  s.email         = ["support@lob.com"]
+  s.description   = "Logstash codec plugin to chunk an input into an event every specified number of bytes."
+  s.summary       = "Logstash codec plugin to chunk an input into an event every specified number of bytes."
+  s.homepage      = "https://github.com/lob/logstash-codec-bytes"
+  s.require_paths = ["lib"]
+
+  s.files = Dir["lib/**/*","spec/**/*","vendor/**/*","*.gemspec","*.md","Gemfile"]
+
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "codec" }
+
+  s.add_runtime_dependency "logstash-core", ">= 2.0.0", "< 3.0.0"
+
+  s.add_development_dependency "logstash-devutils"
+  s.add_development_dependency "coveralls", "~> 0.8.1"
+  s.add_development_dependency "simplecov"
+end

data/spec/codecs/bytes_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+require "logstash/codecs/bytes"
+
+describe LogStash::Codecs::Bytes do
+
+  subject do
+    LogStash::Codecs::Bytes.new({ "length" => 4 })
+  end
+
+  it "chunks the data into parts of given length" do
+    data = "TestTest"
+
+    subject.decode(data) do |event|
+      expect(event["message"].length).to eq(subject.length)
+    end
+
+  end
+
+  it "creates an event for each complete chunk" do
+    data = "TestTes"
+    expected_count = data.bytes.length / subject.length
+    count = 0
+
+    subject.decode(data) { count += 1 }
+
+    expect(count).to eq(expected_count)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.minimum_coverage 100
+SimpleCov.start
+
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: logstash-codec-bytes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lob
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.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'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  name: coveralls
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: simplecov
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Logstash codec plugin to chunk an input into an event every specified number of bytes.
+email:
+- support@lob.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- README.md
+- lib/logstash/codecs/bytes.rb
+- logstash-codec-bytes.gemspec
+- spec/codecs/bytes_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lob/logstash-codec-bytes
+licenses:
+- MIT
+metadata:
+  logstash_plugin: 'true'
+  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.8
+signing_key:
+specification_version: 4
+summary: Logstash codec plugin to chunk an input into an event every specified number of bytes.
+test_files:
+- spec/codecs/bytes_spec.rb
+- spec/spec_helper.rb