logstash-codec-json_gz 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3dc0dc85897ec53fab0ea15f90344eb811f5be93c466c0547d666b406e77dc0f
+  data.tar.gz: e155156855578909c78f5afb322517389be6c00009f48de4c3fade559fa2d086
+SHA512:
+  metadata.gz: d8dd4fb16c50aa2dbac52e1518234186298a08572af17b2460961ca3d8883beece5f06d66398b1ff21ca3a960649c63b0e56da6fd29f2392895eaeb3c798d276
+  data.tar.gz: add1cd7a6c8cdf85ec146d8b8272ff5c15010444f581b1ce40919781e11bc956610136dfcc51acf2e68fd59a0ddc479514a49870859500719fd7a09e9e6199f3

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.0
+  - Initial version with support for decoding gzip json, json arrays and json lines.

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:
+* Dimo Terziev - dimo.terziev@gmail.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,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,11 @@
+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/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-codec-awesome", :path => "/your/local/logstash-codec-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'codec {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-codec-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-codec-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/codecs/json_gz.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+require "logstash/codecs/base"
+require "logstash/util/charset"
+require "logstash/json"
+require "logstash/event"
+require "zlib"
+require 'stringio'
+
+# This codec will read gzip encoded json content. 
+#
+# Example usage:
+#
+# input {
+#  tcp { 
+#    port=>5004
+#    codec => json_gz { json_type => "auto" }
+#  }
+# }
+#
+class LogStash::Codecs::JsonGz < LogStash::Codecs::Base
+  config_name "json_gz"
+
+  # The character encoding used in this codec. Examples include "UTF-8" and
+  # "CP1252"
+  #
+  # JSON requires valid UTF-8 strings, but in some cases, software that
+  # emits JSON does so in another encoding (nxlog, for example). In
+  # weird cases like this, you can set the charset setting to the
+  # actual encoding of the text and logstash will convert it for you.
+  #
+  # For nxlog users, you'll want to set this to "CP1252"
+  config :charset, :validate => ::Encoding.name_list, :default => "UTF-8"
+
+  # The expected format of each event. The following are supported
+  # "json" - for json documents or json arrays (default).
+  # "json_lines" - json lines delimited by '\n'.
+  # "auto" - attempts to auto-detect if the json represents an array or lines.
+  config :json_type, :validate => ["json","json_lines", "auto"], :default => "json"
+
+  public
+
+  def register
+    @converter = LogStash::Util::Charset.new(@charset)
+    @converter.logger = @logger
+  end
+
+  def decode(data, &block)
+    data = decompress(StringIO.new(data), &block) 
+    data = @converter.convert(data)
+
+    if @json_type == "json" || (@json_type == "auto" && data[0] == '[')
+      from_json_parse(data, &block)
+    else 
+      data.each_line { |l| from_json_parse(l, &block) } 
+    end
+    
+  rescue => e
+    @logger.error("err: #{e}")
+    yield LogStash::Event.new("message" => data, "tags" => ["_jsongzparsefailure"])
+  end
+
+  def encode(data)
+    raise RuntimeError.new("This codec is only used to decode gzip encoded json.")
+  end
+
+  private
+
+  def from_json_parse(json, &block)
+    LogStash::Event.from_json(json).each { |event| yield event }
+  rescue LogStash::Json::ParserError => e
+    @logger.error("JSON parse error, original data now in message field", :error => e, :data => json)
+    yield LogStash::Event.new("message" => json, "tags" => ["_jsonparsefailure"])
+  end 
+
+  def decompress(data)
+    gz = Zlib::GzipReader.new(data)
+    gz.read
+  rescue Zlib::Error, Zlib::GzipFile::Error => e
+    @logger.error("Error decompressing gzip data: #{e}")
+  end
+
+end # class LogStash::Codecs::JsonGz

data/logstash-codec-json_gz.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-codec-json_gz'
+  s.version       = '1.0.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = "Reads gzip encoded JSON formatted content, creating one event per element in a JSON array or JSON line."
+  s.description   = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
+  s.homepage      = 'https://github.com/dterziev/logstash-codec-json_gz'
+  s.authors       = ['Dimo Terziev']
+  s.email         = 'dimo.terziev@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" => "codec" }
+
+  # Gem dependencies
+  s.add_runtime_dependency 'logstash-core-plugin-api',  ">= 1.60", "<= 2.99"
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/codecs/json_gz_spec.rb

@@ -0,0 +1,115 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/codecs/json_gz"
+require "logstash/codecs/base"
+require "logstash/util/charset"
+require "logstash/json"
+require "logstash/event"
+require "zlib"
+require 'stringio'
+require "logstash/errors"
+require "insist"
+
+
+
+def compress_with_gzip(io)
+  compressed = StringIO.new
+  gzip = Zlib::GzipWriter.new(compressed)
+  gzip.write(io.read)
+  gzip.finish
+  compressed.rewind
+  compressed
+end
+
+def uncompressed_log_array(n) 
+  str = StringIO.new
+  str << "["
+  (1..n).each do |i| 
+      str << "," if i > 1
+      d = {"@timestamp" => DateTime.now.new_offset(0).strftime("%Y-%m-%dT%H:%M:%SZ"), "message" => "message #{i}"}
+      str << LogStash::Json.dump(d) 
+  end
+  str << "]"
+  str.rewind
+  str
+end
+
+def uncompressed_log_lines(n) 
+  str = StringIO.new
+  (1..n).each do |i| 
+      d = {"@timestamp" => DateTime.now.new_offset(0).strftime("%Y-%m-%dT%H:%M:%SZ"), "message" => "message #{i}"}
+      str << LogStash::Json.dump(d) 
+      str << "\n"
+  end
+  str.rewind
+  str
+end
+
+def verify_decoded_events(data, event_count)
+  events = []
+  i = 0
+  subject.decode(data) do |event|
+    i += 1
+    insist { event.is_a? LogStash::Event }
+    insist { event.get("message") } == "message #{i}" 
+    events << event
+  end
+        
+  expect(events.size).to eq(event_count)
+end
+
+describe LogStash::Codecs::JsonGz do
+
+  context "#decode" do
+
+    event_count = 10000
+    json_array_data = compress_with_gzip(uncompressed_log_array(event_count)).string
+    json_lines_data = compress_with_gzip(uncompressed_log_array(event_count)).string
+    json_object_data = compress_with_gzip(uncompressed_log_lines(1)).string
+
+    context "when json_type = json" do
+      
+      subject{LogStash::Codecs::JsonGz.new("json_type" => "json")}
+
+      it "should create events from gz json array" do
+        verify_decoded_events(json_array_data, event_count)
+      end
+    
+      it "should create events from gz json object" do
+        verify_decoded_events(json_object_data, 1)
+      end
+    end
+
+    context "when json_type = json_lines" do
+      
+      subject{LogStash::Codecs::JsonGz.new("json_type" => "json_lines")}
+
+      it "should create events from gz json lines" do
+        verify_decoded_events(json_lines_data, event_count)
+      end
+    
+      it "should create events from gz json object" do
+        verify_decoded_events(json_object_data, 1)
+      end
+
+    end
+
+    context "when json_type = auto" do
+      
+      subject{LogStash::Codecs::JsonGz.new("json_type" => "auto")}
+      
+      it "should create events from gz json array" do
+        verify_decoded_events(json_array_data, event_count)
+      end
+
+      it "should create events from gz json lines" do
+        verify_decoded_events(json_lines_data, event_count)
+      end
+    
+      it "should create events from gz json object" do
+        verify_decoded_events(json_object_data, 1)
+      end
+      
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: logstash-codec-json_gz
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dimo Terziev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-05-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: '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/logstash-plugin install gemname. This
+  gem is not a stand-alone program
+email: dimo.terziev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/codecs/json_gz.rb
+- logstash-codec-json_gz.gemspec
+- spec/codecs/json_gz_spec.rb
+homepage: https://github.com/dterziev/logstash-codec-json_gz
+licenses:
+- Apache-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.6.13
+signing_key:
+specification_version: 4
+summary: Reads gzip encoded JSON formatted content, creating one event per element
+  in a JSON array or JSON line.
+test_files:
+- spec/codecs/json_gz_spec.rb