logstash-codec-frame 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2350bf465065c80e70bac20a476ed4c55c20ce0
+  data.tar.gz: 8f1f8ba3930610d9ac052a789b0d2386419c2195
+SHA512:
+  metadata.gz: aca70558262971363309f04c3f01f59d485593b4c2e49742c01f8f1dfe08148082cd102d3c3431f42361ca21966359ec174d8c7242e12df2e33c96a07629d79f
+  data.tar.gz: df112c9a0baa7a563b384005c7e00298380c075eaef584bbda0530308ce1eb315d1dc592f97908bc5f2f3340847e69150efe01c8a4b5fbe31da57619cf20fdb9

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-codec-example
+Example codec plugin. This should help bootstrap your effort to write your own codec plugin!

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.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/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,98 @@
+# Logstash Plugin
+
+[![Build
+Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Codecs/job/logstash-plugin-codec-example-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Codecs/job/logstash-plugin-codec-example-unit/)
+
+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.co/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 https://discuss.elastic.co/c/logstash discussion forum.
+
+## 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.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- 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
+
+- 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 me 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/lib/logstash/codecs/frame.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+require "logstash/codecs/base"
+require "logstash/util/charset"
+
+# Frame-oriented text data.
+#
+# Decoding behavior: Only whole frame events will be emitted.
+#
+# Encoding behavior: Each event will be emitted with a prefixed <length><delimiter>.
+class LogStash::Codecs::Frame < LogStash::Codecs::Base
+  config_name "frame"
+
+  # Set the desired text format for encoding.
+  config :format, :validate => :string
+
+  # This only affects "plain" format logs since json is `UTF-8` already.
+  config :charset, :validate => ::Encoding.name_list, :default => "UTF-8"
+
+  # Change the delimiter that separates frame length from the data
+  config :delimiter, :validate => :string, :default => " "
+
+  public
+  def register
+    @buffer = ""
+    @offset
+    @frame_length
+    @converter = LogStash::Util::Charset.new(@charset)
+    @converter.logger = @logger
+  end
+
+  public
+  def decode(data)
+    @buffer += data
+    while (nextMessage)
+      yield LogStash::Event.new("message" => @converter.convert(@buffer[@offset, @frameLength]))
+      @buffer.slice!(0, @offset + @frameLength)
+      @offset = nil
+    end
+  end # def decode
+
+  public
+  def encode(event)
+    if event.is_a? LogStash::Event and @format
+      @on_event.call(event, encodeFrameLength(event.sprintf(@format)))
+    else
+      @on_event.call(event, encodeFrameLength(event.to_s))
+    end
+  end # def encode
+
+  private
+  def nextMessage()
+    if (@offset.nil?)
+      @offset = @buffer.index(@delimiter);
+      if (@offset.nil?)
+        return false
+      end
+      @frameLength = @buffer[0, @offset].to_i
+      @offset +=  @delimiter.length
+    end
+    return @buffer.length >= @offset + @frameLength
+  end # def nextMessage
+
+  private
+  def encodeFrameLength(message)
+    return message.length.to_s + @delimiter + message
+  end # def encodeFrameLength
+
+end # class LogStash::Codecs::Frame

data/logstash-codec-frame.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-codec-frame'
+  s.version         = '2.0.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Frame-oriented text data."
+  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         = ["Gunter Zeilinger"]
+  s.email           = 'gunterze@gmail.com'
+  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+
+  # 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" => "codec" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", ">= 2.0.0.beta2", "< 3.0.0"
+
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/codecs/frame_spec.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/codecs/frame"
+require "logstash/event"
+
+describe LogStash::Codecs::Frame do
+  subject do
+    next LogStash::Codecs::Frame.new
+  end
+
+  context "#encode" do
+    let (:event) {LogStash::Event.new({"message" => "hello world", "host" => "test"})}
+
+    it "should prefix message with length" do
+      subject.format = "%{message}"
+      expect(subject).to receive(:on_event).once.and_call_original
+      subject.on_event do |e, d|
+        insist {d} == "11 hello world"
+      end
+      subject.encode(event)
+    end
+
+  end
+
+  context "#decode" do
+    it "should return an event from an ascii string" do
+      decoded = false
+      subject.decode("11 hello world") do |e|
+        decoded = true
+        insist { e.is_a?(LogStash::Event) }
+        insist { e["message"] } == "hello world"
+      end
+      insist { decoded } == true
+    end
+
+    it "should return an event from a valid utf-8 string" do
+      subject.decode("7 München") do |e|
+        insist { e.is_a?(LogStash::Event) }
+        insist { e["message"] } == "München"
+      end
+    end
+
+    it "should return 1 event from 2 strings" do
+      messages = []
+      subject.decode("11 hello") do |e|
+        messages << e["message"]
+      end
+      subject.decode(" world") do |e|
+        messages << e["message"]
+      end
+      insist { messages } == ["hello world" ]
+    end
+
+    it "should return 2 events from 3 strings" do
+      messages = []
+      subject.decode("11 hello") do |e|
+        messages << e["message"]
+      end
+      subject.decode(" world7") do |e|
+        messages << e["message"]
+      end
+      subject.decode(" München") do |e|
+        messages << e["message"]
+      end
+      insist { messages } == ["hello world", "München"]
+    end
+
+    it "should return 2 events from one string" do
+      messages = []
+      subject.decode("11 hello world7 München") do |e|
+        messages << e["message"]
+      end
+      insist { messages } == ["hello world", "München"]
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: logstash-codec-frame
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Gunter Zeilinger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  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: gunterze@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/codecs/frame.rb
+- logstash-codec-frame.gemspec
+- spec/codecs/frame_spec.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+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: Frame-oriented text data.
+test_files:
+- spec/codecs/frame_spec.rb