[pkg/stanza] key_value_parser: Allow values that contain the delimiter string #29629
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
VihasMakwana
approved these changes
Dec 4, 2023
djaglowski
reviewed
Dec 4, 2023
| "quoted-value-contains-delimiter", | ||
| func(kv *Config) {}, | ||
| &entry.Entry{ | ||
| Body: `msg="Message successfully sent at 2023-12-04 06:47:31.204222276 +0000 UTC m=+5115.932279346"`, |
There was a problem hiding this comment.
Could we also have a test which involves 3+ key value pairs? This would validate we have the correct interaction with pair_delimiter, and help ensure we do not in the future limit the number of pairs to 2.
|
Per @djaglowski's request I've added a |
djaglowski
approved these changes
Dec 4, 2023
|
Thanks, all! |
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:
This PR fixes an issue in the
key_value_parseroperator wherein values containing the delimiter (=, by default), would cause a parse failure.Given the log body:
The
key_value_parserwould fail with the following error:After this PR, the
key_value_parserinstead emits the following key/value pair:As a result of this change, it is now also possible to parse unquoted values that contain the delimiter. For example
foo=bar=spamis parsed as("foo", "bar=spam"). Because there was an existing test case for this failure mode I had considered explicitly disallowing this behaviour for unquoted values. However, I couldn't think of a reason to prefer an error so I decided to float the PR as-is first. FWIW, this behaviour has some prior art, for example parsing of environment variables.Link to tracking Issue:
Testing:
I've added an additional test case named
quoted-value-contains-delimiterthat tests the problematic message I encountered in the wild.I've also replaced the existing
invalid-pairtest as a result of the changed behaviour mentioned above.Documentation: