Distributor: do not propagate errors with non-utf8 characters #10236
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
Signed-off-by: Yuri Nikolic <[email protected]>
Signed-off-by: Yuri Nikolic <[email protected]>
Signed-off-by: Yuri Nikolic <[email protected]>
replay
reviewed
Dec 13, 2024
replay
reviewed
Dec 13, 2024
| {Key: "Content-Type", Values: []string{"application/json"}}, | ||
| }, | ||
| Url: "/otlp", | ||
| Body: []byte("\n\xf6\x16\n\xd3\x02\n\x1d\n\x11container.runtime\x12\x08\n\x06docker\n'\n\x12container.h"), |
There was a problem hiding this comment.
I'm pretty sure that the test is correct, but it would be easier to read and understand it if it had a comment explaining which character is not valid UTF-8 and with which other character we expect it to be replaced.
There was a problem hiding this comment.
I have added a comment explaining which characters are non-UTF8, and what should they be replaced with. Thank you.
Signed-off-by: Yuri Nikolic <[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.
What this PR does
This PR prevents
distributor.OTLPHandleranddistributor.Handlerfrom propagating errors containing non-utf8 characters.The presence of non-utf8 characters in Mimir errors might break some crucial parts of distributor's logic. For example, if
httpgrpc.HTTPServer.Handle()returns ahttpgprc.Errorcontaining a non-utf8 character, this error will not be propagated tohttpgrpc.HTTPClientas ahtttpgrpc.Error, but as a generic error, which might break some of Mimir internal logic.This is because golang's
proto.Marshal(), which is used by gRPC internally, fails when it marshals thehttpgrpc.Errorcontaining non-utf8 character produced byhttpgrpc.HTTPServer.Handle(), making the resulting error lose some important properties.Which issue(s) this PR fixes or relates to
Fixes #
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX].about-versioning.mdupdated with experimental features.