fix(daemon): Adds escaping for log forwarded labels #1035
Merged
+17
−11
Conversation
This file contains hidden or 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
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev #1035 +/- ##
=======================================
Coverage 77.87% 77.87%
=======================================
Files 198 198
Lines 27899 27899
=======================================
Hits 21727 21727
Misses 6172 6172
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
lavarou
approved these changes
Mar 13, 2025
The previous code did not account for that labels can contain UTF-8 characters which must be escaped. This commit changes the code to use the Go marshalling for json which will properly handle these characters. A guard was added to make sure invalid log labels are not converted to JSON (with an empty key or value). The ingest code should prevent this from happening but a secondary check here on JSON generation is a reasonable safeguard.
mfulb
force-pushed
the
fix/log-labels-escape-chars
branch
from
ca6a590 to
f0f4568
Compare
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.
This PR corrects how the collector JSON for log forwarded labels handles log label key and values which have characters which must be escaped for JSON marshaling. The change is restricted to the daemon code to generate the log label JSON and does not impact the agent side of things.
The fix is to use the Go
jsonmodule to handle the creation of the JSON. It will handle the escaping as needed. The array of label key/value pairs is converted to a Gomapwhich is then marshaled into JSON. The case where either the label or value is empty (an invalid label) is handled so that these are not forwarded. This case should not occur as labels of this type should not be created by the agent but this check is added as additional protection against this case.