Update Statsd tag serializer to allow falsy values #290
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
joseph-hughes
force-pushed
the
joseph-hughes-allow-false-as-tag-value
branch
from
a7c8e5e to
ad053c0
Compare
This instead now ensures that we skip including the tag value only if: - it is equal to 'nil' - it when stringified is equal to 'nil' The reasoning for this was to make it so falsy values (e.g. false) will now be included in our tag content, instead of skipped.
joseph-hughes
force-pushed
the
joseph-hughes-allow-false-as-tag-value
branch
from
ad053c0 to
0c67365
Compare
joseph-hughes
commented
Dec 12, 2024
| @@ -75,7 +75,7 @@ def to_tags_list(tags) | |||
| def escape_tag_content(tag) | |||
| tag = tag.to_s | |||
| return tag unless tag.include?('|') | |||
| tag.delete('|,') | |||
| tag.delete('|,') | |||
There was a problem hiding this comment.
Looks like my editor chose to remove some whitespace here!
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.
Problem
If we provide a tag which has a boolean value, we are unable to properly track the
falsecase, since the "true" string appears with the tag name, but the "false" string does not show up. This is because of this logic, which checks for tag value presence:dogstatsd-ruby/lib/datadog/statsd/serialization/tag_serializer.rb
Lines 58 to 66 in 517b830
trueis evaluated to present, so we would add that tag name and value; however,falseis evaluated to not present, so we would only add that tag name (not the value).Solution
First convert the tag value to a string before checking for presence. This does result in other values being deemed "present" now which were not previously though, such as
[]and{}. Is this a problem though?