chore: allow dashes and dots in the metric label values

[IuryAlves]

The Prometheus Data model allows any unicode characters in label values, as documented here

Summary by CodeRabbit

• New Features
  • Expanded the range of allowed characters during value processing. Users will now benefit from improved handling of formats that include characters like '-' and '.', ensuring a smoother experience when interacting with data.

[CLAassistant]

All committers have signed the CLA.

[coderabbitai]

Walkthrough

The update modifies the sanitization options in the Prometheus module. In the prometheus/sanitize.go file, the default sanitizer settings (DefaultSanitizerOpts) have been altered to include additional valid characters. Previously, only alphanumeric characters were allowed. Now, the sanitizer appends a supplementary range permitting the characters '-' and '.', thereby expanding the set of characters considered valid during value sanitization.

Changes

File	Change Summary
prometheus/sanitize.go	Updated DefaultSanitizerOpts: changed ValueCharacters.Ranges from tally.AlphanumericRange to append(tally.AlphanumericRange, tally.SanitizeRange{'-', '.'})

Sequence Diagram(s)

(No sequence diagram is provided as the changes involve a configuration update without modifications to control flow.)

Poem

In my burrow of code I hop with delight,
A dash and a dot join the sparkle so bright.
New characters dance in the sanitized stream,
Aligning our values like a neat little dream.
Hopping through bytes, my heart beams in flight!
— A happy rabbit celebrating code changes!

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

prometheus/sanitize.go (1)

38-38: Aligns with PR objective of allowing dashes and dots in metric label values.

This change correctly modifies the DefaultSanitizerOpts to allow dashes - and dots . in metric label values by appending them to the existing AlphanumericRange. This aligns with the Prometheus data model as mentioned in the PR objectives.

However, I notice that SanitizeRange is typically used for character ranges (like 'a' to 'z'), but here it's being used for individual characters. While this works, it might be worth considering whether these characters should be added to the Characters field instead for better semantic clarity, especially since they're not a continuous range.

 var DefaultSanitizerOpts = tally.SanitizeOptions{
 	NameCharacters: tally.ValidCharacters{
 		Ranges:     tally.AlphanumericRange,
 		Characters: tally.UnderscoreCharacters,
 	},
 	KeyCharacters: tally.ValidCharacters{
 		Ranges:     tally.AlphanumericRange,
 		Characters: tally.UnderscoreCharacters,
 	},
 	ValueCharacters: tally.ValidCharacters{
-		Ranges:     append(tally.AlphanumericRange, tally.SanitizeRange{rune('-'), rune('.')}),
+		Ranges:     tally.AlphanumericRange,
+		Characters: append(tally.UnderscoreCharacters, []rune{'-', '.'}...),
 		Characters: tally.UnderscoreCharacters,
 	},
 	ReplacementCharacter: tally.DefaultReplacementCharacter,
 }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 22fe011 and 01ae684.

📒 Files selected for processing (1)

• prometheus/sanitize.go (1 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

prometheus/sanitize.go (1)

sanitize.go (2)

• AlphanumericRange (34-37)
• SanitizeRange (61-61)