Skip to content

fix: escape colons in metric names when escaping=underscores #1180

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
johnsaurabh wants to merge 3 commits into
base: master
Choose a base branch
from
Open

fix: escape colons in metric names when escaping=underscores #1180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1972af2
fix: escape colons in metric names under UNDERSCORES mode
johnsaurabh Jun 4, 2026
45601c1
test: add colon escaping test and update stale expectations
johnsaurabh Jun 4, 2026
7439352
test: update stale colon escaping expectations in test_exposition.py
johnsaurabh Jun 4, 2026
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
4 changes: 2 additions & 2 deletions prometheus_client/openmetrics/exposition.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,9 +181,9 @@ def escape_metric_name(s: str, escaping: str = UNDERSCORES) -> str:
return '"{}"'.format(_escape(s, escaping, _is_legacy_metric_rune))
return _escape(s, escaping, _is_legacy_metric_rune)
elif escaping == UNDERSCORES:
if _is_valid_legacy_metric_name(s):
if _is_valid_legacy_metric_name(s) and ':' not in s:
return s
return _escape(s, escaping, _is_legacy_metric_rune)
return _escape(s, escaping, _is_legacy_labelname_rune)
elif escaping == DOTS:
return _escape(s, escaping, _is_legacy_metric_rune)
elif escaping == VALUES:
Expand Down
13 changes: 11 additions & 2 deletions tests/openmetrics/test_exposition.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,15 @@ def test_counter_utf8_escaped_underscores(self):
utf8_cc_total 1.0
utf8_cc_created 123.456
# EOF
""" == generate_latest(self.registry, UNDERSCORES)

def test_gauge_colon_in_name_escaped_underscores(self):
g = Gauge('sglang:token_usage', 'Total token usage.', registry=self.registry)
g.set(42.0)
assert b"""# HELP sglang_token_usage Total token usage.
# TYPE sglang_token_usage gauge
sglang_token_usage 42.0
# EOF
""" == generate_latest(self.registry, UNDERSCORES)

def test_counter_total(self) -> None:
Expand Down Expand Up @@ -482,7 +491,7 @@ def test_native_histogram_version_comparison(self) -> None:
{
"name": "legacy valid metric name",
"input": "no:escaping_required",
"expectedUnderscores": "no:escaping_required",
"expectedUnderscores": "no_escaping_required",
"expectedDots": "no:escaping__required",
"expectedValue": "no:escaping_required",
},
Expand All @@ -503,7 +512,7 @@ def test_native_histogram_version_comparison(self) -> None:
{
"name": "metric name with dots and colon",
"input": "http.status:sum",
"expectedUnderscores": "http_status:sum",
"expectedUnderscores": "http_status_sum",
"expectedDots": "http_dot_status:sum",
"expectedValue": "U__http_2e_status:sum",
},
Expand Down
4 changes: 2 additions & 2 deletions tests/test_exposition.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -644,7 +644,7 @@ def test_prom_no_version(self):
{
"name": "legacy valid metric name",
"input": "no:escaping_required",
"expectedUnderscores": "no:escaping_required",
"expectedUnderscores": "no_escaping_required",
"expectedDots": "no:escaping__required",
"expectedValue": "no:escaping_required",
},
Expand All @@ -665,7 +665,7 @@ def test_prom_no_version(self):
{
"name": "metric name with dots and colon",
"input": "http.status:sum",
"expectedUnderscores": "http_status:sum",
"expectedUnderscores": "http_status_sum",
"expectedDots": "http_dot_status:sum",
"expectedValue": "U__http_2e_status:sum",
},
Expand Down