core/server: Add environment variable to write stacktrace to file #17929
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
hghaf099
approved these changes
Nov 14, 2022
command/server.go
Outdated
| if os.Getenv("VAULT_WRITE_STACKTRACE_TO_FILE") != "" { | ||
| c.logger.Info("Writing stacktrace to file..") | ||
|
|
||
| tmpFile, err := ioutil.TempFile("", fmt.Sprintf("%s-", filepath.Base(os.Args[0]))) |
There was a problem hiding this comment.
Seems like ioutil.TemFile has been deprecated. Shall we use os.CreateTemp instead?
There was a problem hiding this comment.
Good catch, fixed!
raskchanky
reviewed
Nov 14, 2022
raskchanky
reviewed
Nov 14, 2022
raskchanky
approved these changes
Nov 14, 2022
This was referenced Nov 15, 2022
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.
When Vault receives a SIGUSR2 signal it will write a stacktrace of the running goroutines to Vault's log file. These can be hard to parse due to log prefixes and in some cases, the logger is unable to log the entire stacktrace. This adds an environment variable will force Vault to also write the stacktrace to a temporary file on the server.
The environment variables are as follows:
VAULT_STACKTRACE_WRITE_TO_FILE=true: this forces the stacktrace to a file.VAULT_STACKTRACE_FILE_PATH=/some/path: if left unset, Vault will create a temp directory and file for your OS. This let's the user override the path.Vault will write the locations to the server logs: