fluentd 1.11.5-x64-mingw32 → 1.12.0-x64-mingw32

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of fluentd might be problematic. Click here for more details.

Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/.github/ISSUE_TEMPLATE/bug_report.md +1 -1
  3. data/.github/ISSUE_TEMPLATE/config.yml +5 -0
  4. data/.github/workflows/stale-actions.yml +22 -0
  5. data/.travis.yml +22 -2
  6. data/CHANGELOG.md +38 -0
  7. data/README.md +1 -1
  8. data/appveyor.yml +3 -0
  9. data/bin/fluent-cap-ctl +7 -0
  10. data/bin/fluent-ctl +7 -0
  11. data/fluentd.gemspec +1 -0
  12. data/lib/fluent/capability.rb +87 -0
  13. data/lib/fluent/command/cap_ctl.rb +174 -0
  14. data/lib/fluent/command/ctl.rb +177 -0
  15. data/lib/fluent/command/plugin_config_formatter.rb +2 -1
  16. data/lib/fluent/env.rb +4 -0
  17. data/lib/fluent/plugin.rb +5 -0
  18. data/lib/fluent/plugin/buffer.rb +2 -21
  19. data/lib/fluent/plugin/formatter.rb +2 -2
  20. data/lib/fluent/plugin/formatter_csv.rb +1 -1
  21. data/lib/fluent/plugin/formatter_hash.rb +1 -1
  22. data/lib/fluent/plugin/formatter_ltsv.rb +3 -3
  23. data/lib/fluent/plugin/formatter_out_file.rb +3 -3
  24. data/lib/fluent/plugin/formatter_single_value.rb +2 -2
  25. data/lib/fluent/plugin/formatter_tsv.rb +2 -2
  26. data/lib/fluent/plugin/in_http.rb +23 -2
  27. data/lib/fluent/plugin/in_tail.rb +109 -41
  28. data/lib/fluent/plugin/in_tail/position_file.rb +39 -14
  29. data/lib/fluent/plugin/in_tcp.rb +1 -0
  30. data/lib/fluent/plugin/output.rb +7 -1
  31. data/lib/fluent/plugin_helper/http_server/compat/server.rb +1 -1
  32. data/lib/fluent/plugin_helper/inject.rb +4 -2
  33. data/lib/fluent/plugin_helper/retry_state.rb +4 -0
  34. data/lib/fluent/supervisor.rb +140 -42
  35. data/lib/fluent/time.rb +1 -0
  36. data/lib/fluent/version.rb +1 -1
  37. data/lib/fluent/winsvc.rb +22 -4
  38. data/test/command/test_cap_ctl.rb +100 -0
  39. data/test/command/test_ctl.rb +57 -0
  40. data/test/command/test_plugin_config_formatter.rb +57 -2
  41. data/test/plugin/in_tail/test_position_file.rb +45 -25
  42. data/test/plugin/test_in_http.rb +25 -0
  43. data/test/plugin/test_in_tail.rb +430 -30
  44. data/test/plugin/test_parser_syslog.rb +2 -2
  45. data/test/plugin_helper/test_inject.rb +29 -0
  46. data/test/test_capability.rb +74 -0
  47. data/test/test_supervisor.rb +102 -10
  48. metadata +31 -2
@@ -0,0 +1,177 @@
1
+ #
2
+ # Fluentd
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+ #
16
+
17
+ require 'optparse'
18
+ require 'fluent/env'
19
+ require 'fluent/version'
20
+ if Fluent.windows?
21
+ require 'win32/event'
22
+ require 'win32/service'
23
+ end
24
+
25
+ module Fluent
26
+ class Ctl
27
+ DEFAULT_OPTIONS = {}
28
+
29
+ if Fluent.windows?
30
+ include Windows::ServiceConstants
31
+ include Windows::ServiceStructs
32
+ include Windows::ServiceFunctions
33
+
34
+ COMMAND_MAP = {
35
+ shutdown: "",
36
+ restart: "HUP",
37
+ flush: "USR1",
38
+ reload: "USR2",
39
+ }
40
+ WINSVC_CONTROL_CODE_MAP = {
41
+ shutdown: SERVICE_CONTROL_STOP,
42
+ # 128 - 255: user-defined control code
43
+ # See https://docs.microsoft.com/en-us/windows/win32/api/winsvc/nf-winsvc-controlservice
44
+ restart: 128,
45
+ flush: 129,
46
+ reload: SERVICE_CONTROL_PARAMCHANGE,
47
+ }
48
+ else
49
+ COMMAND_MAP = {
50
+ shutdown: :TERM,
51
+ restart: :HUP,
52
+ flush: :USR1,
53
+ reload: :USR2,
54
+ }
55
+ end
56
+
57
+ def initialize(argv = ARGV)
58
+ @argv = argv
59
+ @options = {}
60
+ @opt_parser = OptionParser.new
61
+ configure_option_parser
62
+ @options.merge!(DEFAULT_OPTIONS)
63
+ parse_options!
64
+ end
65
+
66
+ def help_text
67
+ text = "\n"
68
+ if Fluent.windows?
69
+ text << "Usage: #{$PROGRAM_NAME} COMMAND [PID_OR_SVCNAME]\n"
70
+ else
71
+ text << "Usage: #{$PROGRAM_NAME} COMMAND PID\n"
72
+ end
73
+ text << "\n"
74
+ text << "Commands: \n"
75
+ COMMAND_MAP.each do |key, value|
76
+ text << " #{key}\n"
77
+ end
78
+ text
79
+ end
80
+
81
+ def usage(msg = nil)
82
+ puts help_text
83
+ if msg
84
+ puts
85
+ puts "Error: #{msg}"
86
+ end
87
+ exit 1
88
+ end
89
+
90
+ def call
91
+ if Fluent.windows?
92
+ if @pid_or_svcname =~ /^[0-9]+$/
93
+ # Use as PID
94
+ return call_windows_event(@command, "fluentd_#{@pid_or_svcname}")
95
+ end
96
+
97
+ unless call_winsvc_control_code(@command, @pid_or_svcname)
98
+ puts "Cannot send control code to #{@pid_or_svcname} service, try to send an event with this name ..."
99
+ call_windows_event(@command, @pid_or_svcname)
100
+ end
101
+ else
102
+ call_signal(@command, @pid_or_svcname)
103
+ end
104
+ end
105
+
106
+ private
107
+
108
+ def call_signal(command, pid)
109
+ signal = COMMAND_MAP[command.to_sym]
110
+ Process.kill(signal, pid.to_i)
111
+ end
112
+
113
+ def call_winsvc_control_code(command, pid_or_svcname)
114
+ status = SERVICE_STATUS.new
115
+
116
+ begin
117
+ handle_scm = OpenSCManager(nil, nil, SC_MANAGER_CONNECT)
118
+ FFI.raise_windows_error('OpenSCManager') if handle_scm == 0
119
+
120
+ handle_scs = OpenService(handle_scm, "fluentdwinsvc", SERVICE_STOP | SERVICE_PAUSE_CONTINUE | SERVICE_USER_DEFINED_CONTROL)
121
+ FFI.raise_windows_error('OpenService') if handle_scs == 0
122
+
123
+ control_code = WINSVC_CONTROL_CODE_MAP[command.to_sym]
124
+
125
+ unless ControlService(handle_scs, control_code, status)
126
+ FFI.raise_windows_error('ControlService')
127
+ end
128
+ rescue => e
129
+ puts e
130
+ state = status[:dwCurrentState]
131
+ return state == SERVICE_STOPPED || state == SERVICE_STOP_PENDING
132
+ ensure
133
+ CloseServiceHandle(handle_scs)
134
+ CloseServiceHandle(handle_scm)
135
+ end
136
+
137
+ return true
138
+ end
139
+
140
+ def call_windows_event(command, pid_or_svcname)
141
+ prefix = pid_or_svcname
142
+ event_name = COMMAND_MAP[command.to_sym]
143
+ suffix = event_name.empty? ? "" : "_#{event_name}"
144
+
145
+ begin
146
+ event = Win32::Event.open("#{prefix}#{suffix}")
147
+ event.set
148
+ event.close
149
+ rescue Errno::ENOENT => e
150
+ puts "Error: Cannot find the fluentd process with the event name: \"#{prefix}\""
151
+ end
152
+ end
153
+
154
+ def configure_option_parser
155
+ @opt_parser.banner = help_text
156
+ @opt_parser.version = Fluent::VERSION
157
+ end
158
+
159
+ def parse_options!
160
+ @opt_parser.parse!(@argv)
161
+
162
+ @command = @argv[0]
163
+ @pid_or_svcname = @argv[1] || "fluentdwinsvc"
164
+
165
+ usage("Command isn't specified!") if @command.nil? || @command.empty?
166
+ usage("Unknown command: #{@command}") unless COMMAND_MAP.has_key?(@command.to_sym)
167
+
168
+ if Fluent.windows?
169
+ usage("PID or SVCNAME isn't specified!") if @pid_or_svcname.nil? || @pid_or_svcname.empty?
170
+ else
171
+ usage("PID isn't specified!") if @pid_or_svcname.nil? || @pid_or_svcname.empty?
172
+ usage("Invalid PID: #{pid}") unless @pid_or_svcname =~ /^[0-9]+$/
173
+ end
174
+ end
175
+ end
176
+ end
177
+
@@ -29,7 +29,8 @@ class FluentPluginConfigFormatter
29
29
  AVAILABLE_FORMATS = [:markdown, :txt, :json]
30
30
  SUPPORTED_TYPES = [
31
31
  "input", "output", "filter",
32
- "buffer", "parser", "formatter", "storage"
32
+ "buffer", "parser", "formatter", "storage",
33
+ "service_discovery"
33
34
  ]
34
35
 
35
36
  DOCS_BASE_URL = "https://docs.fluentd.org/v/1.0"
@@ -28,4 +28,8 @@ module Fluent
28
28
  def self.windows?
29
29
  ServerEngine.windows?
30
30
  end
31
+
32
+ def self.linux?
33
+ /linux/ === RUBY_PLATFORM
34
+ end
31
35
  end
@@ -121,6 +121,11 @@ module Fluent
121
121
  new_impl('sd', SD_REGISTRY, type, parent)
122
122
  end
123
123
 
124
+ class << self
125
+ # This should be defined for fluent-plugin-config-formatter type arguments.
126
+ alias_method :new_service_discovery, :new_sd
127
+ end
128
+
124
129
  def self.new_parser(type, parent: nil)
125
130
  if type[0] == '/' && type[-1] == '/'
126
131
  # This usage is not recommended for new API... create RegexpParser directly
@@ -143,33 +143,14 @@ module Fluent
143
143
  end
144
144
  end
145
145
 
146
- # timekey should be unixtime as usual.
147
- # So, unixtime should be bigger than 2^30 - 1 (= 1073741823) nowadays.
148
- # We should check object_id stability to use object_id as optimization for comparing operations.
149
- # e.g.)
150
- # irb> Time.parse("2020/07/31 18:30:00+09:00").to_i
151
- # => 1596187800
152
- # irb> Time.parse("2020/07/31 18:30:00+09:00").to_i > 2**30 -1
153
- # => true
154
- def self.enable_optimize?
155
- a1 = 2**30 - 1
156
- a2 = 2**30 - 1
157
- b1 = 2**62 - 1
158
- b2 = 2**62 - 1
159
- (a1.object_id == a2.object_id) && (b1.object_id == b2.object_id)
160
- end
161
-
162
146
  # This is an optimization code. Current Struct's implementation is comparing all data.
163
147
  # https://github.com/ruby/ruby/blob/0623e2b7cc621b1733a760b72af246b06c30cf96/struct.c#L1200-L1203
164
148
  # Actually this overhead is very small but this class is generated *per chunk* (and used in hash object).
165
149
  # This means that this class is one of the most called object in Fluentd.
166
150
  # See https://github.com/fluent/fluentd/pull/2560
167
- # But, this optimization has a side effect on Windows and 32bit environment(s) due to differing object_id.
168
- # This difference causes flood of buffer files.
169
- # So, this optimization should be enabled on `enable_optimize?` as true platforms.
170
151
  def hash
171
- timekey.object_id
172
- end if enable_optimize?
152
+ timekey.hash
153
+ end
173
154
  end
174
155
 
175
156
  # for tests
@@ -63,9 +63,9 @@ module Fluent
63
63
  super
64
64
  @newline = case newline
65
65
  when :lf
66
- "\n"
66
+ "\n".freeze
67
67
  when :crlf
68
- "\r\n"
68
+ "\r\n".freeze
69
69
  end
70
70
  end
71
71
  end
@@ -27,7 +27,7 @@ module Fluent
27
27
  helpers :record_accessor
28
28
 
29
29
  config_param :delimiter, default: ',' do |val|
30
- ['\t', 'TAB'].include?(val) ? "\t" : val
30
+ ['\t', 'TAB'].include?(val) ? "\t".freeze : val.freeze
31
31
  end
32
32
  config_param :force_quotes, :bool, default: true
33
33
  # "array" looks good for type of :fields, but this implementation removes tailing comma
@@ -27,7 +27,7 @@ module Fluent
27
27
 
28
28
  def format(tag, time, record)
29
29
  line = record.to_s
30
- line << @newline.freeze if @add_newline
30
+ line << @newline if @add_newline
31
31
  line
32
32
  end
33
33
  end
@@ -25,8 +25,8 @@ module Fluent
25
25
 
26
26
  # http://ltsv.org/
27
27
 
28
- config_param :delimiter, :string, default: "\t"
29
- config_param :label_delimiter, :string, default: ":"
28
+ config_param :delimiter, :string, default: "\t".freeze
29
+ config_param :label_delimiter, :string, default: ":".freeze
30
30
  config_param :add_newline, :bool, default: true
31
31
 
32
32
  # TODO: escaping for \t in values
@@ -36,7 +36,7 @@ module Fluent
36
36
  formatted << @delimiter if formatted.length.nonzero?
37
37
  formatted << "#{label}#{@label_delimiter}#{value}"
38
38
  end
39
- formatted << @newline.freeze if @add_newline
39
+ formatted << @newline if @add_newline
40
40
  formatted
41
41
  end
42
42
  end
@@ -29,9 +29,9 @@ module Fluent
29
29
  config_param :output_tag, :bool, default: true
30
30
  config_param :delimiter, default: "\t" do |val|
31
31
  case val
32
- when /SPACE/i then ' '
33
- when /COMMA/i then ','
34
- else "\t"
32
+ when /SPACE/i then ' '.freeze
33
+ when /COMMA/i then ','.freeze
34
+ else "\t".freeze
35
35
  end
36
36
  end
37
37
  config_set_default :time_type, :string
@@ -23,12 +23,12 @@ module Fluent
23
23
 
24
24
  Plugin.register_formatter('single_value', self)
25
25
 
26
- config_param :message_key, :string, default: 'message'
26
+ config_param :message_key, :string, default: 'message'.freeze
27
27
  config_param :add_newline, :bool, default: true
28
28
 
29
29
  def format(tag, time, record)
30
30
  text = record[@message_key].to_s.dup
31
- text << @newline.freeze if @add_newline
31
+ text << @newline if @add_newline
32
32
  text
33
33
  end
34
34
  end
@@ -26,13 +26,13 @@ module Fluent
26
26
  desc 'Field names included in each lines'
27
27
  config_param :keys, :array, value_type: :string
28
28
  desc 'The delimiter character (or string) of TSV values'
29
- config_param :delimiter, :string, default: "\t"
29
+ config_param :delimiter, :string, default: "\t".freeze
30
30
  desc 'The parameter to enable writing to new lines'
31
31
  config_param :add_newline, :bool, default: true
32
32
 
33
33
  def format(tag, time, record)
34
34
  formatted = @keys.map{|k| record[k].to_s }.join(@delimiter)
35
- formatted << @newline.freeze if @add_newline
35
+ formatted << @newline if @add_newline
36
36
  formatted
37
37
  end
38
38
  end
@@ -80,6 +80,8 @@ module Fluent::Plugin
80
80
  config_param :use_204_response, :bool, default: false
81
81
  desc 'Dump error log or not'
82
82
  config_param :dump_error_log, :bool, default: true
83
+ desc 'Add QUERY_ prefix query params to record'
84
+ config_param :add_query_params, :bool, default: false
83
85
 
84
86
  config_section :parse do
85
87
  config_set_default :@type, 'in_http'
@@ -277,7 +279,7 @@ module Fluent::Plugin
277
279
  private
278
280
 
279
281
  def on_server_connect(conn)
280
- handler = Handler.new(conn, @km, method(:on_request), @body_size_limit, @format_name, log, @cors_allow_origins)
282
+ handler = Handler.new(conn, @km, method(:on_request), @body_size_limit, @format_name, log, @cors_allow_origins, @add_query_params)
281
283
 
282
284
  conn.on(:data) do |data|
283
285
  handler.on_read(data)
@@ -326,6 +328,14 @@ module Fluent::Plugin
326
328
  }
327
329
  end
328
330
 
331
+ if @add_query_params
332
+ params.each_pair { |k, v|
333
+ if k.start_with?("QUERY_".freeze)
334
+ record[k] = v
335
+ end
336
+ }
337
+ end
338
+
329
339
  if @add_remote_addr
330
340
  record['REMOTE_ADDR'] = params['REMOTE_ADDR']
331
341
  end
@@ -346,7 +356,7 @@ module Fluent::Plugin
346
356
  class Handler
347
357
  attr_reader :content_type
348
358
 
349
- def initialize(io, km, callback, body_size_limit, format_name, log, cors_allow_origins)
359
+ def initialize(io, km, callback, body_size_limit, format_name, log, cors_allow_origins, add_query_params)
350
360
  @io = io
351
361
  @km = km
352
362
  @callback = callback
@@ -356,6 +366,7 @@ module Fluent::Plugin
356
366
  @log = log
357
367
  @cors_allow_origins = cors_allow_origins
358
368
  @idle = 0
369
+ @add_query_params = add_query_params
359
370
  @km.add(self)
360
371
 
361
372
  @remote_port, @remote_addr = io.remote_port, io.remote_addr
@@ -533,7 +544,17 @@ module Fluent::Plugin
533
544
  end
534
545
  path_info = uri.path
535
546
 
547
+ if (@add_query_params)
548
+
549
+ query_params = WEBrick::HTTPUtils.parse_query(uri.query)
550
+
551
+ query_params.each_pair {|k,v|
552
+ params["QUERY_#{k.gsub('-','_').upcase}"] = v
553
+ }
554
+ end
555
+
536
556
  params.merge!(@env)
557
+
537
558
  @env.clear
538
559
 
539
560
  code, header, body = @callback.call(path_info, params)
@@ -22,6 +22,7 @@ require 'fluent/event'
22
22
  require 'fluent/plugin/buffer'
23
23
  require 'fluent/plugin/parser_multiline'
24
24
  require 'fluent/variable_store'
25
+ require 'fluent/capability'
25
26
  require 'fluent/plugin/in_tail/position_file'
26
27
 
27
28
  if Fluent.windows?
@@ -104,6 +105,8 @@ module Fluent::Plugin
104
105
  config_param :ignore_repeated_permission_error, :bool, default: false
105
106
  desc 'Format path with the specified timezone'
106
107
  config_param :path_timezone, :string, default: nil
108
+ desc 'Follow inodes instead of following file names. Guarantees more stable delivery and allows to use * in path pattern with rotating files'
109
+ config_param :follow_inodes, :bool, default: false
107
110
 
108
111
  config_section :parse, required: false, multi: true, init: true, param_name: :parser_configs do
109
112
  config_argument :usage, :string, default: 'in_tail_parser'
@@ -154,6 +157,9 @@ module Fluent::Plugin
154
157
  end
155
158
  @variable_store[@pos_file] = self.plugin_id
156
159
  else
160
+ if @follow_inodes
161
+ raise Fluent::ConfigError, "Can't follow inodes without pos_file configuration parameter"
162
+ end
157
163
  $log.warn "'pos_file PATH' parameter is not set to a 'tail' source."
158
164
  $log.warn "this parameter is highly recommended to save the position to resume tailing."
159
165
  end
@@ -171,6 +177,7 @@ module Fluent::Plugin
171
177
  @dir_perm = system_config.dir_permission || Fluent::DEFAULT_DIR_PERMISSION
172
178
  # parser is already created by parser helper
173
179
  @parser = parser_create(usage: parser_config['usage'] || @parser_configs.first.usage)
180
+ @capability = Fluent::Capability.new(:current_process)
174
181
  end
175
182
 
176
183
  def configure_tag
@@ -214,7 +221,7 @@ module Fluent::Plugin
214
221
  FileUtils.mkdir_p(pos_file_dir, mode: @dir_perm) unless Dir.exist?(pos_file_dir)
215
222
  @pf_file = File.open(@pos_file, File::RDWR|File::CREAT|File::BINARY, @file_perm)
216
223
  @pf_file.sync = true
217
- @pf = PositionFile.load(@pf_file, logger: log)
224
+ @pf = PositionFile.load(@pf_file, @follow_inodes, expand_paths, logger: log)
218
225
 
219
226
  if @pos_file_compaction_interval
220
227
  timer_execute(:in_tail_refresh_compact_pos_file, @pos_file_compaction_interval) do
@@ -238,7 +245,7 @@ module Fluent::Plugin
238
245
 
239
246
  def shutdown
240
247
  # during shutdown phase, don't close io. It should be done in close after all threads are stopped. See close.
241
- stop_watchers(@tails.keys, immediate: true, remove_watcher: false)
248
+ stop_watchers(existence_path, immediate: true, remove_watcher: false)
242
249
  @pf_file.close if @pf_file
243
250
 
244
251
  super
@@ -250,6 +257,11 @@ module Fluent::Plugin
250
257
  close_watcher_handles
251
258
  end
252
259
 
260
+ def have_read_capability?
261
+ @capability.have_capability?(:effective, :dac_read_search) ||
262
+ @capability.have_capability?(:effective, :dac_override)
263
+ end
264
+
253
265
  def expand_paths
254
266
  date = Fluent::EventTime.now
255
267
  paths = []
@@ -263,7 +275,7 @@ module Fluent::Plugin
263
275
  paths += Dir.glob(path).select { |p|
264
276
  begin
265
277
  is_file = !File.directory?(p)
266
- if File.readable?(p) && is_file
278
+ if (File.readable?(p) || have_read_capability?) && is_file
267
279
  if @limit_recently_modified && File.mtime(p) < (date.to_time - @limit_recently_modified)
268
280
  false
269
281
  else
@@ -296,7 +308,31 @@ module Fluent::Plugin
296
308
  end
297
309
  path.include?('*') ? Dir.glob(path) : path
298
310
  }.flatten.uniq
299
- paths.uniq - excluded
311
+ # filter out non existing files, so in case pattern is without '*' we don't do unnecessary work
312
+ hash = {}
313
+ (paths - excluded).select { |path|
314
+ FileTest.exist?(path)
315
+ }.each { |path|
316
+ target_info = TargetInfo.new(path, Fluent::FileWrapper.stat(path).ino)
317
+ if @follow_inodes
318
+ hash[target_info.ino] = target_info
319
+ else
320
+ hash[target_info.path] = target_info
321
+ end
322
+ }
323
+ hash
324
+ end
325
+
326
+ def existence_path
327
+ hash = {}
328
+ @tails.each_key {|target_info|
329
+ if @follow_inodes
330
+ hash[target_info.ino] = target_info
331
+ else
332
+ hash[target_info.path] = target_info
333
+ end
334
+ }
335
+ hash
300
336
  end
301
337
 
302
338
  # in_tail with '*' path doesn't check rotation file equality at refresh phase.
@@ -305,21 +341,21 @@ module Fluent::Plugin
305
341
  # In such case, you should separate log directory and specify two paths in path parameter.
306
342
  # e.g. path /path/to/dir/*,/path/to/rotated_logs/target_file
307
343
  def refresh_watchers
308
- target_paths = expand_paths
309
- existence_paths = @tails.keys
344
+ target_paths_hash = expand_paths
345
+ existence_paths_hash = existence_path
310
346
 
311
347
  log.debug { "tailing paths: target = #{target_paths.join(",")} | existing = #{existence_paths.join(",")}" }
312
348
 
313
- unwatched = existence_paths - target_paths
314
- added = target_paths - existence_paths
349
+ unwatched_hash = existence_paths_hash.reject {|key, value| target_paths_hash.key?(key)}
350
+ added_hash = target_paths_hash.reject {|key, value| existence_paths_hash.key?(key)}
315
351
 
316
- stop_watchers(unwatched, immediate: false, unwatched: true) unless unwatched.empty?
317
- start_watchers(added) unless added.empty?
352
+ stop_watchers(unwatched_hash, immediate: false, unwatched: true) unless unwatched_hash.empty?
353
+ start_watchers(added_hash) unless added_hash.empty?
318
354
  end
319
355
 
320
- def setup_watcher(path, pe)
356
+ def setup_watcher(target_info, pe)
321
357
  line_buffer_timer_flusher = @multiline_mode ? TailWatcher::LineBufferTimerFlusher.new(log, @multiline_flush_interval, &method(:flush_buffer)) : nil
322
- tw = TailWatcher.new(path, pe, log, @read_from_head, method(:update_watcher), line_buffer_timer_flusher, method(:io_handler))
358
+ tw = TailWatcher.new(target_info, pe, log, @read_from_head, @follow_inodes, method(:update_watcher), line_buffer_timer_flusher, method(:io_handler))
323
359
 
324
360
  if @enable_watch_timer
325
361
  tt = TimerTrigger.new(1, log) { tw.on_notify }
@@ -350,47 +386,52 @@ module Fluent::Plugin
350
386
  raise e
351
387
  end
352
388
 
353
- def start_watchers(paths)
354
- paths.each { |path|
389
+ def start_watchers(targets_info)
390
+ targets_info.each_value { |target_info|
355
391
  pe = nil
356
392
  if @pf
357
- pe = @pf[path]
393
+ pe = @pf[target_info]
358
394
  if @read_from_head && pe.read_inode.zero?
359
395
  begin
360
- pe.update(Fluent::FileWrapper.stat(path).ino, 0)
396
+ pe.update(Fluent::FileWrapper.stat(target_info.path).ino, 0)
361
397
  rescue Errno::ENOENT
362
- $log.warn "#{path} not found. Continuing without tailing it."
398
+ $log.warn "#{target_info.path} not found. Continuing without tailing it."
363
399
  end
364
400
  end
365
401
  end
366
402
 
367
403
  begin
368
- tw = setup_watcher(path, pe)
404
+ tw = setup_watcher(target_info, pe)
369
405
  rescue WatcherSetupError => e
370
- log.warn "Skip #{path} because unexpected setup error happens: #{e}"
406
+ log.warn "Skip #{target_info.path} because unexpected setup error happens: #{e}"
371
407
  next
372
408
  end
373
- @tails[path] = tw
409
+ target_info = TargetInfo.new(target_info.path, Fluent::FileWrapper.stat(target_info.path).ino)
410
+ @tails[target_info] = tw
374
411
  }
375
412
  end
376
413
 
377
- def stop_watchers(paths, immediate: false, unwatched: false, remove_watcher: true)
378
- paths.each { |path|
379
- tw = remove_watcher ? @tails.delete(path) : @tails[path]
414
+ def stop_watchers(targets_info, immediate: false, unwatched: false, remove_watcher: true)
415
+ targets_info.each_value { |target_info|
416
+ if remove_watcher
417
+ tw = @tails.delete(target_info)
418
+ else
419
+ tw = @tails[target_info]
420
+ end
380
421
  if tw
381
422
  tw.unwatched = unwatched
382
423
  if immediate
383
- detach_watcher(tw, false)
424
+ detach_watcher(tw, target_info.ino, false)
384
425
  else
385
- detach_watcher_after_rotate_wait(tw)
426
+ detach_watcher_after_rotate_wait(tw, target_info.ino)
386
427
  end
387
428
  end
388
429
  }
389
430
  end
390
431
 
391
432
  def close_watcher_handles
392
- @tails.keys.each do |path|
393
- tw = @tails.delete(path)
433
+ @tails.keys.each do |target_info|
434
+ tw = @tails.delete(target_info)
394
435
  if tw
395
436
  tw.close
396
437
  end
@@ -398,25 +439,39 @@ module Fluent::Plugin
398
439
  end
399
440
 
400
441
  # refresh_watchers calls @tails.keys so we don't use stop_watcher -> start_watcher sequence for safety.
401
- def update_watcher(path, pe)
402
- log.info("detected rotation of #{path}; waiting #{@rotate_wait} seconds")
442
+ def update_watcher(target_info, pe)
443
+ log.info("detected rotation of #{target_info.path}; waiting #{@rotate_wait} seconds")
403
444
 
404
445
  if @pf
405
- unless pe.read_inode == @pf[path].read_inode
446
+ pe_inode = pe.read_inode
447
+ target_info_from_position_entry = TargetInfo.new(target_info.path, pe_inode)
448
+ unless pe_inode == @pf[target_info_from_position_entry].read_inode
406
449
  log.debug "Skip update_watcher because watcher has been already updated by other inotify event"
407
450
  return
408
451
  end
409
452
  end
410
- rotated_tw = @tails[path]
411
- @tails[path] = setup_watcher(path, pe)
412
- detach_watcher_after_rotate_wait(rotated_tw) if rotated_tw
453
+
454
+ rotated_target_info = TargetInfo.new(target_info.path, pe.read_inode)
455
+ rotated_tw = @tails[rotated_target_info]
456
+ new_target_info = target_info.dup
457
+
458
+ if @follow_inodes
459
+ new_position_entry = @pf[target_info]
460
+
461
+ if new_position_entry.read_inode == 0
462
+ @tails[new_target_info] = setup_watcher(new_target_info, new_position_entry)
463
+ end
464
+ else
465
+ @tails[new_target_info] = setup_watcher(new_target_info, pe)
466
+ end
467
+ detach_watcher_after_rotate_wait(rotated_tw, pe.read_inode) if rotated_tw
413
468
  end
414
469
 
415
470
  # TailWatcher#close is called by another thread at shutdown phase.
416
471
  # It causes 'can't modify string; temporarily locked' error in IOHandler
417
472
  # so adding close_io argument to avoid this problem.
418
473
  # At shutdown, IOHandler's io will be released automatically after detached the event loop
419
- def detach_watcher(tw, close_io = true)
474
+ def detach_watcher(tw, ino, close_io = true)
420
475
  tw.watchers.each do |watcher|
421
476
  event_loop_detach(watcher)
422
477
  end
@@ -425,15 +480,16 @@ module Fluent::Plugin
425
480
  tw.close if close_io
426
481
 
427
482
  if tw.unwatched && @pf
428
- @pf.unwatch(tw.path)
483
+ target_info = TargetInfo.new(tw.path, ino)
484
+ @pf.unwatch(target_info)
429
485
  end
430
486
  end
431
487
 
432
- def detach_watcher_after_rotate_wait(tw)
488
+ def detach_watcher_after_rotate_wait(tw, ino)
433
489
  # Call event_loop_attach/event_loop_detach is high-cost for short-live object.
434
490
  # If this has a problem with large number of files, use @_event_loop directly instead of timer_execute.
435
491
  timer_execute(:in_tail_close_watcher, @rotate_wait, repeat: false) do
436
- detach_watcher(tw)
492
+ detach_watcher(tw, ino)
437
493
  end
438
494
  end
439
495
 
@@ -601,10 +657,12 @@ module Fluent::Plugin
601
657
  end
602
658
 
603
659
  class TailWatcher
604
- def initialize(path, pe, log, read_from_head, update_watcher, line_buffer_timer_flusher, io_handler_build)
605
- @path = path
660
+ def initialize(target_info, pe, log, read_from_head, follow_inodes, update_watcher, line_buffer_timer_flusher, io_handler_build)
661
+ @path = target_info.path
662
+ @ino = target_info.ino
606
663
  @pe = pe || MemoryPositionEntry.new
607
664
  @read_from_head = read_from_head
665
+ @follow_inodes = follow_inodes
608
666
  @update_watcher = update_watcher
609
667
  @log = log
610
668
  @rotate_handler = RotateHandler.new(log, &method(:on_rotate))
@@ -614,7 +672,7 @@ module Fluent::Plugin
614
672
  @watchers = []
615
673
  end
616
674
 
617
- attr_reader :path
675
+ attr_reader :path, :ino
618
676
  attr_reader :pe
619
677
  attr_reader :line_buffer_timer_flusher
620
678
  attr_accessor :unwatched # This is used for removing position entry from PositionFile
@@ -709,7 +767,17 @@ module Fluent::Plugin
709
767
  end
710
768
 
711
769
  if watcher_needs_update
712
- @update_watcher.call(@path, swap_state(@pe))
770
+ # No need to update a watcher if stat is nil (file not present), because moving to inodes will create
771
+ # new watcher, and old watcher will be closed by stop_watcher in refresh_watchers method
772
+ if stat
773
+ target_info = TargetInfo.new(@path, stat.ino)
774
+ if @follow_inodes
775
+ # don't want to swap state because we need latest read offset in pos file even after rotate_wait
776
+ @update_watcher.call(target_info, @pe)
777
+ else
778
+ @update_watcher.call(target_info, swap_state(@pe))
779
+ end
780
+ end
713
781
  else
714
782
  @log.info "detected rotation of #{@path}"
715
783
  @io_handler = io_handler