Log env vars which override the env file #483
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
cretz
reviewed
Feb 28, 2024
temporalcli/commands.go
Outdated
| @@ -254,11 +257,21 @@ func (c *CommandContext) populateFlagsFromEnv(flags *pflag.FlagSet) error { | |||
| flag.Name, anns[0], envVal, err) | |||
| return | |||
| } | |||
| if flag.Changed { | |||
| logCalls = append(logCalls, func(l *slog.Logger) { | |||
| l.Info("Env var overrode --env setting", "env_var", anns[0], "flag", flag.Name, "value", envVal) | |||
There was a problem hiding this comment.
Hrmm, not sure we ever clarified the format of log keys (i.e. snake_case or what), I have no strong opinion here and I don't consider log keys to have stability guarantees anyways
cretz
approved these changes
Feb 28, 2024
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
What was changed
Log any time an env var overrides an env file setting
Why?
It can be a bit confusing if you've forgotten you've set an env var. Helpful reminder.
Checklist
Closes [Feature Request] Log notice when --env is getting overrode by env var #293
How was this tested:
Added unit test
Any docs updates needed?