logstash-codec-avro-data-file 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fedde9770f0cee9dc35a13fb9a9b4a4a7714cbd1
+  data.tar.gz: 2086eb43ef61413f865db0fa1ad9ad945969443e
+SHA512:
+  metadata.gz: d6af841762dace1ad1c4cc7f0108bdc30a64f8ae5abd63d1fef7c06ffb31eaeb3ed01b46ef95a138d6a83bfc9b6511cc151241e2aaa4552ff4c68dbe8046d8b1
+  data.tar.gz: 6b40bd57abef79f2ea29294a577e424809bacf2c2c52dca762339aa698bebd9548780a3967e6b42dd6fbf98cbfc94a43ae374dc65dcd8773e517a6fb96ad22f6

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Kyle Phelps - kphelps@salsify.com
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-codec-avro-data-file
+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,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Salsify, Inc
+
+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.

data/README.md

@@ -0,0 +1,85 @@
+# Logstash Avro Data File Codec
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash). It is intended to make it easy to parse Avro data files.
+
+
+## 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. 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-codec-avro-data-file", :path => "/your/local/logstash-codec-avro-data-file"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'codec {avro-data-file {}}'
+```
+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-codec-avro-data-file.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-codec-avro-data-file.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/lib/logstash/codecs/avro-data-file.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+
+require 'avro'
+require 'logstash/codecs/base'
+require 'logstash/namespace'
+require 'tmpdir'
+
+# This  codec will append a string to the message field
+# of an event, either in the decoding or encoding methods
+#
+# This is only intended to be used as an example.
+#
+# input {
+#   stdin { codec => 'avro-data-file' }
+# }
+#
+# or
+#
+# output {
+#   stdout { codec => 'avro-data-file' }
+# }
+#
+class LogStash::Codecs::AvroDataFile < LogStash::Codecs::Base
+
+  config_name 'avro-data-file'
+
+  # Set the directory where logstash will store the tmp files before processing them.
+  # default to the current OS temporary directory in linux /tmp/logstash/avro
+  config :temporary_directory, validate: :string, default: File.join(Dir.tmpdir, 'logstash', 'avro')
+
+  def register
+    require 'fileutils'
+    FileUtils.mkdir_p(temporary_directory) unless Dir.exist?(temporary_directory)
+    reset
+  end
+
+  def decode(data)
+    merge(data)
+  end
+
+  def flush
+    tempfile.flush
+    return unless block_given?
+
+    Avro::DataFile.open(tempfile.path, 'r') do |reader|
+      reader.each do |avro_message|
+        yield LogStash::Event.new(avro_message)
+      end
+    end
+  rescue => e
+    @logger.error('Avro parse error', error: e)
+  ensure
+    reset
+  end
+
+  def encode(_event)
+    raise 'Not implemented'
+  end
+
+  private
+
+  attr_accessor :tempfile
+  attr_reader :temporary_directory
+
+  def merge(bytes)
+    tempfile.write(bytes)
+  end
+
+  def reset
+    unless tempfile.nil?
+      begin
+        File.unlink(tempfile.path)
+        tempfile.close
+      rescue Errno::ENOENT # rubocop:disable Lint/HandleExceptions
+      end
+    end
+    self.tempfile = Tempfile.create('', temporary_directory)
+  end
+end

data/logstash-codec-avro-data-file.gemspec

@@ -0,0 +1,35 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-codec-avro-data-file'
+  s.version       = '0.1.0'
+  s.licenses      = ['MIT']
+  s.summary       = 'Codec for parsing avro data files'
+  s.homepage      = 'https://github.com/salsify/logstash-codec-avro-data-file'
+  s.authors       = ['Kyle Phelps']
+  s.email         = 'kphelps@salsify.com'
+  s.require_paths = ['lib']
+
+  s.files = Dir[
+    'lib/**/*',
+    'spec/**/*',
+    'vendor/**/*',
+    '*.gemspec',
+    '*.md',
+    'CONTRIBUTORS',
+    'Gemfile',
+    'LICENSE',
+    'NOTICE.TXT'
+  ]
+  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' }
+
+  s.add_runtime_dependency 'avro'
+  s.add_runtime_dependency 'logstash-codec-line'
+  s.add_runtime_dependency 'logstash-core-plugin-api', '~> 2.0'
+  s.add_development_dependency 'logstash-devutils'
+
+  s.add_development_dependency 'bundler', '~> 1.16'
+  s.add_development_dependency 'overcommit'
+  s.add_development_dependency 'salsify_rubocop', '~> 0.48.0'
+end

data/spec/log_stash/codecs/avro_data_file_spec.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+
+require 'logstash/codecs/avro-data-file'
+require 'json'
+
+describe LogStash::Codecs::AvroDataFile do
+  let(:config) { {} }
+  let(:codec) { described_class.new(config).tap(&:register) }
+  let(:lines) { [] }
+  let(:events) { [] }
+  let(:expected_events) { [] }
+
+  before do
+    lines.each(&codec.method(:decode))
+  end
+
+  shared_examples "produces the correct output" do
+    specify do
+      expect(events.length).to eq expected_events.length
+      expect(events).to all(be_an_instance_of(LogStash::Event))
+      event_hashes = events.map(&:to_hash).map do |event|
+        event.except('@timestamp', '@version')
+      end
+      expected_hashes = expected_events.map(&:to_hash).map do |event|
+        event.except('@timestamp', '@version')
+      end
+
+      expect(event_hashes).to eq expected_hashes
+    end
+  end
+
+  describe "#decode" do
+
+    context "without flushing" do
+      let(:lines) { ['test', 'test2'] }
+
+      include_examples "produces the correct output"
+    end
+
+    context "with a flush" do
+
+      before do
+        codec.flush do |event|
+          events << event
+        end
+      end
+
+      context "invalid data" do
+        let(:lines) { ['test', 'test2'] }
+
+        include_examples "produces the correct output"
+      end
+
+      context "valid data" do
+        let(:schema) do
+          {
+            'type' => 'record',
+            'name' => 'mock_schema',
+            'namespace' => 'com.salsify.test',
+            'fields' => [
+              {
+                'name' => 'id',
+                'type' => 'long'
+              }
+            ]
+          }.to_json
+        end
+        let(:avro_ids) { (0...100).to_a }
+        let(:avro_messages) do
+          avro_ids.map do |id|
+            { 'id' => id }
+          end
+        end
+        let(:tempfile) do
+          Tempfile.new('restore-test')
+        end
+        let(:lines) do
+          Avro::DataFile.open(tempfile.path, 'w', schema) do |writer|
+            avro_messages.each do |message|
+              writer << message
+            end
+          end
+          File.open(tempfile.path, 'rb', &:to_a)
+        end
+        let(:expected_events) { avro_messages.map(&LogStash::Event.method(:new)) }
+
+        include_examples "produces the correct output"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require 'logstash/devutils/rspec/spec_helper'

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: logstash-codec-avro-data-file
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kyle Phelps
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: avro
+  prerelease: false
+  type: :runtime
+  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'
+  name: logstash-codec-line
+  prerelease: false
+  type: :runtime
+  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: '2.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: '1.16'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: overcommit
+  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.48.0
+  name: salsify_rubocop
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.0
+description:
+email: kphelps@salsify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/codecs/avro-data-file.rb
+- logstash-codec-avro-data-file.gemspec
+- spec/log_stash/codecs/avro_data_file_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/salsify/logstash-codec-avro-data-file
+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.6.8
+signing_key:
+specification_version: 4
+summary: Codec for parsing avro data files
+test_files:
+- spec/log_stash/codecs/avro_data_file_spec.rb
+- spec/spec_helper.rb