fix: add defaults for agent config to fully support nested env var overriders #188
Conversation
This file contains hidden or 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
![orca-security-us[bot]](https://avatars.githubusercontent.com/in/276250?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
SAST | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
| if err != nil { | ||
| panic(err) | ||
| } | ||
| var recursiveDfs func(prefix string, defaults map[string]any) |
There was a problem hiding this comment.
why not just recursiveDfs := func(?
There was a problem hiding this comment.
I need to declare it first since it's recursive, otherwise I can't reference it in the function body.
internal/root/root.go
Outdated
| @@ -53,6 +54,11 @@ func InitConfig() { | |||
| } | |||
|
|
|||
| viper.AutomaticEnv() // read in environment variables that match | |||
| // TODO add this into our next major release to improve our env var naming. | |||
| // viper.SetEnvKeyReplacer(strings.NewReplacer(`::`, `_`)) | |||
There was a problem hiding this comment.
we use _ in the actual field names as well, would this work with that? that's why we switched to :: to begin with
There was a problem hiding this comment.
Oh, if the :: was to avoid ambiguity, then I will just delete this comment. I think that _ is easier to use (ie HOST_MONITORING_ENABLED=true observe-agent start vs env HOST_MONITORING::ENABLED=true observe-agent start), but if this was an intentional choice for clarity then let's keep it.
obs-gh-alexlew
approved these changes
Apr 22, 2025
obs-gh-mattcotter
force-pushed
the
mc/config-defaults
branch
from
2d9a443 to
e342f95
Compare
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.
Description
Add viper defaults for all agent config settings. Without this, nested env vars will be ignored unless the value is already set in the config. ex:
env HOST_MONITORING::ENABLED=true ./observe-agent startwill be ignored with an empty agent config.