GH-3108: Document that NamingConvention only processes dot-separated names - #7602
Open
won-seoop wants to merge 1 commit into
Open
GH-3108: Document that NamingConvention only processes dot-separated names#7602won-seoop wants to merge 1 commit into
won-seoop wants to merge 1 commit into
Conversation
…ses dot-separated names Add a NOTE to the Tag Naming section clarifying that generic naming conventions (like NamingConvention.snakeCase) only translate dot separators to the backend's idiomatic separator. Hyphens and other non-dot characters are passed through verbatim. Also note that each registry ships with its own backend-specific naming convention (e.g. PrometheusNamingConvention) that handles disallowed characters, and replacing it with a generic convention can cause unexpected tag names. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
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
Closes #3108
The root confusion in this issue is that users expect
NamingConvention.snakeCaseto convert all separators (including hyphens) to underscores, but it only processes dot-separated names — which is Micrometer's canonical form.The issue thread clarifies (from @shakuzen):
This PR adds a NOTE callout in the
naming.adocTag Naming section that:my-tag-namestays asmy-tag-name, butmy.tag.name→my_tag_name)NamingConvention.snakeCaseproduces unexpected resultsTest plan
./gradlew antoragenerates the site and the Tag Naming section includes the new NOTE🤖 Generated with Claude Code