Normalize namespace and metric names. #747
Open
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
According to the documentation https://docs.datadoghq.com/metrics/custom_metrics/#naming-custom-metrics metric names contain only ASCII alphanumerics, underscores, and periods, while other characters are converted to underscores. This commit ensures we replace all invalid characters with underscores for both namespaces and metric names. A similar thing has been already done for tags in DataDog#489 and DataDog#517, so I followed the example. It solves DataDog#740.
|
This issue has been automatically marked as stale because it has not had activity in the last 30 days. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 does this PR do?
According to the documentation metric names contain only ASCII alphanumerics, underscores, and periods, while other characters are converted to underscores.
Invalid names can lead to malformed dogstatsd packets being created.
It solves #740.
Description of the Change
This commit ensures we replace all invalid characters with underscores for both namespaces and metric names.
A similar thing has been already done for tags in #489 and #517, so I followed the example.
Possible Drawbacks
Performance cost due to string manipulation - partially addressed by using cache.
Verification Process
Tested manually. Added unit tests.
Release Notes
If some metrics with invalid names were successfully pushed, this might impose backward incompatibility.
Review checklist (to be filled by reviewers)
changelog/label attached. If applicable it should have thebackward-incompatiblelabel attached.do-not-merge/label attached.kind/andseverity/labels attached at least.