logstash-codec-json_lines 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abd1fc258c3567ceafb0898c0b0e1301fcec2439
-  data.tar.gz: 9b77b2c8554530c4b61c17905215b054e285729e
+  metadata.gz: 8f521208069a7cd36106fb98b084d514e09ee87f
+  data.tar.gz: 4be461209d267a74a8ba35904f6f819493c8c466
 SHA512:
-  metadata.gz: fc85eae8437b9570b5cd93c1d63a3e463e6ed3a0cbc2fcc6831469c9fdd1368b45c5c869ba9cb11b9b6347f789814f2d8fb78312a8629d18fcdc589e01e15f23
-  data.tar.gz: b89d9804be6b624bd0b8a776919d4a9cc5e506491096d3a95b51ff3cd93d0a6c316ee35e7bed42d9ea18e470bf7bb2eb1fc67de39adef18ebc7ec49354253edd
+  metadata.gz: 97921e4feed4e57da139aa12b6a29d00f0430ecf19bf6b4c94fd46ca03db3c1c5430b63a26b22de5b83c47eca4d81749232bad2675e6e4a84d026385f612f41f
+  data.tar.gz: bd9480c4584eb40ea9b1218821cf53ac6de56e61f50c47a158476353300239d89280292f4cac31f21c3e4e0ade204c363d15e8e3ecaca3fa2915493c326d9512

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.0.4
+ - Support for customizable delimiter
+
 ## 2.0.3
  - Fixed Timestamp check in specs
 

data/lib/logstash/codecs/json_lines.rb

@@ -4,7 +4,7 @@ require "logstash/codecs/line"
 require "logstash/json"
 
 # This codec will decode streamed JSON that is newline delimited.
-# Encoding will emit a single JSON string ending in a `\n`
+# Encoding will emit a single JSON string ending in a `@delimiter`
 # NOTE: Do not use this codec if your source input is line-oriented JSON, for
 # example, redis or file inputs. Rather, use the json codec.
 # More info: This codec is expecting to receive a stream (string) of newline
@@ -25,11 +25,14 @@ class LogStash::Codecs::JSONLines < LogStash::Codecs::Base
   # For nxlog users, you'll want to set this to `CP1252`
   config :charset, :validate => ::Encoding.name_list, :default => "UTF-8"
 
+  # Change the delimiter that separates lines
+  config :delimiter, :validate => :string, :default => "\n"
+
   public
 
   def initialize(params={})
     super(params)
-    @lines = LogStash::Codecs::Line.new
+    @lines = LogStash::Codecs::Line.new("delimiter" => @delimiter)
     @lines.charset = @charset
   end
 
@@ -40,9 +43,9 @@ class LogStash::Codecs::JSONLines < LogStash::Codecs::Base
   end # def decode
 
   def encode(event)
-    # Tack on a \n for now because previously most of logstash's JSON
+    # Tack on a @delimiter for now because previously most of logstash's JSON
     # outputs emitted one per line, and whitespace is OK in json.
-    @on_event.call(event, "#{event.to_json}#{NL}")
+    @on_event.call(event, "#{event.to_json}#{@delimiter}")
   end # def encode
 
   private

data/logstash-codec-json_lines.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-codec-json_lines'
-  s.version         = '2.0.3'
+  s.version         = '2.0.4'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This codec will decode streamed JSON that is newline delimited."
   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"
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   # Gem dependencies
   s.add_runtime_dependency "logstash-core", ">= 2.0.0.beta2", "< 3.0.0"
 
-  s.add_runtime_dependency 'logstash-codec-line'
+  s.add_runtime_dependency 'logstash-codec-line', '>= 2.1.0'
 
   s.add_development_dependency 'logstash-devutils'
 end

data/spec/codecs/json_lines_spec.rb

@@ -32,6 +32,23 @@ describe LogStash::Codecs::JSONLines do
       end
     end
 
+    context "when using custom delimiter" do
+      let(:delimiter) { "|" }
+      let(:line) { "{\"hey\":1}|{\"hey\":2}|{\"hey\":3}|" }
+      subject do
+        next LogStash::Codecs::JSONLines.new("delimiter" => delimiter)
+      end
+
+      it "should decode multiple lines separated by the delimiter" do
+        result = []
+        subject.decode(line) { |event| result << event }
+        expect(result.size).to eq(3)
+        expect(result[0]["hey"]).to eq(1)
+        expect(result[1]["hey"]).to eq(2)
+        expect(result[2]["hey"]).to eq(3)
+      end
+    end
+
     context "processing plain text" do
       it "falls back to plain text" do
         decoded = false
@@ -85,9 +102,10 @@ describe LogStash::Codecs::JSONLines do
   end
 
   context "#encode" do
+    let(:data) { { LogStash::Event::TIMESTAMP => "2015-12-07T11:37:00.000Z", "foo" => "bar", "baz" => {"bah" => ["a","b","c"]}} }
+    let(:event) { LogStash::Event.new(data) }
+
     it "should return json data" do
-      data = {LogStash::Event::TIMESTAMP => "2015-12-07T11:37:00.000Z", "foo" => "bar", "baz" => {"bah" => ["a","b","c"]}}
-      event = LogStash::Event.new(data)
       got_event = false
       subject.on_event do |e, d|
         insist { d } == "#{LogStash::Event.new(data).to_json}\n"
@@ -99,6 +117,20 @@ describe LogStash::Codecs::JSONLines do
       subject.encode(event)
       insist { got_event }
     end
+
+    context "when using custom delimiter" do
+      let(:delimiter) { "|" }
+      subject do
+        next LogStash::Codecs::JSONLines.new("delimiter" => delimiter)
+      end
+
+      it "should decode multiple lines separated by the delimiter" do
+        subject.on_event do |e, d|
+          insist { d } == "#{LogStash::Event.new(data).to_json}#{delimiter}"
+        end
+        subject.encode(event)
+      end
+    end
   end
 
   context 'reading from a simulated multiline json file without last newline' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-codec-json_lines
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-12-16 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core
@@ -36,12 +36,12 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency