// Copyright 2017 The Prometheus Authors // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package textparse import ( "bytes" "errors" "io" "os" "strings" "testing" "github.com/klauspost/compress/gzip" "github.com/stretchr/testify/require" "github.com/prometheus/common/expfmt" "github.com/prometheus/common/model" "github.com/prometheus/prometheus/model/exemplar" "github.com/prometheus/prometheus/model/labels" "github.com/prometheus/prometheus/util/testutil" ) type expectedParse struct { lset labels.Labels m string t *int64 v float64 typ model.MetricType help string unit string comment string e *exemplar.Exemplar ct *int64 } func TestPromParse(t *testing.T) { input := `# HELP go_gc_duration_seconds A summary of the GC invocation durations. # TYPE go_gc_duration_seconds summary go_gc_duration_seconds{quantile="0"} 4.9351e-05 go_gc_duration_seconds{quantile="0.25",} 7.424100000000001e-05 go_gc_duration_seconds{quantile="0.5",a="b"} 8.3835e-05 go_gc_duration_seconds{quantile="0.8", a="b"} 8.3835e-05 go_gc_duration_seconds{ quantile="0.9", a="b"} 8.3835e-05 # Hrandom comment starting with prefix of HELP # wind_speed{A="2",c="3"} 12345 # comment with escaped \n newline # comment with escaped \ escape character # HELP nohelp1 # HELP nohelp2 go_gc_duration_seconds{ quantile="1.0", a="b" } 8.3835e-05 go_gc_duration_seconds { quantile="1.0", a="b" } 8.3835e-05 go_gc_duration_seconds { quantile= "1.0", a= "b", } 8.3835e-05 go_gc_duration_seconds { quantile = "1.0", a = "b" } 8.3835e-05 go_gc_duration_seconds { quantile = "2.0" a = "b" } 8.3835e-05 go_gc_duration_seconds_count 99 some:aggregate:rate5m{a_b="c"} 1 # HELP go_goroutines Number of goroutines that currently exist. # TYPE go_goroutines gauge go_goroutines 33 123123 _metric_starting_with_underscore 1 testmetric{_label_starting_with_underscore="foo"} 1 testmetric{label="\"bar\""} 1` input += "\n# HELP metric foo\x00bar" input += "\nnull_byte_metric{a=\"abc\x00\"} 1" int64p := func(x int64) *int64 { return &x } exp := []expectedParse{ { m: "go_gc_duration_seconds", help: "A summary of the GC invocation durations.", }, { m: "go_gc_duration_seconds", typ: model.MetricTypeSummary, }, { m: `go_gc_duration_seconds{quantile="0"}`, v: 4.9351e-05, lset: labels.FromStrings("__name__", "go_gc_duration_seconds", "quantile", "0"), }, { m: `go_gc_duration_seconds{quantile="0.25",}`, v: 7.424100000000001e-05, lset: labels.FromStrings("__name__", "go_gc_duration_seconds", "quantile", "0.25"), }, { m: `go_gc_duration_seconds{quantile="0.5",a="b"}`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go_gc_duration_seconds", "quantile", "0.5", "a", "b"), }, { m: `go_gc_duration_seconds{quantile="0.8", a="b"}`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go_gc_duration_seconds", "quantile", "0.8", "a", "b"), }, { m: `go_gc_duration_seconds{ quantile="0.9", a="b"}`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go_gc_duration_seconds", "quantile", "0.9", "a", "b"), }, { comment: "# Hrandom comment starting with prefix of HELP", }, { comment: "#", }, { m: `wind_speed{A="2",c="3"}`, v: 12345, lset: labels.FromStrings("A", "2", "__name__", "wind_speed", "c", "3"), }, { comment: "# comment with escaped \\n newline", }, { comment: "# comment with escaped \\ escape character", }, { m: "nohelp1", help: "", }, { m: "nohelp2", help: "", }, { m: `go_gc_duration_seconds{ quantile="1.0", a="b" }`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go_gc_duration_seconds", "quantile", "1.0", "a", "b"), }, { m: `go_gc_duration_seconds { quantile="1.0", a="b" }`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go_gc_duration_seconds", "quantile", "1.0", "a", "b"), }, { m: `go_gc_duration_seconds { quantile= "1.0", a= "b", }`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go_gc_duration_seconds", "quantile", "1.0", "a", "b"), }, { m: `go_gc_duration_seconds { quantile = "1.0", a = "b" }`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go_gc_duration_seconds", "quantile", "1.0", "a", "b"), }, { // NOTE: Unlike OpenMetrics, PromParser allows spaces between label terms. This appears to be unintended and should probably be fixed. m: `go_gc_duration_seconds { quantile = "2.0" a = "b" }`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go_gc_duration_seconds", "quantile", "2.0", "a", "b"), }, { m: `go_gc_duration_seconds_count`, v: 99, lset: labels.FromStrings("__name__", "go_gc_duration_seconds_count"), }, { m: `some:aggregate:rate5m{a_b="c"}`, v: 1, lset: labels.FromStrings("__name__", "some:aggregate:rate5m", "a_b", "c"), }, { m: "go_goroutines", help: "Number of goroutines that currently exist.", }, { m: "go_goroutines", typ: model.MetricTypeGauge, }, { m: `go_goroutines`, v: 33, t: int64p(123123), lset: labels.FromStrings("__name__", "go_goroutines"), }, { m: "_metric_starting_with_underscore", v: 1, lset: labels.FromStrings("__name__", "_metric_starting_with_underscore"), }, { m: "testmetric{_label_starting_with_underscore=\"foo\"}", v: 1, lset: labels.FromStrings("__name__", "testmetric", "_label_starting_with_underscore", "foo"), }, { m: "testmetric{label=\"\\\"bar\\\"\"}", v: 1, lset: labels.FromStrings("__name__", "testmetric", "label", `"bar"`), }, { m: "metric", help: "foo\x00bar", }, { m: "null_byte_metric{a=\"abc\x00\"}", v: 1, lset: labels.FromStrings("__name__", "null_byte_metric", "a", "abc\x00"), }, } p := NewPromParser([]byte(input), labels.NewSymbolTable()) checkParseResults(t, p, exp) } func checkParseResults(t *testing.T, p Parser, exp []expectedParse) { checkParseResultsWithCT(t, p, exp, false) } func checkParseResultsWithCT(t *testing.T, p Parser, exp []expectedParse, ctLinesRemoved bool) { i := 0 var res labels.Labels for { et, err := p.Next() if errors.Is(err, io.EOF) { break } require.NoError(t, err) switch et { case EntrySeries: m, ts, v := p.Series() p.Metric(&res) if ctLinesRemoved { // Are CT series skipped? _, typ := p.Type() if TypeRequiresCT(typ) && strings.HasSuffix(res.Get(labels.MetricName), "_created") { t.Fatalf("we exped created lines skipped") } } require.Equal(t, exp[i].m, string(m)) require.Equal(t, exp[i].t, ts) require.Equal(t, exp[i].v, v) testutil.RequireEqual(t, exp[i].lset, res) var e exemplar.Exemplar found := p.Exemplar(&e) if exp[i].e == nil { require.False(t, found) } else { require.True(t, found) testutil.RequireEqual(t, *exp[i].e, e) } if ct := p.CreatedTimestamp(); ct != nil { require.Equal(t, *exp[i].ct, *ct) } else { require.Nil(t, exp[i].ct) } case EntryType: m, typ := p.Type() require.Equal(t, exp[i].m, string(m)) require.Equal(t, exp[i].typ, typ) case EntryHelp: m, h := p.Help() require.Equal(t, exp[i].m, string(m)) require.Equal(t, exp[i].help, string(h)) case EntryUnit: m, u := p.Unit() require.Equal(t, exp[i].m, string(m)) require.Equal(t, exp[i].unit, string(u)) case EntryComment: require.Equal(t, exp[i].comment, string(p.Comment())) } i++ } require.Len(t, exp, i) } func TestUTF8PromParse(t *testing.T) { oldValidationScheme := model.NameValidationScheme model.NameValidationScheme = model.UTF8Validation defer func() { model.NameValidationScheme = oldValidationScheme }() input := `# HELP "go.gc_duration_seconds" A summary of the GC invocation durations. # TYPE "go.gc_duration_seconds" summary {"go.gc_duration_seconds",quantile="0"} 4.9351e-05 {"go.gc_duration_seconds",quantile="0.25",} 7.424100000000001e-05 {"go.gc_duration_seconds",quantile="0.5",a="b"} 8.3835e-05 {"go.gc_duration_seconds",quantile="0.8", a="b"} 8.3835e-05 {"go.gc_duration_seconds", quantile="0.9", a="b"} 8.3835e-05 {"go.gc_duration_seconds", quantile="1.0", a="b" } 8.3835e-05 { "go.gc_duration_seconds", quantile="1.0", a="b" } 8.3835e-05 { "go.gc_duration_seconds", quantile= "1.0", a= "b", } 8.3835e-05 { "go.gc_duration_seconds", quantile = "1.0", a = "b" } 8.3835e-05 {"go.gc_duration_seconds_count"} 99 {"Heizölrückstoßabdämpfung 10€ metric with \"interesting\" {character\nchoices}","strange©™\n'quoted' \"name\""="6"} 10.0` exp := []expectedParse{ { m: "go.gc_duration_seconds", help: "A summary of the GC invocation durations.", }, { m: "go.gc_duration_seconds", typ: model.MetricTypeSummary, }, { m: `{"go.gc_duration_seconds",quantile="0"}`, v: 4.9351e-05, lset: labels.FromStrings("__name__", "go.gc_duration_seconds", "quantile", "0"), }, { m: `{"go.gc_duration_seconds",quantile="0.25",}`, v: 7.424100000000001e-05, lset: labels.FromStrings("__name__", "go.gc_duration_seconds", "quantile", "0.25"), }, { m: `{"go.gc_duration_seconds",quantile="0.5",a="b"}`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go.gc_duration_seconds", "quantile", "0.5", "a", "b"), }, { m: `{"go.gc_duration_seconds",quantile="0.8", a="b"}`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go.gc_duration_seconds", "quantile", "0.8", "a", "b"), }, { m: `{"go.gc_duration_seconds", quantile="0.9", a="b"}`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go.gc_duration_seconds", "quantile", "0.9", "a", "b"), }, { m: `{"go.gc_duration_seconds", quantile="1.0", a="b" }`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go.gc_duration_seconds", "quantile", "1.0", "a", "b"), }, { m: `{ "go.gc_duration_seconds", quantile="1.0", a="b" }`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go.gc_duration_seconds", "quantile", "1.0", "a", "b"), }, { m: `{ "go.gc_duration_seconds", quantile= "1.0", a= "b", }`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go.gc_duration_seconds", "quantile", "1.0", "a", "b"), }, { m: `{ "go.gc_duration_seconds", quantile = "1.0", a = "b" }`, v: 8.3835e-05, lset: labels.FromStrings("__name__", "go.gc_duration_seconds", "quantile", "1.0", "a", "b"), }, { m: `{"go.gc_duration_seconds_count"}`, v: 99, lset: labels.FromStrings("__name__", "go.gc_duration_seconds_count"), }, { m: `{"Heizölrückstoßabdämpfung 10€ metric with \"interesting\" {character\nchoices}","strange©™\n'quoted' \"name\""="6"}`, v: 10.0, lset: labels.FromStrings("__name__", `Heizölrückstoßabdämpfung 10€ metric with "interesting" {character choices}`, "strange©™\n'quoted' \"name\"", "6"), }, } p := NewPromParser([]byte(input), labels.NewSymbolTable()) checkParseResults(t, p, exp) } func TestPromParseErrors(t *testing.T) { cases := []struct { input string err string }{ { input: "a", err: "expected value after metric, got \"\\n\" (\"INVALID\") while parsing: \"a\\n\"", }, { input: "a{b='c'} 1\n", err: "expected label value, got \"'\" (\"INVALID\") while parsing: \"a{b='\"", }, { input: "a{b=\n", err: "expected label value, got \"\\n\" (\"INVALID\") while parsing: \"a{b=\\n\"", }, { input: "a{\xff=\"foo\"} 1\n", err: "expected label name, got \"\\xff\" (\"INVALID\") while parsing: \"a{\\xff\"", }, { input: "a{b=\"\xff\"} 1\n", err: "invalid UTF-8 label value: \"\\\"\\xff\\\"\"", }, { input: `{"a", "b = "c"}`, err: "expected equal, got \"c\\\"\" (\"LNAME\") while parsing: \"{\\\"a\\\", \\\"b = \\\"c\\\"\"", }, { input: `{"a",b\nc="d"} 1`, err: "expected equal, got \"\\\\\" (\"INVALID\") while parsing: \"{\\\"a\\\",b\\\\\"", }, { input: "a true\n", err: "strconv.ParseFloat: parsing \"true\": invalid syntax while parsing: \"a true\"", }, { input: "something_weird{problem=\"", err: "expected label value, got \"\\\"\\n\" (\"INVALID\") while parsing: \"something_weird{problem=\\\"\\n\"", }, { input: "empty_label_name{=\"\"} 0", err: "expected label name, got \"=\\\"\" (\"EQUAL\") while parsing: \"empty_label_name{=\\\"\"", }, { input: "foo 1_2\n", err: "unsupported character in float while parsing: \"foo 1_2\"", }, { input: "foo 0x1p-3\n", err: "unsupported character in float while parsing: \"foo 0x1p-3\"", }, { input: "foo 0x1P-3\n", err: "unsupported character in float while parsing: \"foo 0x1P-3\"", }, { input: "foo 0 1_2\n", err: "expected next entry after timestamp, got \"_\" (\"INVALID\") while parsing: \"foo 0 1_\"", }, { input: `{a="ok"} 1`, err: "metric name not set while parsing: \"{a=\\\"ok\\\"} 1\"", }, { input: "# TYPE #\n#EOF\n", err: "expected metric name after TYPE, got \"#\" (\"INVALID\") while parsing: \"# TYPE #\"", }, { input: "# HELP #\n#EOF\n", err: "expected metric name after HELP, got \"#\" (\"INVALID\") while parsing: \"# HELP #\"", }, } for i, c := range cases { p := NewPromParser([]byte(c.input), labels.NewSymbolTable()) var err error for err == nil { _, err = p.Next() } require.Error(t, err) require.Equal(t, c.err, err.Error(), "test %d", i) } } func TestPromNullByteHandling(t *testing.T) { cases := []struct { input string err string }{ { input: "null_byte_metric{a=\"abc\x00\"} 1", err: "", }, { input: "a{b=\"\x00ss\"} 1\n", err: "", }, { input: "a{b=\"\x00\"} 1\n", err: "", }, { input: "a{b=\"\x00\"} 1\n", err: "", }, { input: "a{b=\x00\"ssss\"} 1\n", err: "expected label value, got \"\\x00\" (\"INVALID\") while parsing: \"a{b=\\x00\"", }, { input: "a{b=\"\x00", err: "expected label value, got \"\\\"\\x00\\n\" (\"INVALID\") while parsing: \"a{b=\\\"\\x00\\n\"", }, { input: "a{b\x00=\"hiih\"} 1", err: "expected equal, got \"\\x00\" (\"INVALID\") while parsing: \"a{b\\x00\"", }, { input: "a\x00{b=\"ddd\"} 1", err: "expected value after metric, got \"\\x00\" (\"INVALID\") while parsing: \"a\\x00\"", }, { input: "a 0 1\x00", err: "expected next entry after timestamp, got \"\\x00\" (\"INVALID\") while parsing: \"a 0 1\\x00\"", }, } for i, c := range cases { p := NewPromParser([]byte(c.input), labels.NewSymbolTable()) var err error for err == nil { _, err = p.Next() } if c.err == "" { require.Equal(t, io.EOF, err, "test %d", i) continue } require.Error(t, err) require.Equal(t, c.err, err.Error(), "test %d", i) } } const ( promtestdataSampleCount = 410 ) func BenchmarkParse(b *testing.B) { for parserName, parser := range map[string]func([]byte, *labels.SymbolTable) Parser{ "prometheus": NewPromParser, "openmetrics": func(b []byte, st *labels.SymbolTable) Parser { return NewOpenMetricsParser(b, st) }, } { for _, fn := range []string{"promtestdata.txt", "promtestdata.nometa.txt"} { f, err := os.Open(fn) require.NoError(b, err) defer f.Close() buf, err := io.ReadAll(f) require.NoError(b, err) b.Run(parserName+"/no-decode-metric/"+fn, func(b *testing.B) { total := 0 b.SetBytes(int64(len(buf) / promtestdataSampleCount)) b.ReportAllocs() b.ResetTimer() st := labels.NewSymbolTable() for i := 0; i < b.N; i += promtestdataSampleCount { p := parser(buf, st) Outer: for i < b.N { t, err := p.Next() switch t { case EntryInvalid: if errors.Is(err, io.EOF) { break Outer } b.Fatal(err) case EntrySeries: m, _, _ := p.Series() total += len(m) i++ } } } _ = total }) b.Run(parserName+"/decode-metric/"+fn, func(b *testing.B) { total := 0 b.SetBytes(int64(len(buf) / promtestdataSampleCount)) b.ReportAllocs() b.ResetTimer() st := labels.NewSymbolTable() for i := 0; i < b.N; i += promtestdataSampleCount { p := parser(buf, st) Outer: for i < b.N { t, err := p.Next() switch t { case EntryInvalid: if errors.Is(err, io.EOF) { break Outer } b.Fatal(err) case EntrySeries: m, _, _ := p.Series() var res labels.Labels p.Metric(&res) total += len(m) i++ } } } _ = total }) b.Run(parserName+"/decode-metric-reuse/"+fn, func(b *testing.B) { total := 0 var res labels.Labels b.SetBytes(int64(len(buf) / promtestdataSampleCount)) b.ReportAllocs() b.ResetTimer() st := labels.NewSymbolTable() for i := 0; i < b.N; i += promtestdataSampleCount { p := parser(buf, st) Outer: for i < b.N { t, err := p.Next() switch t { case EntryInvalid: if errors.Is(err, io.EOF) { break Outer } b.Fatal(err) case EntrySeries: m, _, _ := p.Series() p.Metric(&res) total += len(m) i++ } } } _ = total }) b.Run("expfmt-text/"+fn, func(b *testing.B) { if parserName != "prometheus" { b.Skip() } b.SetBytes(int64(len(buf) / promtestdataSampleCount)) b.ReportAllocs() b.ResetTimer() total := 0 for i := 0; i < b.N; i += promtestdataSampleCount { decSamples := make(model.Vector, 0, 50) sdec := expfmt.SampleDecoder{ Dec: expfmt.NewDecoder(bytes.NewReader(buf), expfmt.NewFormat(expfmt.TypeTextPlain)), Opts: &expfmt.DecodeOptions{ Timestamp: model.TimeFromUnixNano(0), }, } for { if err = sdec.Decode(&decSamples); err != nil { break } total += len(decSamples) decSamples = decSamples[:0] } } _ = total }) } } } func BenchmarkGzip(b *testing.B) { for _, fn := range []string{"promtestdata.txt", "promtestdata.nometa.txt"} { b.Run(fn, func(b *testing.B) { f, err := os.Open(fn) require.NoError(b, err) defer f.Close() var buf bytes.Buffer gw := gzip.NewWriter(&buf) n, err := io.Copy(gw, f) require.NoError(b, err) require.NoError(b, gw.Close()) gbuf, err := io.ReadAll(&buf) require.NoError(b, err) k := b.N / promtestdataSampleCount b.ReportAllocs() b.SetBytes(n / promtestdataSampleCount) b.ResetTimer() total := 0 for i := 0; i < k; i++ { gr, err := gzip.NewReader(bytes.NewReader(gbuf)) require.NoError(b, err) d, err := io.ReadAll(gr) require.NoError(b, err) require.NoError(b, gr.Close()) total += len(d) } _ = total }) } }