Skip to content

prefix with _ if name begins with a number #1657

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+12 −0
Open

prefix with _ if name begins with a number #1657

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
969a8fb
prefix with `_` if name begins with a number
shubhindia Mar 11, 2025
ab349bd
Use regex to filter metrics starting with digits
shubhindia Mar 12, 2025
4c7b5f9
Make metricNumberPrefixRE a var
shubhindia Mar 12, 2025
7595933
Add a test for '_' prefix
shubhindia Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions pkg/promutil/prometheus.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
package promutil

import (
"regexp"
"strings"
"time"

Expand Down Expand Up @@ -105,6 +106,8 @@
"%", "_percent",
)

var metricNumberPrefixRE = regexp.MustCompile(`^\d`)

type PrometheusMetric struct {
Name string
Labels map[string]string
Expand Down Expand Up @@ -194,6 +197,12 @@

// sanitize replaces some invalid chars with an underscore
func sanitize(text string) string {

Check failure on line 200 in pkg/promutil/prometheus.go

View workflow job for this annotation

GitHub Actions / lint 

File is not properly formatted (gofumpt)
// metrics starting with a digit violate the prometheus metric naming convention, so we add an underscore
if metricNumberPrefixRE.MatchString(text) {
text = "_" + text
}

if strings.ContainsAny(text, "“%") {
// fallback to the replacer for complex cases:
// - '“' is non-ascii rune
Expand Down
Loading