fluent-tail_checker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f6815f8029fdd412fe073361546d200a886729088305f04e87ab83f5ba32ab9
+  data.tar.gz: ccd920168a451237625ecb0755843fd34e2f3452ad88e449338d6fc8ecabfc9f
+SHA512:
+  metadata.gz: f359eeef93a869b30b462e2fa60b60003ce67380ade85649f0fe615c70e0e21cbe493cbf735adf19fa7ab8538d82a5cdf052d14adb2d0a1b6cbdfb11212609a9
+  data.tar.gz: 6c3d3a469fd22139833c64d3f179a999c2b6cdb88dc6269f9067b6bbcefb3deaceea62f0c5ba0d792085500c1f353b480c198e0b68af9943893b3c0a966140ee

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,118 @@
+# fluent-tailcheck
+
+`fluent-tailcheck` is a command for [Fluentd](https://www.fluentd.org/).
+
+This command checks whether [in_tail](https://docs.fluentd.org/input/tail) plugin is collecting logs properly.
+For example, this command verifies whether a known critical log missing issue is occurring.
+
+Known critical log missing issues:
+
+* 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).
+* https://github.com/fluent/fluentd/issues/4190
+  * 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).
+
+This command allows you to check whether these issues are occurring on your Fluentd.
+
+## Requirements
+
+| fluent-tailcheck | fluentd | td-agent | fluent-package |
+|------------------|---------|----------|----------------|
+| all versions     | >= v1.0 | >= 3.1.1 | >= 5.0.0       |
+
+## Installation
+
+* [fluent-package](doc/installation.md#fluent-package)
+* [td-agent v4](doc/installation.md#td-agent-v4)
+* [td-agent v3](doc/installation.md#td-agent-v3)
+* [Your Ruby environment](doc/installation.md#your-ruby-environment)
+
+## Usage
+
+### Help
+
+```console
+$ fluent-tailcheck --help
+```
+
+### Version
+
+```console
+$ fluent-tailcheck --version
+```
+
+### Check pos files
+
+You can specify a path of a pos file to check:
+
+```console
+$ fluent-tailcheck /var/log/td-agent/pos/secure
+```
+
+You can specify multiple paths:
+
+```console
+$ fluent-tailcheck /var/log/td-agent/pos/secure /var/log/td-agent/pos/message
+```
+
+You can use wildcards:
+
+```console
+$ fluent-tailcheck /var/log/td-agent/pos/*
+```
+
+If you use [follow_inodes](https://docs.fluentd.org/input/tail#follow_inodes), then you must specify `--follow-inodes` option.
+(If you have both settings that use `follow_inodes` and those that do not, please run the command separately.)
+
+```console
+$ fluent-tailcheck --follow-inodes /var/log/td-agent/pos/secure
+```
+
+You can change the minimum ratio of collection of each target log file by specify `--ratio DECIMAL`.
+By default (`0.5`), the command detects log files that have not been collected up to 50% of the filesize.
+Please see [Collection ratio check](doc/feature.md#collection-ratio-check) for details.
+
+```
+$ fluent-tailcheck --ratio 0.7 /var/log/td-agent/pos/secure
+```
+
+### Permission
+
+`fluent-tailcheck` requires read permission to the specified pos files and the target log files.
+
+Please use `sudo` (on Linux-like) or a terminal with administrative privileges (on Windows).
+
+```console
+$ sudo fluent-tailcheck /var/log/td-agent/pos/secure
+```
+
+### Automation
+
+It would be a good idea to run this command periodically to make sure `in_tail` works properly.
+
+If any anomaly is detected, the command exits with an error (with a non-zero status).
+You can use the exit code for the automation.
+
+### Result examples
+
+* [Result examples](doc/result-examples.md)
+
+## Feature
+
+* [Feature](doc/feature.md)
+
+## Development
+
+* [Development](doc/development.md)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/clear-code/fluent-tail_checker.
+
+## Copyright
+
+* Copyright 2025 Daijiro Fukuda
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/Vagrantfile

@@ -0,0 +1,48 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  vms = [
+    {
+      :id => "ubuntu-xenial",
+      :box => "bento/ubuntu-16.04",
+    },
+    {
+      :id => "ubuntu-focal",
+      :box => "bento/ubuntu-20.04",
+    },
+    {
+      :id => "ubuntu-jammy",
+      :box => "bento/ubuntu-22.04",
+    },
+    {
+      :id => "centos-7",
+      :box => "bento/centos-7",
+    },
+    {
+      :id => "rockylinux-8",
+      :box => "bento/rockylinux-8",
+    },
+    {
+      :id => "almalinux-9",
+      :box => "bento/almalinux-9",
+    },
+  ]
+
+  n_cpus = ENV["BOX_N_CPUS"]&.to_i || 2
+  memory = ENV["BOX_MEMORY"]&.to_i || 2048
+  vms.each_with_index do |vm, idx|
+    id = vm[:id]
+    box = vm[:box] || id
+    config.vm.define(id) do |node|
+      node.vm.box = box
+      node.vm.provider("virtualbox") do |virtual_box|
+        virtual_box.cpus = n_cpus if n_cpus
+        virtual_box.memory = memory if memory
+      end
+    end
+  end
+end

data/doc/development.md

@@ -0,0 +1,41 @@
+# Development
+
+## Quick start
+
+```console
+$ bundle
+$ bundle exec exe/fluent-tailcheck --version
+$ bundle exec exe/fluent-tailcheck --help
+$ bundle exec exe/fluent-tailcheck test/data/pos_duplicate_unwatched_path
+```
+
+## Unit test
+
+```console
+$ bundle exec rake test
+```
+
+## Package test
+
+Need `Vagrant`.
+
+```console
+$ vagrant status
+$ vagrant up {id}
+$ vagrant snapshot save {id} init
+$ vagrant ssh {id} -- /vagrant/test/script/{test-script}
+$ vagrant snapshot restore {id} init
+```
+
+Example:
+
+```console
+$ vagrant up centos-7
+$ vagrant snapshot save centos-7 init
+$ vagrant ssh centos-7 -- /vagrant/test/script/td-agent-v3.1.1.el7-test.bash
+$ vagrant snapshot restore centos-7 init
+```
+
+## Install and release
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/doc/feature.md

@@ -0,0 +1,50 @@
+# Feature
+
+`fluent-tailcheck` performs the following checks on the specified pos file.
+
+* [Duplication check](#duplication-check)
+* [Collection ratio check](#collection-ratio-check)
+
+## Duplication check
+
+`fluent-tailcheck` checks whether there is any dulication in the specified pos files.
+
+The keys of watching pos entries in one pos file must be unique.
+
+By default, the key is the path of the target log file.
+When using [follow_inodes](https://docs.fluentd.org/input/tail#follow_inodes), the key is the inode.
+
+If duplication occurs, it means some anomalies occurs in that `in_tail`.
+Especially, the following log missing issue causes this duplication.
+
+> * 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).
+
+## Collection ratio check
+
+`fluent-tailcheck` checks collection ratio of each watching pos entry.
+
+By default, `fluent-tailcheck` detects log files that have not been collected up to 50% of the filesize.
+You can change this threshold by `--ratio` option.
+
+If this it too low, collection of those files may not be keeping up.
+Or it may have stopped with some anomalies.
+
+Especially, if the `in_tail` uses [follow_inodes](https://docs.fluentd.org/input/tail#follow_inodes), there is a known log missing issue that was fixed in Fluentd v1.16.2.
+
+> * https://github.com/fluent/fluentd/issues/4190
+>   * 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).
+
+### Limitation
+
+`fluent-tailcheck` checks the sizes of logfiles based on the paths recorded in the pos files (except already unwatched pos entries).
+
+However, if using `--follow-inodes`, there is a restriction on which files can be checked.
+If using `--follow-inodes`, it is possible that `fluent-tailcheck` can not check the already rotated logfiles even if they are recorded in the pos files and are not unwatched yet.
+Since the path recorded in the pos file is not updated after log rotation, the current path and inode may differ.
+`fluent-tailcheck` checks only log files whose path and inode in the pos file match.
+At least, it can check the current log files.
+
+If not using `--follow-inodes`, this limitation does not exist.

data/doc/installation.md

@@ -0,0 +1,100 @@
+# Installation
+
+## fluent-package
+
+### RPM/DEB (Linux)
+
+```console
+$ sudo fluent-gem install fluent-tail_checker
+```
+
+Then, you can use the command as follows.
+
+```console
+$ /opt/fluent/bin/fluent-tailcheck --help
+```
+
+### .msi (Windows)
+
+`Fluent Package Command Prompt` with Administrator privilege:
+
+```console
+$ fluent-gem install fluent-tail_checker
+```
+
+Then, you can use the command as follows.
+
+```console
+$ fluent-tailcheck --help
+```
+
+## td-agent v4
+
+### RPM/DEB (Linux)
+
+```console
+$ sudo td-agent-gem install fluent-tail_checker
+```
+
+Then, you can use the command as follows.
+
+```console
+$ /opt/td-agent/bin/fluent-tailcheck --help
+```
+
+### .msi (Windows)
+
+`Td-agent Command Prompt` with Administrator privilege:
+
+```console
+$ td-agent-gem install fluent-tail_checker
+```
+
+Then, you can use the command as follows.
+
+```console
+$ fluent-tailcheck --help
+```
+
+## td-agent v3
+
+### RPM/DEB (Linux)
+
+```console
+$ sudo td-agent-gem install fluent-tail_checker --bindir /opt/td-agent/embedded/bin
+```
+
+Then, you can use the command as follows.
+
+```console
+$ /opt/td-agent/embedded/bin/fluent-tailcheck --help
+```
+
+Note: On td-agent v3, you need to specify `--bindir /opt/td-agent/embedded/bin` to install the executable under `/opt/td-agent/embedded/bin`.
+Without this, the executable will be installed under `/opt/td-agent/embedded/lib/ruby/gems/2.4.0/bin/`.
+
+### .msi (Windows)
+
+`Td-agent Command Prompt` with Administrator privilege:
+
+```console
+$ fluent-gem install fluent-tail_checker
+```
+
+Then, you can use the command as follows.
+
+```console
+$ fluent-tailcheck --help
+```
+
+## Your Ruby environment
+
+```console
+$ gem install fluent-tail_checker
+```
+
+Then, you can use the command as follows.
+
+```console
+$ fluent-tailcheck --help
+```

data/doc/result-examples.md

@@ -0,0 +1,85 @@
+# Result examples
+
+## No anomalies found
+
+```
+Check /path/to/pos.
+Done duplication check for 2 PosEntries.
+Done collection ratio check for 2 files.
+
+All check completed. (Fluentd v1.15.0)
+There is no anomalies.
+```
+
+This means:
+
+* The command has checked `/path/to/pos`.
+* The command has checked 2 pos entries for duplication check.
+* The command has checked 2 files for collection ratio check.
+* It is detected that the version of your Fluentd is v1.15.0.
+* There is no anomalies.
+
+## Pos duplication found
+
+```
+Check /path/to/pos.
+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
+Done collection ratio check for 0 files.
+
+All check completed. (Fluentd v1.15.0)
+Some anomalies are found. Please check the logs for details.
+
+If you have any questions or issues, please report them to the following:
+  Fluentd Q&A: https://github.com/fluent/fluentd/discussions/categories/q-a
+  Fluentd Q&A (日本語用): https://github.com/fluent/fluentd/discussions/categories/q-a-japanese
+  About this command (日本語可): https://github.com/clear-code/fluent-tail_checker/issues
+```
+
+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 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.
+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.5):
+  /test/bar.log (ratio: 0.2)
+  /test/foo.log (ratio: 0.1)
+
+All check completed. (Fluentd v1.15.0)
+Some anomalies are found. Please check the logs for details.
+
+If you have any questions or issues, please report them to the following:
+  Fluentd Q&A: https://github.com/fluent/fluentd/discussions/categories/q-a
+  Fluentd Q&A (日本語用): https://github.com/fluent/fluentd/discussions/categories/q-a-japanese
+  About this command (日本語可): https://github.com/clear-code/fluent-tail_checker/issues
+```
+
+In this case, collection ratio of some target files are too low.
+Collection of those files may have stopped or may not be keeping up.
+
+> /test/bar.log (ratio: 0.2)
+
+This means that only 20% of the data of the file is collected for the filesize.
+If it is not keeping up temporarily, then it is no problem.
+If this is always the case, or if collection has stopped completely, then log missing may occur.
+
+Especially, if the `in_tail` uses [follow_inodes](https://docs.fluentd.org/input/tail#follow_inodes), there is a known log missing issue that was fixed in Fluentd v1.16.2.
+
+> * https://github.com/fluent/fluentd/issues/4190
+>   * 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).
+
+Please consider updating Fluentd if you are using any version older than Fluentd v1.16.2 (td-agent v4.5.1).

data/exe/fluent-tailcheck

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "fluent/tail_checker"
+
+command = Fluent::TailChecker::TailCheck.new
+exit(command.run)

data/lib/fluent/tail_checker/collection_ratio_checker.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Daijiro Fukuda
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "fluent/env"
+
+# For compatibility with Fluentd v1.15.2 and earlier.
+# See https://github.com/fluent/fluentd/pull/3883
+begin
+  require "fluent/file_wrapper"
+rescue LoadError
+  if Fluent.windows?
+    require "fluent/plugin/file_wrapper"
+  else
+    Fluent::FileWrapper = File
+  end
+end
+
+module Fluent
+  module TailChecker
+    class CollectionRatioChecker
+      def initialize(posfile, follow_inodes, collection_ratio_threshold)
+        @posfile = posfile
+        @follow_inodes = follow_inodes
+        @collection_ratio_threshold = collection_ratio_threshold
+      end
+
+      def check
+        unacceptable_collection_ratio_found = false
+        unacceptable_collection_ratio_path_and_ratio_list = []
+        checked_file_counts = 0
+
+        @posfile.watching_entries.each do |entry|
+          size = get_file_size(entry)
+          next if size.nil?
+
+          checked_file_counts += 1
+          ratio = collection_ratio(entry.pos, size)
+          if ratio < @collection_ratio_threshold
+            unacceptable_collection_ratio_found = true
+            unacceptable_collection_ratio_path_and_ratio_list.push([entry.path, ratio])
+          end
+        end
+
+        puts "Done collection ratio check for #{checked_file_counts} files."
+
+        if unacceptable_collection_ratio_found
+          log_issue(unacceptable_collection_ratio_path_and_ratio_list)
+          return false
+        end
+
+        true
+      end
+
+      def get_file_size(pos_entry)
+        if @follow_inodes
+          get_file_size_from_inode(pos_entry)
+        else
+          get_file_size_from_path(pos_entry)
+        end
+      end
+
+      def get_file_size_from_path(pos_entry)
+        size = FileTest.size?(pos_entry.path)
+        unless size
+          $stderr.puts "Skip #{pos_entry.path} because it is not found. Make sure you have the proper privilege, e.g. 'sudo'."
+        end
+        size
+      end
+
+      def get_file_size_from_inode(pos_entry)
+        unless FileTest.exist?(pos_entry.path)
+          $stderr.puts "Skip #{pos_entry.path} because it is not found. Make sure you have the proper privilege, e.g. 'sudo'."
+          return nil
+        end
+
+        stat = Fluent::FileWrapper.stat(pos_entry.path)
+        # If follow_inodes is enabled, the inode of the current logfile should match the inode in the pos_file.
+        # It may not match for the rotated logfiles because the path info in the pos_file is not updated.
+        # So, at least, check the current logfile.
+        # For rotated logfiles, check them if inode matches.
+        return nil unless stat.ino == pos_entry.ino
+
+        stat.size
+      end
+
+      def collection_ratio(pos, file_size)
+        return 1.0 if file_size == 0
+
+        pos.to_f / file_size
+      end
+
+      def log_issue(path_and_ratio_list)
+        if @follow_inodes
+          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}):"
+        path_and_ratio_list.each do |path, ratio|
+          puts "  #{path} (ratio: #{ratio})"
+        end
+      end
+    end
+  end
+end

data/lib/fluent/tail_checker/duplicated_pos_checker.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Daijiro Fukuda
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "set"
+
+module Fluent
+  module TailChecker
+    class DuplicatedPosChecker
+      def initialize(posfile, follow_inodes)
+        @posfile = posfile
+        @follow_inodes = follow_inodes
+      end
+
+      def check
+        duplicated_key_found = false
+        key_set = Set.new
+        duplicated_key_set = Set.new
+        checked_key_counts = 0
+
+        @posfile.watching_entries.map do |entry|
+          @follow_inodes ? entry.ino : entry.path
+        end.each do |key|
+          checked_key_counts += 1
+          next if key_set.add?(key)
+
+          duplicated_key_found = true
+          duplicated_key_set.add(key)
+        end
+
+        puts "Done duplication check for #{checked_key_counts} PosEntries."
+
+        if duplicated_key_found
+          log_issue(duplicated_key_set)
+          return false
+        end
+
+        true
+      end
+
+      def log_issue(duplicated_keys)
+        if @follow_inodes
+          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 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
+
+        duplicated_keys.each do |key|
+          puts "  #{key}"
+        end
+      end
+    end
+  end
+end

data/lib/fluent/tail_checker/pos.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Daijiro Fukuda
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Fluent
+  module TailChecker
+    UNWATCHED_POSITION = 0xffffffffffffffff
+    POSITION_FILE_ENTRY_REGEX = /^([^\t]+)\t([0-9a-fA-F]+)\t([0-9a-fA-F]+)/
+
+    class PosFile
+      attr_reader :entries
+
+      def initialize(entries)
+        @entries = entries
+      end
+
+      def self.load(path)
+        PosFile.new(PosFile.load_entries(path))
+      end
+
+      def self.load_entries(path)
+        entries = []
+
+        File.open(path, File::RDONLY|File::BINARY) do |file|
+          file.each_line do |line|
+            m = POSITION_FILE_ENTRY_REGEX.match(line)
+            next if m.nil?
+
+            entries << PosEntry.new(
+              m[1],
+              m[2].to_i(16),
+              m[3].to_i(16),
+            )
+          end
+        end
+
+        entries
+      end
+
+      def watching_entries
+        entries.select do |entry|
+          not entry.unwatched?
+        end
+      end
+    end
+
+    class PosEntry
+      attr_reader :path, :pos, :ino
+
+      def initialize(path, pos, ino)
+        @path = path
+        @pos = pos
+        @ino = ino
+      end
+
+      def unwatched?
+        @pos == UNWATCHED_POSITION
+      end
+    end
+  end
+end

data/lib/fluent/tail_checker/tail_check.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Daijiro Fukuda
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "optparse"
+require "fluent/version"
+
+require_relative "pos"
+require_relative "duplicated_pos_checker"
+require_relative "collection_ratio_checker"
+
+module Fluent
+  module TailChecker
+    class TailCheck
+      def initialize
+        @pos_filepaths = []
+        @follow_inodes = false
+        @collection_ratio_threshold = 0.5
+      end
+
+      def run(argv=ARGV)
+        parse_command_line(argv)
+        @pos_filepaths = validate_paths(@pos_filepaths).to_a
+        check
+      end
+
+      def parse_command_line(argv)
+        parser = OptionParser.new
+        parser.version = VERSION
+        parser.banner = <<~BANNER
+          Usage: fluent-tailcheck [OPTIONS] POS_FILE...
+          Example: fluent-tailcheck /path/to/pos1 /path/to/pos2
+          Example: fluent-tailcheck /path/to/pos/*
+          Example: fluent-tailcheck --follow-inodes /path/to/pos_with_follow_inodes
+
+          Requires read permission to the specified pos files and the target log files.
+          Example: sudo fluent-tailcheck /path/to/pos1
+
+          Document: https://github.com/clear-code/fluent-tail_checker/blob/main/README.md
+
+          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
+          @follow_inodes = true
+        end
+        parser.on("--ratio NUM", Float, "Minimum ratio of collection of each target log file to accept.", "Default: #{@collection_ratio_threshold}") do |v|
+          @collection_ratio_threshold = v
+        end
+
+        begin
+          @pos_filepaths = parser.parse(argv)
+
+          if @collection_ratio_threshold < 0 or @collection_ratio_threshold > 1
+            raise OptionParser::InvalidArgument, "--ratio #{@collection_ratio_threshold} must be an decimal from 0 to 1."
+          end
+        rescue OptionParser::ParseError => e
+          $stderr.puts e, "", parser.help, ""
+          raise
+        end
+      end
+
+      def validate_paths(paths)
+        Enumerator.new do |y|
+          paths.each do |path|
+            unless FileTest.exist?(path)
+              $stderr.puts "Skip #{path} because it is not found. Make sure you have the proper privilege, e.g. 'sudo'."
+              next
+            end
+
+            y << path
+          end
+        end
+      end
+
+      def check
+        if @pos_filepaths.empty?
+          $stderr.puts "No pos_file to be checked. Please specify valid pos_file paths."
+          return false
+        end
+
+        succeeded = true
+
+        @pos_filepaths.each do |path|
+          puts "\nCheck #{path}."
+          pos_file = try_to_open_pos_file(path)
+          next if pos_file.nil?
+
+          succeeded = DuplicatedPosChecker.new(pos_file, @follow_inodes).check && succeeded
+          succeeded = CollectionRatioChecker.new(pos_file, @follow_inodes, @collection_ratio_threshold).check && succeeded
+        end
+
+        puts "\nAll check completed. (Fluentd v#{Fluent::VERSION})"
+
+        unless succeeded
+          puts "Some anomalies are found. Please check the logs for details.",
+               "",
+               "If you have any questions or issues, please report them to the following:",
+               "  Fluentd Q&A: https://github.com/fluent/fluentd/discussions/categories/q-a",
+               "  Fluentd Q&A (日本語用): https://github.com/fluent/fluentd/discussions/categories/q-a-japanese",
+               "  About this command (日本語可): https://github.com/clear-code/fluent-tail_checker/issues"
+          return false
+        end
+
+        puts "There is no anomalies."
+        true
+      end
+
+      def try_to_open_pos_file(path)
+        PosFile.load(path)
+      rescue => e
+        $stderr.puts "Can not open the file. Skipped. Make sure you have the proper privilege, e.g. 'sudo'. Path: #{path}, Error: #{e}"
+      end
+    end
+  end
+end

data/lib/fluent/tail_checker/version.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Daijiro Fukuda
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Fluent
+  module TailChecker
+    VERSION = "1.0.0"
+  end
+end

data/lib/fluent/tail_checker.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Daijiro Fukuda
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative "tail_checker/tail_check"
+require_relative "tail_checker/version"

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: fluent-tail_checker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daijiro Fukuda
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A script to check that in_tail plugin of Fluentd is working properly.
+email:
+- fukuda@clear-code.com
+executables:
+- fluent-tailcheck
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- Vagrantfile
+- doc/development.md
+- doc/feature.md
+- doc/installation.md
+- doc/result-examples.md
+- exe/fluent-tailcheck
+- lib/fluent/tail_checker.rb
+- lib/fluent/tail_checker/collection_ratio_checker.rb
+- lib/fluent/tail_checker/duplicated_pos_checker.rb
+- lib/fluent/tail_checker/pos.rb
+- lib/fluent/tail_checker/tail_check.rb
+- lib/fluent/tail_checker/version.rb
+homepage: https://github.com/clear-code/fluent-tail_checker
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/clear-code/fluent-tail_checker
+  source_code_uri: https://github.com/clear-code/fluent-tail_checker
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: A script to check that in_tail plugin of Fluentd is working properly.
+test_files: []