logstash-input-file 4.1.4 → 4.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7cb22ef0489b15ab92212c179444aefcd5be9e95fc4984c28f83de3397bf54c
-  data.tar.gz: 7a68f15af95595390a4f44e3fd9f641522e1e8ce3feafb7b299b1e056b5b2df7
+  metadata.gz: 91fd970a376e7386f8b2b5ead8a5f2f62e2f1cebce0783aedd44b30913dcc4d5
+  data.tar.gz: 7f291854ae2eb7417d15de37d92abf2abe5524e7bd4021c2d241c0d39d177545
 SHA512:
-  metadata.gz: fedb59ccffbf65f45f1f88dc76cd5e45d126866f75e4eb9271ef44a1e2b7922f98ff49643272cfdfa5f1ac01d445104f8a6c308f71e8255e85cc19c95809122a
-  data.tar.gz: d10e33bf905addfc71a5ce4ce026f3fe4b7f80871b1ba087f41fc3ed7b7981289986ec61a5b4b96ef9bd37af4b26ace1219b99c723032a49a1779ee9e52010f2
+  metadata.gz: b1c945d44197cdab2609f351e395aaa40c45f872b912f754ce7f4485d8b00d313e693752feede403f93bf5e1c551fb90c61258821d73a72b16dbc7cbc233747a
+  data.tar.gz: 6d84ca4b777a648a0f7d51ec976a544fb28dc9c2370ebfd56cdfd259820d778807865751dc7e14b788f72c0c7a1fc2bdcf742e07c45fcac4c0dc0f84cef9160f

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.1.5
+  - Fixed text anchor by changing it from hardcoded to asciidoc reference to
+    work in versioned plugin reference
+
 ## 4.1.4
   - Fixed a regression where files discovered after first discovery were not
     always read from the beginning. Applies to tail mode only.
@@ -8,6 +12,7 @@
     was possible to read into memory allocated but not filled with data resulting
     in ASCII NUL (0) bytes in the message field. Now, files are read up to the
     size as given by the remote filesystem client. Applies to tail and read modes.
+    
 ## 4.1.3
   - Fixed `read` mode of regular files sincedb write is requested in each read loop
     iteration rather than waiting for the end-of-file to be reached. Note: for gz files,

data/docs/index.asciidoc

@@ -159,12 +159,12 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 [NOTE]
 Duration settings can be specified in text form e.g. "250 ms", this string will be converted into
 decimal seconds. There are quite a few supported natural and abbreviated durations,
-see <<string_duration,string duration>> for the details.
+see <<plugins-{type}s-{plugin}-string_duration,string_duration>> for the details.
 
 [cols="<,<,<",options="header",]
 |=======================================================================
 |Setting |Input type|Required
-| <<plugins-{type}s-{plugin}-close_older>> |<<number,number>> or <<string_duration,string duration>>|No
+| <<plugins-{type}s-{plugin}-close_older>> |<<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>|No
 | <<plugins-{type}s-{plugin}-delimiter>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-discover_interval>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-exclude>> |<<array,array>>|No
@@ -174,15 +174,15 @@ see <<string_duration,string duration>> for the details.
 | <<plugins-{type}s-{plugin}-file_completed_log_path>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-file_sort_by>> |<<string,string>>, one of `["last_modified", "path"]`|No
 | <<plugins-{type}s-{plugin}-file_sort_direction>> |<<string,string>>, one of `["asc", "desc"]`|No
-| <<plugins-{type}s-{plugin}-ignore_older>> |<<number,number>> or <<string_duration,string duration>>|No
+| <<plugins-{type}s-{plugin}-ignore_older>> |<<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>|No
 | <<plugins-{type}s-{plugin}-max_open_files>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-mode>> |<<string,string>>, one of `["tail", "read"]`|No
 | <<plugins-{type}s-{plugin}-path>> |<<array,array>>|Yes
-| <<plugins-{type}s-{plugin}-sincedb_clean_after>> |<<number,number>> or <<string_duration,string duration>>|No
+| <<plugins-{type}s-{plugin}-sincedb_clean_after>> |<<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>|No
 | <<plugins-{type}s-{plugin}-sincedb_path>> |<<string,string>>|No
-| <<plugins-{type}s-{plugin}-sincedb_write_interval>> |<<number,number>> or <<string_duration,string duration>>|No
+| <<plugins-{type}s-{plugin}-sincedb_write_interval>> |<<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>|No
 | <<plugins-{type}s-{plugin}-start_position>> |<<string,string>>, one of `["beginning", "end"]`|No
-| <<plugins-{type}s-{plugin}-stat_interval>> |<<number,number>> or <<string_duration,string duration>>|No
+| <<plugins-{type}s-{plugin}-stat_interval>> |<<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>|No
 |=======================================================================
 
 Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
@@ -193,7 +193,7 @@ input plugins.
 [id="plugins-{type}s-{plugin}-close_older"]
 ===== `close_older`
 
-  * Value type is <<number,number>> or <<string_duration,string duration>>
+  * Value type is <<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>
   * Default value is `"1 hour"`
 
 The file input closes any files that were last read the specified
@@ -311,7 +311,7 @@ If you use special naming conventions for the file full paths then perhaps
 [id="plugins-{type}s-{plugin}-ignore_older"]
 ===== `ignore_older`
 
-  * Value type is <<number,number>> or <<string_duration,string duration>>
+  * Value type is <<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>
   * There is no default value for this setting.
 
 When the file input discovers a file that was last modified
@@ -371,7 +371,7 @@ on the {logstash-ref}/configuration-file-structure.html#array[Logstash configura
 [id="plugins-{type}s-{plugin}-sincedb_clean_after"]
 ===== `sincedb_clean_after`
 
-  * Value type is <<number,number>> or <<string_duration,string duration>>
+  * Value type is <<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>
   * The default value for this setting is "2 weeks".
   * If a number is specified then it is interpreted as *days* and can be decimal e.g. 0.5 is 12 hours.
 
@@ -395,7 +395,7 @@ NOTE: it must be a file path and not a directory path
 [id="plugins-{type}s-{plugin}-sincedb_write_interval"]
 ===== `sincedb_write_interval`
 
-  * Value type is <<number,number>> or <<string_duration,string duration>>
+  * Value type is <<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>
   * Default value is `"15 seconds"`
 
 How often (in seconds) to write a since database with the current position of
@@ -421,7 +421,7 @@ position recorded in the sincedb file will be used.
 [id="plugins-{type}s-{plugin}-stat_interval"]
 ===== `stat_interval`
 
-  * Value type is <<number,number>> or <<string_duration,string duration>>
+  * Value type is <<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>
   * Default value is `"1 second"`
 
 How often (in seconds) we stat files to see if they have been modified.
@@ -438,9 +438,8 @@ the pipeline is congested. So the overall loop time is a combination of the
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]
 
-:default_codec!:
 
-[id="string_duration"]
+[id="plugins-{type}s-{plugin}-string_duration"]
 // Move this to the includes when we make string durations available generally.
 ==== String Durations
 
@@ -474,3 +473,4 @@ Supported values: `us` `usec` `usecs`, e.g. "600 us", "800 usec", "900 usecs"
 [NOTE]
 `micro` `micros` and `microseconds` are not supported
 
+:default_codec!:

data/lib/filewatch/read_mode/handlers/read_file.rb

@@ -30,6 +30,7 @@ module FileWatch module ReadMode module Handlers
     def controlled_read(watched_file, loop_control)
       logger.trace("reading...", "iterations" => loop_control.count, "amount" => loop_control.size, "filename" => watched_file.filename)
       loop_control.count.times do
+        break if quit?
         begin
           result = watched_file.read_extract_lines(loop_control.size) # expect BufferExtractResult
           logger.info(result.warning, result.additional) unless result.warning.empty?

data/lib/filewatch/tail_mode/handlers/base.rb

@@ -6,12 +6,17 @@ module FileWatch module TailMode module Handlers
     include LogStash::Util::Loggable
     attr_reader :sincedb_collection
 
-    def initialize(sincedb_collection, observer, settings)
+    def initialize(processor, sincedb_collection, observer, settings)
       @settings = settings
+      @processor = processor
       @sincedb_collection = sincedb_collection
       @observer = observer
     end
 
+    def quit?
+      @processor.watch.quit?
+    end
+
     def handle(watched_file)
       logger.trace("handling: #{watched_file.filename}")
       unless watched_file.has_listener?
@@ -41,7 +46,9 @@ module FileWatch module TailMode module Handlers
       # user also has the option to specify a low `stat_interval` and a very high `discover_interval`to respond
       # quicker to changing files and not allowing too much content to build up before reading it.
       loop_control.count.times do
+        break if quit?
         begin
+          logger.debug("read_to_eof: get chunk")
           result = watched_file.read_extract_lines(loop_control.size) # expect BufferExtractResult
           logger.trace(result.warning, result.additional) unless result.warning.empty?
           changed = true
@@ -62,6 +69,7 @@ module FileWatch module TailMode module Handlers
           break
         end
       end
+      logger.debug("read_to_eof: exit due to quit") if quit?
       sincedb_collection.request_disk_flush if changed
     end
 

data/lib/filewatch/tail_mode/handlers/grow.rb

@@ -5,6 +5,7 @@ module FileWatch module TailMode module Handlers
     def handle_specifically(watched_file)
       watched_file.file_seek(watched_file.bytes_read)
       loop do
+        break if quit?
         loop_control = watched_file.loop_control_adjusted_for_stat_size
         controlled_read(watched_file, loop_control)
         break unless loop_control.more

data/lib/filewatch/tail_mode/handlers/shrink.rb

@@ -6,6 +6,7 @@ module FileWatch module TailMode module Handlers
       add_or_update_sincedb_collection(watched_file)
       watched_file.file_seek(watched_file.bytes_read)
       loop do
+        break if quit?
         loop_control = watched_file.loop_control_adjusted_for_stat_size
         controlled_read(watched_file, loop_control)
         break unless loop_control.more

data/lib/filewatch/tail_mode/processor.rb

@@ -35,13 +35,13 @@ module FileWatch module TailMode
 
     def initialize_handlers(sincedb_collection, observer)
       @sincedb_collection = sincedb_collection
-      @create_initial = Handlers::CreateInitial.new(sincedb_collection, observer, @settings)
-      @create = Handlers::Create.new(sincedb_collection, observer, @settings)
-      @grow = Handlers::Grow.new(sincedb_collection, observer, @settings)
-      @shrink = Handlers::Shrink.new(sincedb_collection, observer, @settings)
-      @delete = Handlers::Delete.new(sincedb_collection, observer, @settings)
-      @timeout = Handlers::Timeout.new(sincedb_collection, observer, @settings)
-      @unignore = Handlers::Unignore.new(sincedb_collection, observer, @settings)
+      @create_initial = Handlers::CreateInitial.new(self, sincedb_collection, observer, @settings)
+      @create = Handlers::Create.new(self, sincedb_collection, observer, @settings)
+      @grow = Handlers::Grow.new(self, sincedb_collection, observer, @settings)
+      @shrink = Handlers::Shrink.new(self, sincedb_collection, observer, @settings)
+      @delete = Handlers::Delete.new(self, sincedb_collection, observer, @settings)
+      @timeout = Handlers::Timeout.new(self, sincedb_collection, observer, @settings)
+      @unignore = Handlers::Unignore.new(self, sincedb_collection, observer, @settings)
     end
 
     def create(watched_file)

data/logstash-input-file.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-file'
-  s.version         = '4.1.4'
+  s.version         = '4.1.5'
   s.licenses        = ['Apache-2.0']
   s.summary         = "Streams events from files"
   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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-file
 version: !ruby/object:Gem::Version
-  version: 4.1.4
+  version: 4.1.5
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-13 00:00:00.000000000 Z
+date: 2018-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement