RSDK-9752: Add -log-file to viam-server. #4716
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dgottlieb
commented
Jan 15, 2025
| @@ -70,6 +71,9 @@ func logViamEnvVariables(logger logging.Logger) { | |||
| if value, exists := os.LookupEnv("VIAM_MODULE_STARTUP_TIMEOUT"); exists { | |||
| viamEnvVariables = append(viamEnvVariables, "VIAM_MODULE_STARTUP_TIMEOUT", value) | |||
| } | |||
| if value, exists := os.LookupEnv("CWD"); exists { | |||
There was a problem hiding this comment.
A drive-by while I was editting entrypoint.go
Inspired by https://viam.atlassian.net/browse/DOCS-3383
dgottlieb
commented
Jan 15, 2025
web/server/entrypoint.go
Outdated
| logger.SetLevel(logging.INFO) | ||
| if argsParsed.OutputLogFile != "" { | ||
| logWriter, closer := logging.NewFileAppender(argsParsed.OutputLogFile) | ||
| defer closer.Close() |
There was a problem hiding this comment.
This lumberjack library spawns a goroutine that it does not wait on when exiting. Despite this call to close.
I talked with @cheukt and we're cool with just disabling leak detection in goutils for ContextualMain (e.g: viam-server and presumably viam-cli). It'll still run for tests.
benjirewis
approved these changes
Jan 15, 2025
logging/appender.go
Outdated
| @@ -36,6 +37,26 @@ func NewWriterAppender(writer io.Writer) ConsoleAppender { | |||
| return ConsoleAppender{writer} | |||
| } | |||
|
|
|||
| // NewFileAppender will create an Appender that writes output to a log file. Log rotation will be | |||
| // enabled such that restarts of the viam-server with the same filename will move the old file out | |||
| // of the way. The `io.Closer` | |||
There was a problem hiding this comment.
Suggested change
| // of the way. The `io.Closer` | |
| // of the way. The `io.Closer` can be used to eventually close the opened log file. |
There was a problem hiding this comment.
Also clever way to minimize the methods devs can call on the *lumberjack.Logger.
There was a problem hiding this comment.
Thanks for spotting the unfinished sentence -- added by hand
web/server/entrypoint.go
Outdated
| logger.SetLevel(logging.INFO) | ||
| if argsParsed.OutputLogFile != "" { | ||
| logWriter, closer := logging.NewFileAppender(argsParsed.OutputLogFile) | ||
| defer closer.Close() |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.