logstash-filter-json_wrap 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b31483bb096f0c1ff00826dce036ce41c8b9ce2f3e9bd52c03b64da941d56764
+  data.tar.gz: 659a89ad59b2e3b62549392381cf201b809a9f0d788172b571bdc06880ce2d4f
+SHA512:
+  metadata.gz: 1f721e420bb11a24b29e37d5214610afd280cb91d9ed508c04e92a21b552476f4f6a2c9333ef7b1ccbd30ec701d74408fb8956ef12d4b1757b5eded598d538ca
+  data.tar.gz: 23cf06f97fc4d159b5041f72e25d4be00ceeeaafb6ecfb2d07cfac26a5b42ceb7eb6a61298e55131299192ff91a4c94a554b238764a1343d725876d8305b8e24

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+
+## 0.1.1
+ - Fix @metadata not being transferred to the new event object
+
+## 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:
+* Ferdinand Holzer - ferdinand.holzer@gmail.com, fholzer@gvcgroup.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/Gemfile

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

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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/lib/logstash/filters/json_wrap.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+class LogStash::Filters::JsonWrap < LogStash::Filters::Base
+  config_name "json_wrap"
+
+  # Fields not to wrap.
+  config :exclude, :validate => :array, :default => ["@timestamp", "@metadata", "@version"]
+
+  # Target field to write json to.
+  config :target, :validate => :string
+
+  # In case of error during evaluation, these tags will be set.
+  config :tags_on_failure, :validate => :array, :default => ["_json_wrap_failure"]
+
+  public
+  def register
+  end # def register
+
+  public
+  def filter(event)
+    begin
+      s = event.clone()
+      n = LogStash::Event.new({})
+
+      @exclude.each do |e|
+        # need to to get and remove in two steps because "@metadata" can't be
+        # removed, so the call s.remove("@metadata") returns nil
+        v = s.get(e)
+        s.remove(e)
+        n.set(e, v) if nil != v
+      end
+
+      n.set(@target, s.to_json())
+
+      filter_matched(n)
+    rescue Exception => e
+      @logger.warn("an error occurred", :exception => e)
+      @tags_on_failure.each { |t| event.tag(t) }
+      return
+    end
+    yield n
+
+    event.cancel
+
+  rescue Exception => e
+    @logger.warn("an error occurred", :exception => e)
+    @tags_on_failure.each { |t| n.tag(t) }
+    @tags_on_failure.each { |t| event.tag(t) }
+  end # def filter
+end # class LogStash::Filters::JsonWrap

data/logstash-filter-json_wrap.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-filter-json_wrap'
+  s.version       = '0.1.1'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Serialize Logstash events to JSON and store them in your event'
+  s.description   = 'See https://github.com/fholzer/logstash-filter-wrap_json/blob/master/README.md for details.'
+  s.homepage      = 'https://github.com/fholzer/logstash-filter-json_wrap'
+  s.authors       = ['Ferdinand Holzer']
+  s.email         = 'ferdinand.holzer@gmail.com'
+  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", "~> 2.0"
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'simplecov-console'
+end

data/spec/filters/json_wrap_spec.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+require "logstash/filters/json_wrap"
+
+describe LogStash::Filters::JsonWrap do
+  describe "Ensure correct behavior" do
+    let(:config) do <<-CONFIG
+      filter {
+        json_wrap {
+          exclude => ["@timestamp", "@metadata", "@version", "even"]
+          target => "dst"
+          add_field => { "success" => "success" }
+        }
+      }
+    CONFIG
+    end
+
+    hash1 = {
+      "app" => "someapp",
+      "testkey" => "testvalue"
+    }
+    hash2 = {
+      "app" => "someapp",
+      "testkey" => "testvalue",
+      "even" => "more"
+    }
+
+    sample(hash1) do
+      expect(subject).to include("success")
+      expect(subject).not_to include("tags")
+      expect(subject).not_to include("app")
+      expect(subject).to include("dst")
+      h = LogStash::Json.load(subject.get('dst'))
+      expect(h).to eq(hash1)
+    end
+
+    sample(hash2) do
+      expect(subject).to include("success")
+      expect(subject).not_to include("tags")
+      expect(subject).not_to include("app")
+      expect(subject).to include("dst")
+      h = LogStash::Json.load(subject.get('dst'))
+      expect(h).to eq(hash1)
+    end
+  end
+
+  describe "Correctly handle excluded nested fields" do
+    let(:config) do <<-CONFIG
+      filter {
+        json_wrap {
+          exclude => ["@timestamp", "@metadata", "@version", "[nested][field]"]
+          target => "dst"
+          add_field => { "success" => "success" }
+        }
+      }
+    CONFIG
+    end
+
+    hMeta = { "very" => "meta" }
+    hOrig = {
+      "nested" => {
+        "field" => "test"
+      },
+      "some" => "other",
+      "@metadata" => hMeta
+    }
+    hWrapped = {
+      "nested" => {},
+      "some" => "other"
+    }
+    sample(hOrig) do
+      expect(subject).to include("success")
+      expect(subject).not_to include("tags")
+      expect(subject).not_to include("some")
+      expect(subject).to include("dst")
+      expect(subject.get("[nested][field]")).to eq("test")
+      wrapped = subject.get('dst')
+      h = LogStash::Json.load(wrapped)
+      expect(h["nested"]["field"]).to eq(nil)
+      expect(h).to eq(hWrapped)
+      expect(subject.get("@metadata")).to  eq(hMeta)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require 'simplecov'
+require 'simplecov-console'
+SimpleCov.formatter = SimpleCov::Formatter::Console
+SimpleCov.start

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-json_wrap
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ferdinand Holzer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2019-03-18 00:00:00.000000000 Z
+dependencies:
+- !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: '0'
+  name: simplecov
+  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: simplecov-console
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: See https://github.com/fholzer/logstash-filter-wrap_json/blob/master/README.md
+  for details.
+email: ferdinand.holzer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- lib/logstash/filters/json_wrap.rb
+- logstash-filter-json_wrap.gemspec
+- spec/filters/json_wrap_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fholzer/logstash-filter-json_wrap
+licenses:
+- Apache-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: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.11
+signing_key:
+specification_version: 4
+summary: Serialize Logstash events to JSON and store them in your event
+test_files:
+- spec/filters/json_wrap_spec.rb
+- spec/spec_helper.rb