Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tailing to stdout does not follow rotated/renamed files #626

Open
Chancepants opened this issue Oct 23, 2023 · 0 comments · May be fixed by #684
Open

Tailing to stdout does not follow rotated/renamed files #626

Chancepants opened this issue Oct 23, 2023 · 0 comments · May be fixed by #684

Comments

@Chancepants
Copy link

The tail command used to emit splunkd_stderr.log (or a custom log file) to stdout does not handle the file being rotated/renamed. The current command uses -f https://github.com/splunk/docker-splunk/blob/9.1.1/splunk/common-files/entrypoint.sh#L65 but likely should use -F

     -F      The -F option implies the -f option, but tail will also check to see if the file being
             followed has been renamed or rotated.  The file is closed and reopened when tail
             detects that the filename being read from has a new inode number.

In my current environment I have splunk running container image 9.0.6 and have verified the tail command is running via ps aux | grep tail and logs are actively being written to splunkd_stderr.log. I've also confirmed logs stopped being written to stdout immediately after file rotation splunkd_stderr.log -> splunkd_stderr.log.1.

zarend pushed a commit to zarend/docker-splunk that referenced this issue Aug 26, 2024
Fix issue with logging of standard error messages where standard error
logs would be lost when logging large amount of data to stadard error.

Splunk logs to splunkd_stdout.log as the Unix standard error device.
This file is rotated. According to [What Splunk software logs about itself](https://docs.splunk.com/Documentation/Splunk/9.2.1/Troubleshooting/WhatSplunklogsaboutitself), "The historical rotation for most internal logs is 5 files of 25MB each".

docker-splunk container tails the output of splunkd_stdout.log to
standard output. The existing behavior is that the container receives
Splunk's standard error messages until splunkd_stdout.log is about 25MB.
When the log files passes 25MB, Splunk rotates the log file by rename
splunkd_stdout.log to something like splunkd_stoudt1.log and creating a
new splunkd_stdout.log.

By default, tail follows the file descriptor of argument file. I believe
that if the file is renamed, it continutes to track the file descriptor
of argument file, if that is available. This is not the behavior we want
for file rotation, since we always want to follow the information that
goes to splunkd_stdout.log and not splunkd_stdout1.log,
splunkd_stdout2.log, etc.

Fix standard error logs not surfacing by passing `-F` option to unix
tail command. This causes tail to keep retrying to open argument file
name if it becomes unavailable.

Change in behavior to print standard error logs to standard out for
entire lifetime of the program, instead of stopping after the first file
rotation.

Fix splunk#626
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant