add comment for the intention of warning

Signed-off-by: Daijiro Fukuda <[email protected]>
fluent · Jan 27, 2023 · 0807567 · 0807567
1 parent 63e1418
commit 0807567
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/lib/fluent/plugin/buf_file.rb b/lib/fluent/plugin/buf_file.rb
@@ -146,6 +146,8 @@ def resume
           next unless File.file?(path)
 
           if owner.respond_to?(:buffer_config) && owner.buffer_config&.flush_at_shutdown
+            # When `flush_at_shutdown` is `true`, the remaining chunk files during resuming are possibly broken
+            # since there may be a power failure or similar failure.
             log.warn { "restoring buffer file: path = #{path}" }
           else
             log.debug { "restoring buffer file: path = #{path}" }

diff --git a/lib/fluent/plugin/buf_file_single.rb b/lib/fluent/plugin/buf_file_single.rb
@@ -167,6 +167,8 @@ def resume
           next unless File.file?(path)
 
           if owner.respond_to?(:buffer_config) && owner.buffer_config&.flush_at_shutdown
+            # When `flush_at_shutdown` is `true`, the remaining chunk files during resuming are possibly broken
+            # since there may be a power failure or similar failure.
             log.warn { "restoring buffer file: path = #{path}" }
           else
             log.debug { "restoring buffer file: path = #{path}" }