improve log messages

Signed-off-by: Daijiro Fukuda <[email protected]>

Author: daipom

README.md

@@ -167,8 +167,8 @@ $ tailcheck --follow_inodes /var/log/td-agent/pos/secure
 
 ```
 Check /path/to/pos.
-Checked duplicated pos for 2 PosEntries.
-Checked collection ratio of 2 files.
+Done duplication check for 2 PosEntries.
+Done collection ratio check for 2 files.
 
 All check completed.
 There is no anomalies.
@@ -177,40 +177,40 @@ There is no anomalies.
 This means:
 
 * The command has checked `/path/to/pos`.
-* The command has checked 2 entries for duplication check.
+* The command has checked 2 pos entries for duplication check.
 * The command has checked 2 files for collection ratio check.
 * There is no anomalies.
 
 #### Pos duplication found
 
 ```
 Check /path/to/pos.
-Checked duplicated pos for 3 PosEntries.
-Duplicated PosEntries are found. This is a known log loss issue that was fixed in Fluentd v1.16.3.
-Duplicated keys:
+Done duplication check for 3 PosEntries.
+Duplicated PosEntries are found. This is a known log missing issue that was fixed in Fluentd v1.16.3 (fluent-package v5.0.2, td-agent v4.5.2). If you are using any version older than these, updating Fluentd will resolve the issue.
+Duplicated paths:
   /test/foo.log
-Checked collection ratio of 0 files.
+Done collection ratio check for 0 files.
 
 All check completed.
 Some anomalies are found. Please check whether there is any log loss.
 ```
 
-In this case, some keys of the pos entries are duplicated.
+In this case, some the pos entries are duplicated.
 It is a known log missing issue that was fixed in Fluentd v1.16.3.
 
 > * https://github.com/fluent/fluentd/issues/3614
 >   * In case `follow_inodes false` (default setting), collection of a file may stop and continue to stop after log rotation.
 >   * Fixed since Fluentd v1.16.3 (fluent-package v5.0.2, td-agent v4.5.2).
 
-So, you should check whether there is any log missing, and consider updating, especially, if your version is before Fluentd v1.16.3 (fluent-package v5.0.2, td-agent v4.5.2).
+So, you should check whether there is any log missing, and consider updating Fluentd, especially, if you are using any version older than Fluentd v1.16.3 (fluent-package v5.0.2, td-agent v4.5.2).
 
 #### Too low collection ratio file found
 
 ```
 Check /path/to/pos.
-Checked duplicated pos for 2 PosEntries.
-Checked collection ratio of 2 files.
-Collection ratio of some files are too low. Collection of those files may have stopped or may not be keeping up.
+Done duplication check for 2 PosEntries.
+Done collection ratio check for 2 files.
+Collection ratio of some files are too low. Collection of those files may not be keeping up. Or it may have stopped with some anomalies. This can be a known log missing issue of the follow_inodes feature that was fixed in Fluentd v1.16.2 (fluent-package v5.0.0, td-agent v4.5.1). If you are using any version older than these, updating Fluentd will resolve the issue.
 Filepaths with too low collection ratio (threshold: 0.8):
   /test/bar.log (ratio: 0.7)
   /test/foo.log (ratio: 0.7)
@@ -234,8 +234,7 @@ Especially, if the `in_tail` uses [follow_inodes](https://docs.fluentd.org/input
 >   * In case `follow_inodes true`, collection of a file may stop and continue to stop after log rotation.
 >   * Fixed since Fluentd v1.16.2 (fluent-package v5.0.0, td-agent v4.5.1).
 
-If this issue is occurring, this too low collection ratio is detected.
-In that case, please consider updating if your version is before Fluentd v1.16.2 (td-agent v4.5.1).
+Please consider updating Fluentd if you are using any version older than Fluentd v1.16.2 (td-agent v4.5.1).
 
 ## Development
 

lib/fluent/tail_checker/collection_ratio_checker.rb

@@ -54,7 +54,7 @@ def check
           end
         end
 
-        puts "Checked collection ratio of #{checked_file_counts} files."
+        puts "Done collection ratio check for #{checked_file_counts} files."
 
         if unacceptable_collection_ratio_found
           log_issue(unacceptable_collection_ratio_path_and_ratio_list)
@@ -96,9 +96,10 @@ def collection_ratio(pos, file_size)
       end
 
       def log_issue(path_and_ratio_list)
-        puts "Collection ratio of some files are too low. Collection of those files may have stopped or may not be keeping up."
         if @follow_inodes
-          puts "This can be a known log loss issue of the follow_inodes feature that was fixed in Fluentd v1.16.2."
+          puts "Collection ratio of some files are too low. Collection of those files may not be keeping up. Or it may have stopped with some anomalies. This can be a known log missing issue of the follow_inodes feature that was fixed in Fluentd v1.16.2 (fluent-package v5.0.0, td-agent v4.5.1). If you are using any version older than these, updating Fluentd will resolve the issue."
+        else
+          puts "Collection ratio of some files are too low. Collection of those files may not be keeping up. Or it may have stopped with some anomalies. It is recommended to verify whether there is any log missing."
         end
 
         puts "Filepaths with too low collection ratio (threshold: #{@collection_ratio_threshold}):"

lib/fluent/tail_checker/duplicated_pos_checker.rb

@@ -40,7 +40,7 @@ def check
           duplicated_key_set.add(key)
         end
 
-        puts "Checked duplicated pos for #{checked_key_counts} PosEntries."
+        puts "Done duplication check for #{checked_key_counts} PosEntries."
 
         if duplicated_key_found
           log_issue(duplicated_key_set)
@@ -52,12 +52,13 @@ def check
 
       def log_issue(duplicated_keys)
         if @follow_inodes
-          puts "Duplicated PosEntries are found with follow_inodes. Unknown anomalies may be occurring."
+          puts "Duplicated PosEntries are found. Unknown anomalies may be occurring. It is recommended to verify whether there is any log missing."
+          puts "Duplicated inodes:"
         else
-          puts "Duplicated PosEntries are found. This is a known log loss issue that was fixed in Fluentd v1.16.3."
+          puts "Duplicated PosEntries are found. This is a known log missing issue that was fixed in Fluentd v1.16.3 (fluent-package v5.0.2, td-agent v4.5.2). If you are using any version older than these, updating Fluentd will resolve the issue."
+          puts "Duplicated paths:"
         end
 
-        puts "Duplicated keys:"
         duplicated_keys.each do |key|
           puts "  #{key}"
         end

lib/fluent/tail_checker/tail_check.rb

@@ -42,8 +42,10 @@ def parse_command_line(argv)
           Example: tailcheck /path/to/pos1 /path/to/pos2
           Example: tailcheck /path/to/pos/*
           Example: tailcheck --follow_inodes /path/to/pos_with_follow_inodes
-          Options:
 
+          If you have any issues with this command, please report it to https://github.com/clear-code/fluent-tail_checker/issues.
+
+          Options:
         BANNER
 
         parser.on("--follow_inodes", "Check the specified pos files with the condition that the follow_inodes feature is enabled.", "Default: Disabled") do
@@ -86,8 +88,11 @@ def check
         puts "\nAll check completed."
 
         unless succeeded
-          puts "Some anomalies are found. Please check whether there is any log loss."
-          # TODO add message about how to concact the community or us.
+          puts "Some anomalies are found. Please check the logs for details."
+          puts "If you have any questions or issues, please report them to the following:"
+          puts "  Fluentd Q&A: https://github.com/fluent/fluentd/discussions/categories/q-a"
+          puts "  Fluentd Q&A (日本語用): https://github.com/fluent/fluentd/discussions/categories/q-a-japanese"
+          puts "  About this command (日本語可): https://github.com/clear-code/fluent-tail_checker/issues"
           return false
         end