Skip to content

fix(logging): Handle closing correctly and fix tests #16539

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Feb 24, 2025
Merged

fix(logging): Handle closing correctly and fix tests #16539

merged 5 commits into from
Feb 24, 2025

Conversation

srebhan
Copy link
Member

@srebhan srebhan commented Feb 21, 2025

Summary

This PR makes closing of the logging infrastructure more robust by

  • not closing stderr in structured-logging
  • avoid returning an error in closing already files
  • avoid closing already closed EventLog handles

and fixes the unit tests by

  • removing prefix EventLog fixing integration tests on Windows
  • close logging everywhere we setup logging before to make sure all files are closed
  • use t.TempDir everywhere to make sure we clean up
  • close files created with os.CreateTemp to not leave open files behind

Checklist

  • No AI generated code was used in this PR

Related issues

replaces #16459

@telegraf-tiger telegraf-tiger bot added the fix pr to fix corresponding bug label Feb 21, 2025
@srebhan srebhan mentioned this pull request Feb 21, 2025
Closed
1 task
zak-pawel
zak-pawel reviewed Feb 24, 2025
View reviewed changes
Copy link
Collaborator

@zak-pawel zak-pawel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems that these

const (
	LogTargetFile   = "file"
	LogTargetStderr = "stderr"
)

are unused in text_logger.go

@srebhan
Copy link
Member Author

srebhan commented Feb 24, 2025

Seems that these

const (
	LogTargetFile   = "file"
	LogTargetStderr = "stderr"
)

are unused in text_logger.go

I know and this is on purpose. PR #15514 has the details...

@srebhan srebhan self-assigned this Feb 24, 2025
@zak-pawel
Copy link
Collaborator

Seems that these

const (
	LogTargetFile   = "file"
	LogTargetStderr = "stderr"
)

are unused in text_logger.go

I know and this is on purpose. PR #15514 has the details...

@srebhan
A comment in the code explaining why this was left would be useful because in 0.5–1 year, someone might accidentally want to remove it again ;)

@srebhan srebhan requested a review from zak-pawel February 24, 2025 11:43
@telegraf-tiger
Copy link
Contributor

Download PR build artifacts for linux_amd64.tar.gz, darwin_arm64.tar.gz, and windows_amd64.zip.
Downloads for additional architectures and packages are available below.

👍 This pull request doesn't change the Telegraf binary size

📦 Click here to get additional PR build artifacts

Artifact URLs

DEB RPM TAR GZ ZIP
amd64.deb aarch64.rpm darwin_amd64.tar.gz windows_amd64.zip
arm64.deb armel.rpm darwin_arm64.tar.gz windows_arm64.zip
armel.deb armv6hl.rpm freebsd_amd64.tar.gz windows_i386.zip
armhf.deb i386.rpm freebsd_armv7.tar.gz
i386.deb ppc64le.rpm freebsd_i386.tar.gz
mips.deb riscv64.rpm linux_amd64.tar.gz
mipsel.deb s390x.rpm linux_arm64.tar.gz
ppc64el.deb x86_64.rpm linux_armel.tar.gz
riscv64.deb linux_armhf.tar.gz
s390x.deb linux_i386.tar.gz
linux_mips.tar.gz
linux_mipsel.tar.gz
linux_ppc64le.tar.gz
linux_riscv64.tar.gz
linux_s390x.tar.gz

@srebhan srebhan added the ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review. label Feb 24, 2025
@srebhan srebhan assigned mstrandboge and unassigned srebhan Feb 24, 2025
@mstrandboge mstrandboge merged commit 26fc051 into influxdata:master Feb 24, 2025
25 of 27 checks passed
@github-actions github-actions bot added this to the v1.33.3 milestone Feb 24, 2025
srebhan added a commit that referenced this pull request Feb 25, 2025
@srebhan
fix(logging): Handle closing correctly and fix tests (#16539)
005d748 
(cherry picked from commit 26fc051)
asaharn pushed a commit to asaharn/telegraf that referenced this pull request Mar 10, 2025
@srebhan @asaharn
fix(logging): Handle closing correctly and fix tests (influxdata#16539)
2b3ce13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mstrandboge mstrandboge mstrandboge approved these changes

+1 more reviewer

@zak-pawel zak-pawel zak-pawel approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@mstrandboge mstrandboge

Labels
area/logging fix pr to fix corresponding bug ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review.
Projects
None yet
Milestone
v1.33.3
Development

Successfully merging this pull request may close these issues.
3 participants
@srebhan @zak-pawel @mstrandboge