logstash-codec-bytes

logstash-codec-bytes

Logstash codec plugin to chunk an input into an event every specified number of bytes.

About

This is a plugin for 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

bundle install

Test

• Update your dependencies

$ bundle install

• Run tests

$ bundle exec rspec

Running the Plugin in Logstash (version 2.3.x)

• Install the plugin

bin/logstash-plugin install logstash-codec-bytes

• Run Logstash with the plugin

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

• Fork it
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Add some feature')
• Push to the branch (git push origin my-new-feature)
• Make sure the tests pass
• Open up coverage/index.html in your browser and add tests if required
• Create new Pull Request

=======================

Copyright © 2016 Lob.com

Released under the MIT License, which can be found in the repository in LICENSE.