Skip to content

expfmt: format OpenMetrics 2.0 float values and validate units #969

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

Merged
bwplotka merged 1 commit into from
Aug 24, 2026
+38 −11
Merged

expfmt: format OpenMetrics 2.0 float values and validate units #969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions expfmt/openmetrics_2_0_create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ func MetricFamilyToOpenMetrics20(out io.Writer, in *dto.MetricFamily, options ..
if containsRawNewline(name) {
return 0, fmt.Errorf("MetricFamily name %q contains raw newlines", name)
}
if in.Unit != nil && containsRawNewline(*in.Unit) {
return 0, fmt.Errorf("MetricFamily unit %q contains raw newlines", *in.Unit)
}

// Try the interface upgrade. If it doesn't work, we'll use a
// bufio.Writer from the sync.Pool.
Expand Down Expand Up @@ -222,7 +225,7 @@ func writeOpenMetrics20Sample(w enhancedWriter, name string, metric *dto.Metric,
if useIntValue {
n, err = writeUint(w, intValue)
} else {
n, err = writeFloat(w, floatValue)
n, err = writeOpenMetricsFloat(w, floatValue)
}
written += n
if err != nil {
Expand Down Expand Up @@ -305,7 +308,7 @@ func writeExemplar20(w enhancedWriter, e *dto.Exemplar) (int, error) {
if err != nil {
return written, err
}
n, err = writeFloat(w, e.GetValue())
n, err = writeOpenMetricsFloat(w, e.GetValue())
written += n
if err != nil {
return written, err
Expand Down
42 changes: 33 additions & 9 deletions expfmt/openmetrics_2_0_create_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ func TestCreateOpenMetrics20(t *testing.T) {
},
out: `# HELP http_requests_total Total number of HTTP requests.
# TYPE http_requests_total counter
http_requests_total{method="GET",code="200"} 1027 st@1234567890
http_requests_total{method="GET",code="200"} 1027.0 st@1234567890
`,
},
{
Expand All @@ -76,7 +76,7 @@ http_requests_total{method="GET",code="200"} 1027 st@1234567890
},
out: `# HELP http_requests_total Total number of HTTP requests.
# TYPE http_requests_total counter
http_requests_total{method="GET",code="200"} 1027 st@1234567890.987654321
http_requests_total{method="GET",code="200"} 1027.0 st@1234567890.987654321
`,
},
{
Expand Down Expand Up @@ -160,7 +160,7 @@ node_memory_active_bytes 1.2345e+09 1234567890
},
},
out: `# TYPE http_requests_total counter
http_requests_total 1027 1234567891 st@1234567890 # {trace_id="1234"} 1 1234567890.5
http_requests_total 1027.0 1234567891 st@1234567890 # {trace_id="1234"} 1.0 1234567890.5
`,
},
{
Expand All @@ -181,7 +181,7 @@ http_requests_total 1027 1234567891 st@1234567890 # {trace_id="1234"} 1 12345678
},
},
out: `# TYPE http_requests_total counter
http_requests_total 1027 # {} 1 1234567890.5
http_requests_total 1027.0 # {} 1.0 1234567890.5
`,
},
{
Expand All @@ -204,7 +204,7 @@ http_requests_total 1027 # {} 1 1234567890.5
},
},
out: `# TYPE http_requests_total counter
http_requests_total 1027
http_requests_total 1027.0
`,
},
{
Expand All @@ -228,7 +228,7 @@ http_requests_total 1027
},
},
out: `# TYPE http_requests_total counter
http_requests_total 1027 # {trace_id="1234"} NaN 1234567890
http_requests_total 1027.0 # {trace_id="1234"} NaN 1234567890
`,
},
{
Expand Down Expand Up @@ -262,7 +262,7 @@ test_metric 1.23
},
},
out: `# TYPE http_requests_total counter
http_requests_total 1027
http_requests_total 1027.0
`,
},
{
Expand All @@ -282,7 +282,7 @@ http_requests_total 1027
},
},
out: `# TYPE "你好_total" counter
{"你好_total","🌎"="🌍"} 1027
{"你好_total","🌎"="🌍"} 1027.0
`,
},
}
Expand Down Expand Up @@ -491,6 +491,30 @@ func TestCreateOpenMetrics20_Errors(t *testing.T) {
},
expectedErr: "contains raw newlines",
},
{
name: "NewlineInUnit",
in: &dto.MetricFamily{
Name: proto.String("test_counter_total"),
Type: dto.MetricType_COUNTER.Enum(),
Unit: proto.String("seconds\n"),
Metric: []*dto.Metric{
{Counter: &dto.Counter{Value: proto.Float64(1.0)}},
},
},
expectedErr: "contains raw newlines",
},
{
name: "CarriageReturnInUnit",
in: &dto.MetricFamily{
Name: proto.String("test_counter_total"),
Type: dto.MetricType_COUNTER.Enum(),
Unit: proto.String("seconds\r"),
Metric: []*dto.Metric{
{Counter: &dto.Counter{Value: proto.Float64(1.0)}},
},
},
expectedErr: "contains raw newlines",
},
{
name: "NilMetric",
in: &dto.MetricFamily{
Expand Down Expand Up @@ -614,7 +638,7 @@ func TestCreateOpenMetrics20_SimpleWriter(t *testing.T) {
}

expected := `# TYPE http_requests_total counter
http_requests_total 1027
http_requests_total 1027.0
`
if buf.String() != expected {
t.Errorf("expected %q, got %q", expected, buf.String())
Expand Down
Loading