Do not log "failed to load config" if runtime config file is empty #3706
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
Signed-off-by: Marco Pracucci <marco@pracucci.com>
pstibrany
reviewed
Jan 20, 2021
pkg/cortex/runtime_config.go
Outdated
Comment on lines
24
to
30
| content, err := ioutil.ReadAll(r) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| decoder := yaml.NewDecoder(r) | ||
| decoder.SetStrict(true) | ||
| if err := decoder.Decode(&overrides); err != nil { | ||
| var overrides = &runtimeConfigValues{} | ||
| if err := yaml.UnmarshalStrict(content, overrides); err != nil { |
There was a problem hiding this comment.
I think we should revert back to original code, and extend the checks as follows:
- If first returned error is EOF, we return
nil. This covers empty document case. - We call
decoder.Decodesecond time, and if it doesn't return EOF, thenloadRuntimeConfigwill return error.
Second check covers the case when there are multiple YAML documents on the input, eg.
---
# This is an empty YAML.
---
multi_kv_config:
mirror_enabled: true
In this case, first two calls to Decode return nil (no error), so our current version of loadRuntimeConfig (or version suggested in this PR, which only decodes first document) would return no error, which is confusing.
WDYT?
There was a problem hiding this comment.
Very good point about multiple documents (that should be forbidden). I've changed it. What do you think?
…cuments Signed-off-by: Marco Pracucci <marco@pracucci.com>
pstibrany
approved these changes
Jan 21, 2021
Signed-off-by: Marco Pracucci <marco@pracucci.com> Co-authored-by: Peter Štibraný <pstibrany@gmail.com>
Signed-off-by: Marco Pracucci <marco@pracucci.com> Co-authored-by: Peter Štibraný <pstibrany@gmail.com>
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.
What this PR does:
We recently introduced an empty
runtime.yamlin the local dev env setupdevelopment/tsdb-blocks-storage-s3/config/, but I've just realised the config fails to load because empty (no YAML node). Should an empty config be legit? If so, then this PR fixes it.Which issue(s) this PR fixes:
N/A
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]