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

feat: Reading Logs in daignose cli command #1521

Merged
merged 9 commits into from
Sep 22, 2024

Conversation

yodigos
Copy link
Contributor

@yodigos yodigos commented Sep 18, 2024

No description provided.

}

func createAllDirs() error {
if err := os.RemoveAll(mainDir); err != nil {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Also related to Eden's comment, you can have a look at the TempDir function.
I think having the files created in a temp location and only saving the final zip in the CWD is the accepted behavior

Copy link
Contributor Author

Choose a reason for hiding this comment

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

TempDir is deprecated from go 1.16 - the new way is with os.MkdirTemp

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ohhh my bad, ioutil.TempDir() is deprecated


// Define the log file path for saving compressed logs
logFilePath := filepath.Join(logDir, pod.Name+"_"+container.Name+"_"+pod.Spec.NodeName+".log.gz")
logFile, err := os.OpenFile(logFilePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0666)
Copy link
Collaborator

Choose a reason for hiding this comment

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

should add here
defer logFile.Close()
Instead of the current code which only closes the file at the happy-path where no errors occur.
This will guarantee the file is close when this function returns.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why Not Use defer Inside the Loop?
In a loop, using defer to close a file might seem like a convenient option, but deferred calls are not executed until the surrounding function returns. If you use defer inside the loop, it will accumulate all the defer calls, and the files will remain open until the function (or main program) exits. This can lead to excessive memory or resource usage, especially with a large number of iterations.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok I read a bit and this is a real cool way to solve this.. The anonymous function will be called after opening the file and because it uses defer and created inside the scope of the for-loop -> it will trigger in the end of the loop (succesfully / with error)

func() {
			defer func() {
				if err := file.Close(); err != nil {
					fmt.Printf("Error closing file %s: %v\n", fileName, err)
				}
			}()

Copy link
Collaborator

Choose a reason for hiding this comment

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

You can also extract the code in the loop body to a function and use a defer within that function, that way there is no risc for a long queue of defer functions.

@yodigos yodigos merged commit 9dd1fae into odigos-io:main Sep 22, 2024
22 checks passed
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 this pull request may close these issues.

3 participants