logstash-output-file 2.2.5 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cbb0ffabd4f081efedc43d17d4acff421451e08
-  data.tar.gz: 05ae333018ac79dcd6213ae79d6b3c4d0c4540b6
+  metadata.gz: 718248e031f059ad44be35fd67bb9b3fa85225cf
+  data.tar.gz: fddc513cf871aa596be1f2139606027edf8cedc9
 SHA512:
-  metadata.gz: bb45bdf280c576b963a551349af9b96155b9292ce0a2e52ca05f1fb1373f9af85395a64ec6ad5b0c3fc2fadc65587051ee744b47abf76ee57b67d476c51d0173
-  data.tar.gz: 927e3b300612c68e8f54230224798be6255bb4867ee3af6bf7de518dd0efd5400aa221c5519f0f512404964a204a1bb0bfe8715c1230bc57653c7eb6800dc7f5
+  metadata.gz: 55c52415f8a59a976e1d43853fca4d9bbf98d0c820f41c87b45dbfc65284ea744d0d1c2358767f2ee338b3ea2fc1da9ceb630e0f982e26bc76ccc7fc8255d60f
+  data.tar.gz: d22c09f2d103e421e6e1f67bc890e95f3f2f131fb57b3c7591ef56544f01ccb3c5bc0124a4182daa081b487e3d6f7602520895b23469705c1e0daeb44f8e2186

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+## 3.0.0
+  - Update the plugin to the version 2.0 of the plugin api, this change is required for Logstash 5.0 compatibility. See https://github.com/elastic/logstash/issues/5141
 # 2.2.5
   - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
 # 2.2.4

data/Gemfile

@@ -1,2 +1,4 @@
 source 'https://rubygems.org'
-gemspec
+
+# Specify your gem's dependencies in logstash-mass_effect.gemspec
+gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+Copyright (c) 2012–2016 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.

data/README.md

@@ -1,7 +1,6 @@
 # Logstash Plugin
 
-[![Build
-Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-file-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-file-unit/)
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-output-file.svg)](https://travis-ci.org/logstash-plugins/logstash-output-file)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
@@ -56,7 +55,12 @@ gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
 ```
 - Install plugin
 ```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
 bin/plugin install --no-verify
+
 ```
 - Run Logstash with your plugin
 ```sh
@@ -74,7 +78,12 @@ gem build logstash-filter-awesome.gemspec
 ```
 - Install the plugin from the Logstash home
 ```sh
-bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
 ```
 - Start Logstash and proceed to test the plugin
 

data/lib/logstash/outputs/file.rb

@@ -54,8 +54,8 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
   # into this file and inside the defined path.
   config :filename_failure, :validate => :string, :default => '_filepath_failures'
 
-  # If the a file is deleted, but an event is comming with the need to be stored
-  # in such a file, the plugin will created a gain this file. Default => true
+  # If the configured file is deleted, but an event is handled by the plugin, 
+  # the plugin will recreate the file. Default => true
   config :create_if_deleted, :validate => :boolean, :default => true
 
   # Dir access mode to use. Note that due to the bug in jruby system umask

data/logstash-output-file.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-file'
-  s.version         = '2.2.5'
+  s.version         = '3.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This output will write 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/plugin install gemname. This gem is not a stand-alone program"
+  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.authors         = ["Elastic"]
   s.email           = 'info@elastic.co'
   s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core-plugin-api", "~> 1.0"
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
   s.add_runtime_dependency 'logstash-codec-json_lines'
   s.add_runtime_dependency 'logstash-codec-line'
 

data/spec/outputs/file_spec.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 require "logstash/devutils/rspec/spec_helper"
 require "logstash/outputs/file"
+require "logstash/codecs/line"
 require "logstash/event"
 require "logstash/json"
 require "stud/temporary"
@@ -33,10 +34,10 @@ describe LogStash::Outputs::File do
 
       # Now check all events for order and correctness.
       events = tmp_file.map {|line| LogStash::Event.new(LogStash::Json.load(line))}
-      sorted = events.sort_by {|e| e['sequence']}
+      sorted = events.sort_by {|e| e.get('sequence')}
       sorted.each do |event|
-        insist {event["message"]} == "hello world"
-        insist {event["sequence"]} == line_num
+        insist {event.get("message")} == "hello world"
+        insist {event.get("sequence")} == line_num
         line_num += 1
       end
 
@@ -68,10 +69,10 @@ describe LogStash::Outputs::File do
         line_num = 0
         # Now check all events for order and correctness.
         events = Zlib::GzipReader.open(tmp_file.path).map {|line| LogStash::Event.new(LogStash::Json.load(line)) }
-        sorted = events.sort_by {|e| e["sequence"]}
+        sorted = events.sort_by {|e| e.get("sequence")}
         sorted.each do |event|
-          insist {event["message"]} == "hello world"
-          insist {event["sequence"]} == line_num
+          insist {event.get("message")} == "hello world"
+          insist {event.get("sequence")} == line_num
           line_num += 1
         end
         insist {line_num} == event_count
@@ -165,7 +166,7 @@ describe LogStash::Outputs::File do
       context "when trying to write outside the files root directory" do
         let(:bad_event) do
           event = LogStash::Event.new
-          event['error'] = '../uncool/directory'
+          event.set('error', '../uncool/directory')
           event
         end
 
@@ -178,7 +179,7 @@ describe LogStash::Outputs::File do
 
             # Trying to write outside the file root
             outside_path = "#{'../' * path.split(File::SEPARATOR).size}notcool"
-            bad_event["error"] = outside_path
+            bad_event.set("error", outside_path)
 
 
             output = LogStash::Outputs::File.new(config)
@@ -200,10 +201,10 @@ describe LogStash::Outputs::File do
             output = LogStash::Outputs::File.new({ "path" =>  "/#{path}/%{error}"})
             output.register
 
-            bad_event['error'] = encoded_once
+            bad_event.set('error', encoded_once)
             output.receive(bad_event)
 
-            bad_event['error'] = encoded_twice
+            bad_event.set('error', encoded_twice)
             output.receive(bad_event)
 
             expect(Dir.glob(File.join(path, "*")).size).to eq(2)
@@ -216,7 +217,7 @@ describe LogStash::Outputs::File do
             output = LogStash::Outputs::File.new({ "path" =>  "/#{path}/%{error}"})
             output.register
 
-            bad_event['error'] = '../..//test'
+            bad_event.set('error', '../..//test')
             output.receive(bad_event)
 
             expect(Dir.glob(File.join(path, "*")).size).to eq(1)
@@ -228,7 +229,7 @@ describe LogStash::Outputs::File do
       context 'when trying to write inside the file root directory' do
         it 'write the event to the generated filename' do
           good_event = LogStash::Event.new
-          good_event['error'] = '42.txt'
+          good_event.set('error', '42.txt')
 
           Stud::Temporary.directory do |path|
             config = { "path" => "#{path}/%{error}" }
@@ -236,7 +237,7 @@ describe LogStash::Outputs::File do
             output.register
             output.receive(good_event)
 
-            good_file = File.join(path, good_event['error'])
+            good_file = File.join(path, good_event.get('error'))
             expect(File.exist?(good_file)).to eq(true)
             output.close
           end
@@ -284,7 +285,7 @@ describe LogStash::Outputs::File do
 
         it 'write the event to the generated filename with multiple deep' do
           good_event = LogStash::Event.new
-          good_event['error'] = '/inside/errors/42.txt'
+          good_event.set('error', '/inside/errors/42.txt')
 
           Stud::Temporary.directory do |path|
             config = { "path" => "#{path}/%{error}" }
@@ -292,7 +293,7 @@ describe LogStash::Outputs::File do
             output.register
             output.receive(good_event)
 
-            good_file = File.join(path, good_event['error'])
+            good_file = File.join(path, good_event.get('error'))
             expect(File.exist?(good_file)).to eq(true)
             output.close
           end
@@ -303,7 +304,7 @@ describe LogStash::Outputs::File do
       context "when using default configuration" do
         it 'write the event as a json line' do
           good_event = LogStash::Event.new
-          good_event['message'] = 'hello world'
+          good_event.set('message', 'hello world')
 
           Stud::Temporary.directory do |path|
             config = { "path" => "#{path}/output.txt" }
@@ -315,7 +316,7 @@ describe LogStash::Outputs::File do
             output.close #teardown first to allow reading the file
             File.open(good_file) {|f|
               event = LogStash::Event.new(LogStash::Json.load(f.readline))
-              expect(event["message"]).to eq("hello world")
+              expect(event.get("message")).to eq("hello world")
             }
           end
         end
@@ -323,7 +324,7 @@ describe LogStash::Outputs::File do
       context "when using line codec" do
         it 'writes event using specified format' do
           good_event = LogStash::Event.new
-          good_event['message'] = "hello world"
+          good_event.set('message', "hello world")
 
           Stud::Temporary.directory do |path|
             config = { "path" => "#{path}/output.txt" }
@@ -344,7 +345,7 @@ describe LogStash::Outputs::File do
       context "when using deprecated message_format config" do
         it 'falls back to line codec' do
           good_event = LogStash::Event.new
-          good_event['message'] = 'hello world'
+          good_event.set('message', 'hello world')
 
           Stud::Temporary.directory do |path|
             config = { "path" => "#{path}/output.txt", "message_format" => "Custom format: %{message}" }
@@ -364,7 +365,7 @@ describe LogStash::Outputs::File do
       context "when using file and dir modes" do
         it 'dirs and files are created with correct atypical permissions' do
           good_event = LogStash::Event.new
-          good_event['message'] = "hello world"
+          good_event.set('message', "hello world")
 
           Stud::Temporary.directory do |path|
             config = {
@@ -385,7 +386,7 @@ describe LogStash::Outputs::File do
             output.close #teardown first to allow reading the file
             File.open(good_file) {|f|
               event = LogStash::Event.new(LogStash::Json.load(f.readline))
-              expect(event["message"]).to eq("hello world")
+              expect(event.get("message")).to eq("hello world")
             }
           end
         end

metadata

@@ -1,86 +1,88 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-file
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 3.0.0
 platform: ruby
 authors:
 - Elastic
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  name: logstash-core-plugin-api
-  prerelease: false
+        version: '2.0'
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
+  name: logstash-codec-json_lines
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-codec-json_lines
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: logstash-codec-line
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-codec-line
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: logstash-devutils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-devutils
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: logstash-input-generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-input-generator
-  prerelease: false
   type: :development
+  prerelease: false
   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/plugin install gemname. This gem is not a stand-alone program
+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: info@elastic.co
 executables: []
 extensions: []
@@ -101,7 +103,7 @@ licenses:
 metadata:
   logstash_plugin: 'true'
   logstash_group: output
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -116,9 +118,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.4.8
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
 specification_version: 4
 summary: This output will write events to files on disk
 test_files: