chore: log when an invalid watch request is received #14351
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
As protobuf doesn't have required field, user may send an empty WatchRequest by mistake. Currently, etcd will ignore the invalid request and keep the stream opening. If we don't reject the invalid request by closing the stream, it would be better to leave a log there. This commit also fixes a typo in the comment. Signed-off-by: spacewander <[email protected]>
Codecov Report
@@ Coverage Diff @@
## main #14351 +/- ##
==========================================
- Coverage 75.39% 75.33% -0.07%
==========================================
Files 457 457
Lines 37125 37117 -8
==========================================
- Hits 27991 27961 -30
- Misses 7377 7394 +17
- Partials 1757 1762 +5
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
SimFG
reviewed
Aug 16, 2022
server/etcdserver/api/v3rpc/watch.go
Outdated
| // so just do nothing instead. | ||
| sws.lg.Warn("invalid watch request received in gRPC stream") |
There was a problem hiding this comment.
Adding the request type info will be more helpful to debug.
spzala
reviewed
Aug 16, 2022
server/etcdserver/api/v3rpc/watch.go
Outdated
| // so just do nothing instead. | ||
| sws.lg.Warn("invalid watch request received in gRPC stream") |
There was a problem hiding this comment.
@spacewander thanks! Logging it for information purpose sounds good, and so I think the severity should be Info (not warning).
Signed-off-by: spacewander <[email protected]>
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.
As protobuf doesn't have required field, user may send an empty
WatchRequest by mistake. Currently, etcd will ignore the invalid request
and keep the stream opening. If we don't reject the invalid request by
closing the stream, it would be better to leave a log there.
This commit also fixes a typo in the comment.
Signed-off-by: spacewander [email protected]
Please read https://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md#contribution-flow.