logstash-filter-codec 0.0.1.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10cea57aef9654ea15dd074463b3fdd781e6f2ecd30271f11c4d8aeeb4faa0fc
+  data.tar.gz: 823e5146763f7a7ff04ebc6eca4eeda6a2dd5a6384c58518b9a5205e9794d236
+SHA512:
+  metadata.gz: 2949593dfecb1125a22dae86afe4f1a791ace9aef38a534e01ae882506e6366a5440549d7786b92e1f26ff76008875cabef5b0955a0741c3a303a1f14bae826b
+  data.tar.gz: 7a9993cb9adf39b74e05968115d0e106b0bae5a0a940cc2790fd19261095587e5c411daac101b137e500ce0f050f790bda2401b1409f3485a3e2e202ddbdb79e

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.0.1
+  - Initial version of this plugin

data/CONTRIBUTORS

@@ -0,0 +1,12 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Aaron Mildenstein (untergeek)
+* Pier-Hugues Pellerin (ph)
+* João Duarte (jsvd)
+
+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/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

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,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.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-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/lib/logstash/filters/codec.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+# This plugin fulfills the simple role of executing a encode/decode operation
+# of a chosen codec over the received event.
+class LogStash::Filters::Codec < LogStash::Filters::Base
+
+  # Setting the codec and mode here is required.
+  #
+  # filter {
+  #   codec {
+  #     codec => dots
+  #     mode => encode
+  #   }
+  # }
+  #
+  config_name "codec"
+  
+  # Which codec to use. e.g. "dots", "json"
+  config :codec, :validate => :codec, :required => true
+
+  # Execute either an encode or decode operation.
+  # If `encode` is specified, the event is passed to the codec
+  # for encoding and the output is placed in the `target` field
+  # of the new event.
+  #
+  # If `decode` is used instead, the contents of the `source` field
+  # of the filtered event are passed to the decode function of the codec,
+  # and a new event is generated as a result. The original event is canceled.
+  config :mode, :validate => ["encode", "decode"], :required => true
+
+  # Only relevant if mode is decode.
+  # Name of the field in the event from where to extract data to be decoded.
+  config :source, :validate => :string, :default => "message"
+
+  # Only relevant if mode is encode.
+  # Name of the field in the new event that will contain the encoded event.
+  config :target, :validate => :string, :default => "message"
+
+  public
+  def register
+    @codec.on_event { |new_event, payload| payload }
+  end # def register
+
+  public
+  def filter(event)
+
+    if @mode == "encode" then
+      yield LogStash::Event.new(@target => @codec.encode(event))
+    else # decode
+      # TODO: allow merging of the original event and the decoded event
+      @codec.decode(event.get(@source)) do |event|
+        yield event
+      end
+    end
+
+    # either in encode or decode mode we generate a new event
+    # so the original one can be cancelled
+    event.cancel
+  end # def filter
+end # class LogStash::Filters::Example

data/logstash-filter-codec.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-codec'
+  s.version         = '0.0.1.alpha1'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "This filter has a simple purpose of using a codec for encoding or encoding 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 = ["Elastic"]
+  s.email = 'info@elastic.co'
+  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" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_development_dependency "rspec", "~> 3"
+  s.add_development_dependency "logstash-codec-json"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/filters/codec_spec.rb

@@ -0,0 +1,33 @@
+require "logstash/filters/codec"
+require "logstash/codecs/base"
+require "json"
+
+describe LogStash::Filters::Codec do
+
+  subject { LogStash::Filters::Codec.new(config) }
+
+  before :each do
+    subject.register
+  end
+
+  describe "encode" do
+    let(:original_event) { LogStash::Event.new("message" => "test") }
+    let(:config) { { "mode" => "encode", "codec" => "json" } }
+    it "should create a new event with encoded event in target field" do
+      subject.filter(original_event) do |event|
+        obj = JSON.load(event.get("message"))
+        expect(obj["message"]).to eq("test")
+      end
+    end
+  end
+
+  describe "decode" do
+    let(:original_event) { LogStash::Event.new("message" => '{"hey": 1}') }
+    let(:config) { { "mode" => "decode", "codec" => "json" } }
+    it "should create a new event with decoded data in target field" do
+      subject.filter(original_event) do |event|
+        expect(event.get("hey")).to eq(1)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-codec
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha1
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-json
+  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'
+  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@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/filters/codec.rb
+- logstash-filter-codec.gemspec
+- spec/filters/codec_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.elastic.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: 1.3.1
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.10
+signing_key:
+specification_version: 4
+summary: This filter has a simple purpose of using a codec for encoding or encoding
+  data
+test_files:
+- spec/filters/codec_spec.rb
+- spec/spec_helper.rb