Include missing key in error message for KV store #3779
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
mmatur
added
status/2-needs-review
area/provider/kv
bot/no-merge
and removed
status/0-needs-triage
labels
1 task
juliens
requested changes
Aug 20, 2018
cluster/datastore.go
Outdated
| @@ -78,7 +78,7 @@ func (d *Datastore) watchChanges() error { | |||
| stopCh := make(chan struct{}) | |||
| kvCh, err := d.kv.Watch(d.lockKey, stopCh, nil) | |||
| if err != nil { | |||
| return err | |||
| return fmt.Errorf("%v: %s", err, d.lockKey) | |||
There was a problem hiding this comment.
Can you add a sentence here like error while watching key %s: %v
Improves the operator experience when debugging issues like traefik#2712
ldez
force-pushed
the
missing-key-in-error
branch
from
2249a20
to
57129a0
Compare
|
Why not simply bootstrap etcd with lock and object when the etcd entry is present ? It's so much complicated to "pre bootstrap" etcd by playing one time script ... Don't understand this choice to throw an error that say "you need to bootstrap" rather than auto bootstrap |
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 does this PR do?
The generic missing-key error message that comes from valkeyrie doesn't point the operator at the key that's missing. Several folk, including myself, have spent time figuring out what that missing key is. When setting up TLS there's a further potential confusion between KV store keys and TLS keys!
See #2712 for an example issue that might have gone smoother with this more detailed logging.
Motivation
I spent several hours debugging this, and that time could've been saved by knowing what the missing key was.
More
No tests / docs updated. I don't believe this warrants a test.
I began running the tests but had to go do something else before they finished!
Additional Notes
Worth checking that the format string is safe with all possible return values.