Fix/logfmtrenderer quotes escaping #513
Closed
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
9 tasks
madjar
reviewed
Jan 30, 2024
| string_with_quotes = r'"example": "this \"should\" work!"' | ||
| event_dict = {"exception": string_with_quotes} | ||
| rv = LogfmtRenderer()(None, None, event_dict) | ||
| assert r'exception="\"example\": \"this \\\"should\\\" work!\""' == rv |
There was a problem hiding this comment.
I checked, and this makes grafana (or rather, loki) happy, and the output is "example": "this \"should\" work!"
However, I think that what makes it work in this implementation is the spaces, the same example without spaces won't be between quotes, and that'll result in invalid logfmt.
| @@ -166,6 +168,10 @@ def __call__( | |||
|
|
|||
| return " ".join(elements) | |||
|
|
|||
| def _escape_double_quotes(self, text: str) -> str: | |||
| value = f"{text}".replace(r"\"", r"\\\"") | |||
| return self._double_quotes_without_backslash_prefix.sub(r"\"", value) | |||
There was a problem hiding this comment.
I think there's one more corner case here: if the value is between quotes, then the \ need to be escaped.
For example, the raw string \ " needs to be encoded as "\\ \", not "\ \" (confirmed on loki).
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.
Summary
PR to fix escaping double quotes in LogfmtRenderer
(fix #511 )
Pull Request Check List
typing_examples.py.docs/api.rstby hand.versionadded,versionchanged, ordeprecateddirectives.Find the appropriate next version in our
__init__.pyfile..rstand.mdfiles is written using semantic newlines.