logstash-output-file 4.1.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0031f28c479fb5916b1cb21c53b4e1f0438716d05eb58d910383992dd767b0fa
-  data.tar.gz: 9cb1ffa71455af5af93349a6e437548155451887ef72c4a5c9361d863987ef70
+  metadata.gz: f1c0a72039a31511cef581ab157dc78e8e545b16fb9e1301d8628f9ab77492c6
+  data.tar.gz: c86ee9d1049b8caa50ec3d6089a4fa8ac958bb16e8f4b6294c3e51a7795c23e2
 SHA512:
-  metadata.gz: b36b0dbc3be1c59f45295079358cc36c875e4234cd6bbc927432f9408ed9a8ab8bc8a77584fc910f83eeea120c4f1fe38617f72831358d174ce872e6ecf6ab48
-  data.tar.gz: 7b92b2bddf002098e4790aaf6f4eff582486e349ecd989189641b11a9182ba424b1d669b676d72f9f758f74258bbb5720c9ef20b840e67b4308a96cf390ad1f4
+  metadata.gz: c9d25f9bb1d42e83c2843592001b4d5670004a0b26bf30a14e05ae46b530ccd23e4fdd69527b937bc14d98235e5280b97247c586f8b12d6444583e9c68c13951
+  data.tar.gz: 02d594fa1aa927b877f7495954029ae568bd4fcf6080331fa89cbc2919b063f8ffb7471334889a238822711e5fd5e5138e422e59858be720d41cf9d81fb560a7

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 4.2.0
+  - New `write_behavior` feature. Value can be "append" (default) or
+    "overwrite". If "append", events will be appended to the end of the file.
+    If "overwrite", the file will only contain the last event written.
+
 ## 4.1.2
   - Update gemspec summary
 

data/lib/logstash/outputs/file.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 require "logstash/namespace"
 require "logstash/outputs/base"
+require "flores/random"
 require "logstash/errors"
 require "zlib"
 
@@ -64,6 +65,16 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
   # Example: `"file_mode" => 0640`
   config :file_mode, :validate => :number, :default => -1
 
+
+  # How should the file be written?
+  #
+  # If `append`, the file will be opened for appending and each new event will
+  # be written at the end of the file.
+  #
+  # If `overwrite`, the file will be truncated before writing and only the most
+  # recent event will appear in the file.
+  config :write_behavior, :validate => [ "overwrite", "append" ], :default => "append"
+
   default :codec, "json_lines"
 
   public
@@ -123,7 +134,14 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
     @io_mutex.synchronize do
       encoded_by_path.each do |path,chunks|
         fd = open(path)
-        chunks.each {|chunk| fd.write(chunk) }
+        if @write_behavior == "overwrite"
+          fd.truncate(0)
+          fd.seek(0, IO::SEEK_SET)
+          fd.write(chunks.last)
+        else
+          # append to the file
+          chunks.each {|chunk| fd.write(chunk) }
+        end
         fd.flush
       end
       

data/logstash-output-file.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-file'
-  s.version         = '4.1.2'
+  s.version         = '4.2.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Writes events to files on disk"
   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"
@@ -25,5 +25,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'logstash-codec-line'
 
   s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'flores'
   s.add_development_dependency 'logstash-input-generator'
 end

data/spec/outputs/file_spec.rb

@@ -2,6 +2,7 @@
 require "logstash/devutils/rspec/spec_helper"
 require "logstash/outputs/file"
 require "logstash/codecs/line"
+require "logstash/codecs/json_lines"
 require "logstash/event"
 require "logstash/json"
 require "stud/temporary"
@@ -111,6 +112,49 @@ describe LogStash::Outputs::File do
 
   describe "receiving events" do
 
+    context "when write_behavior => 'overwrite'" do
+      let(:tmp) { Stud::Temporary.pathname }
+      let(:config) {
+        { 
+          "write_behavior" => "overwrite",
+          "path" => tmp,
+          "codec" => LogStash::Codecs::JSONLines.new
+        }
+      }
+      let(:output) { LogStash::Outputs::File.new(config) }
+
+      let(:count) { Flores::Random.integer(1..10) }
+      let(:events) do 
+        Flores::Random.iterations(1..10).collect do |i|
+          LogStash::Event.new("value" => i)
+        end
+      end
+
+      before do
+        output.register
+      end
+
+      after do
+        File.unlink(tmp) if File.exist?(tmp)
+      end
+
+      it "should write only the last event of a batch" do
+        output.multi_receive(events)
+        result = LogStash::Json.load(File.read(tmp))
+        expect(result["value"]).to be == events.last.get("value")
+      end
+
+      context "the file" do
+        it "should only contain the last event received" do
+          events.each do |event|
+            output.multi_receive([event])
+            result = LogStash::Json.load(File.read(tmp))
+            expect(result["value"]).to be == event.get("value")
+          end
+        end
+      end
+    end
+
     context "when the output file is deleted" do
 
       let(:temp_file) { Tempfile.new('logstash-spec-output-file_deleted') }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-file
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.2.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2017-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: flores
+  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:
@@ -126,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
 summary: Writes events to files on disk