logstash-codec-collectd_json 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cee57e57cbf93ea7d22f91958996b349a4ee07ff
+  data.tar.gz: 1ad6b98c9bb2549c0d42184cf69b64e46fab647a
+SHA512:
+  metadata.gz: b77bc42a06fc6af434a2b1cc2f7a773b665e723c44a5d7fa8b479bdddaa5343660d10a3527a0dda86ad412b00da86e9fcf637b66d2b7f9541c719c455bc2115d
+  data.tar.gz: cbd1663a3dfc9d298d066c7ca34f9a96c2c0a25d595a4f32db97aa96fabf7faba976750ad9ce36f2aed48ffa81663fd7cc5c00aa3054287a89f18c51ec3c744b

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+* 1.1.0
+  - Handle scalar types (string/number) and be more defensive about crashable errors
+* 1.0.1
+  - Handle JSON arrays at source root by emitting multiple events

data/CONTRIBUTORS

@@ -0,0 +1,17 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Colin Surprenant (colinsurprenant)
+* Jordan Sissel (jordansissel)
+* João Duarte (jsvd)
+* Kurt Hurtado (kurtado)
+* Nick Ethier (nickethier)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+* Tal Levy (talevy)
+
+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,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,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/codecs/json.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+require "logstash/codecs/base"
+require "logstash/util/charset"
+require "logstash/json"
+
+# This codec may be used to decode (via inputs) and encode (via outputs)
+# full JSON messages. If the data being sent is a JSON array at its root multiple events will be created (one per element).
+#
+# If you are streaming JSON messages delimited
+# by '\n' then see the `json_lines` codec.
+#
+# Encoding will result in a compact JSON representation (no line terminators or indentation)
+#
+# If this codec recieves a payload from an input that is not valid JSON, then
+# it will fall back to plain text and add a tag `_jsonparsefailure`. Upon a JSON
+# failure, the payload will be stored in the `message` field.
+class LogStash::Codecs::COLLECTD_JSON < LogStash::Codecs::Base
+  config_name "collectd_json"
+
+
+  # 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 may to set this to "CP1252".
+  config :charset, :validate => ::Encoding.name_list, :default => "UTF-8"
+
+  public
+  def register
+    @converter = LogStash::Util::Charset.new(@charset)
+    @converter.logger = @logger
+  end
+
+  public
+  def decode(data)
+    data = @converter.convert(data)
+    # FIX collectd -> AMQP -> LogStash bug with json format!
+    data.first! if data.is_a?(Array)
+    begin
+      decoded = LogStash::Json.load(data)
+      if decoded.is_a?(Array)
+        decoded.each {|item| yield(LogStash::Event.new(item)) }
+      elsif decoded.is_a?(Hash)
+        yield LogStash::Event.new(decoded)
+      else
+        @logger.info? && @logger.info("JSON codec received a scalar instead of an Arary or Object!", :data => data)
+        yield LogStash::Event.new("message" => data, "tags" => ["_jsonparsefailure"])
+      end
+
+    rescue LogStash::Json::ParserError => e
+      @logger.info("JSON parse failure. Falling back to plain-text", :error => e, :data => data)
+      yield LogStash::Event.new("message" => data, "tags" => ["_jsonparsefailure"])
+    rescue StandardError => e
+      # This should NEVER happen. But hubris has been the cause of many pipeline breaking things
+      # If something bad should happen we just don't want to crash logstash here.
+      @logger.warn("An unexpected error occurred parsing input to JSON",
+                   :input => data,
+                   :message => e.message,
+                   :class => e.class.name,
+                   :backtrace => e.backtrace)
+    end
+  end # def decode
+
+  public
+  def encode(event)
+    @on_event.call(event, event.to_json)
+  end # def encode
+
+end # class LogStash::Codecs::COLLECTD_JSON

data/logstash-codec-collectd_json.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-codec-collectd_json'
+  s.version         = '2.0.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "This codec may be used to decode (via inputs) and encode (via outputs) full JSON messages"
+  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" => "codec" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", "~> 2.0.0.snapshot"
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/codecs/json_spec.rb

@@ -0,0 +1,166 @@
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/codecs/json"
+require "logstash/event"
+require "logstash/json"
+require "insist"
+
+describe LogStash::Codecs::COLLECTD_JSON do
+  subject do
+    next LogStash::Codecs::COLLECTD_JSON.new
+  end
+
+  context "#decode" do
+    it "should return an event from json data" do
+      data = {"foo" => "bar", "baz" => {"bah" => ["a","b","c"]}}
+      subject.decode(LogStash::Json.dump(data)) do |event|
+        insist { event.is_a? LogStash::Event }
+        insist { event["foo"] } == data["foo"]
+        insist { event["baz"] } == data["baz"]
+        insist { event["bah"] } == data["bah"]
+      end
+    end
+
+    it "should be fast", :performance => true do
+      json = '{"message":"Hello world!","@timestamp":"2013-12-21T07:01:25.616Z","@version":"1","host":"Macintosh.local","sequence":1572456}'
+      iterations = 500000
+      count = 0
+
+      # Warmup
+      10000.times { subject.decode(json) { } }
+
+      start = Time.now
+      iterations.times do
+        subject.decode(json) do |event|
+          count += 1
+        end
+      end
+      duration = Time.now - start
+      insist { count } == iterations
+      puts "codecs/json rate: #{"%02.0f/sec" % (iterations / duration)}, elapsed: #{duration}s"
+    end
+
+    context "processing plain text" do
+      it "falls back to plain text" do
+        decoded = false
+        subject.decode("something that isn't json") do |event|
+          decoded = true
+          insist { event.is_a?(LogStash::Event) }
+          insist { event["message"] } == "something that isn't json"
+          insist { event["tags"] }.include?("_jsonparsefailure")
+        end
+        insist { decoded } == true
+      end
+    end
+
+    describe "scalar values" do
+      shared_examples "given a value" do |value_arg|
+        context "where value is #{value_arg}" do
+          let(:value) { value_arg }
+          let(:event) { LogStash::Event.new(value) }
+          let(:value_json) { LogStash::Json.dump(value)}
+          let(:event) do
+            e = nil
+            subject.decode(value_json) do |decoded|
+              e = decoded
+            end
+            e
+          end
+
+          it "should store the value in 'message'" do
+            expect(event["message"]).to eql(value_json)
+          end
+
+          it "should have the json parse failure tag" do
+            expect(event["tags"]).to include("_jsonparsefailure")
+          end
+        end
+      end
+
+      include_examples "given a value", 123
+      include_examples "given a value", "hello"
+      include_examples "given a value", "-1"
+      include_examples "given a value", " "
+    end
+
+    context "processing JSON with an array root" do
+      let(:data) {
+        [
+          {"foo" => "bar"},
+          {"foo" => "baz"}
+        ]
+      }
+      let(:data_json) {
+        LogStash::Json.dump(data)
+      }
+
+      it "should yield multiple events" do
+        count = 0
+        subject.decode(data_json) do |event|
+          count += 1
+        end
+        expect(count).to eql(data.count)
+      end
+
+      it "should yield the correct objects" do
+        index = 0
+        subject.decode(data_json) do |event|
+          expect(event.to_hash).to include(data[index])
+          index += 1
+        end
+      end
+    end
+
+    context "processing weird binary blobs" do
+      it "falls back to plain text and doesn't crash (LOGSTASH-1595)" do
+        decoded = false
+        blob = (128..255).to_a.pack("C*").force_encoding("ASCII-8BIT")
+        subject.decode(blob) do |event|
+          decoded = true
+          insist { event.is_a?(LogStash::Event) }
+          insist { event["message"].encoding.to_s } == "UTF-8"
+        end
+        insist { decoded } == true
+      end
+    end
+
+    context "when json could not be parsed" do
+
+      let(:message)    { "random_message" }
+
+      it "add the failure tag" do
+        subject.decode(message) do |event|
+          expect(event).to include "tags"
+        end
+      end
+
+      it "uses an array to store the tags" do
+        subject.decode(message) do |event|
+          expect(event['tags']).to be_a Array
+        end
+      end
+
+      it "add a json parser failure tag" do
+        subject.decode(message) do |event|
+          expect(event['tags']).to include "_jsonparsefailure"
+        end
+      end
+    end
+  end
+
+  context "#encode" do
+    it "should return json data" do
+      data = {"foo" => "bar", "baz" => {"bah" => ["a","b","c"]}}
+      event = LogStash::Event.new(data)
+      got_event = false
+      subject.on_event do |e, d|
+        insist { d.chomp } == LogStash::Event.new(data).to_json
+        insist { LogStash::Json.load(d)["foo"] } == data["foo"]
+        insist { LogStash::Json.load(d)["baz"] } == data["baz"]
+        insist { LogStash::Json.load(d)["bah"] } == data["bah"]
+        got_event = true
+      end
+      subject.encode(event)
+      insist { got_event }
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: logstash-codec-collectd_json
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-10-06 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.snapshot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.snapshot
+  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: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/codecs/json.rb
+- logstash-codec-collectd_json.gemspec
+- spec/codecs/json_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.5
+signing_key:
+specification_version: 4
+summary: This codec may be used to decode (via inputs) and encode (via outputs) full JSON messages
+test_files:
+- spec/codecs/json_spec.rb