// Copyright 2017 The OMetheus 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 ( "io" "testing" "github.com/prometheus/prometheus/pkg/labels" "github.com/prometheus/prometheus/util/testutil" ) func TestOpenMetricsParse(t *testing.T) { input := `# HELP go_gc_duration_seconds A summary of the GC invocation durations. # TYPE go_gc_duration_seconds summary # UNIT go_gc_duration_seconds seconds 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 # HELP nohelp1 # HELP help2 escape \ \n \\ \" \x chars # UNIT nounit go_gc_duration_seconds{quantile="1.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 123.123 # TYPE hh histogram hh_bucket{le="+Inf"} 1 # {} 4 # TYPE gh gaugehistogram gh_bucket{le="+Inf"} 1 # {} 4 # TYPE ii info ii{foo="bar"} 1 # TYPE ss stateset ss{ss="foo"} 1 ss{ss="bar"} 0 # TYPE un unknown _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" input += "\n# EOF\n" int64p := func(x int64) *int64 { return &x } exp := []struct { lset labels.Labels m string t *int64 v float64 typ MetricType help string unit string comment string }{ { m: "go_gc_duration_seconds", help: "A summary of the GC invocation durations.", }, { m: "go_gc_duration_seconds", typ: MetricTypeSummary, }, { m: "go_gc_duration_seconds", unit: "seconds", }, { 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: "nohelp1", help: "", }, { m: "help2", help: "escape \\ \n \\ \" \\x chars", }, { m: "nounit", unit: "", }, { 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: `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: MetricTypeGauge, }, { m: `go_goroutines`, v: 33, t: int64p(123123), lset: labels.FromStrings("__name__", "go_goroutines"), }, { m: "hh", typ: MetricTypeHistogram, }, { m: `hh_bucket{le="+Inf"}`, v: 1, lset: labels.FromStrings("__name__", "hh_bucket", "le", "+Inf"), }, { m: "gh", typ: MetricTypeGaugeHistogram, }, { m: `gh_bucket{le="+Inf"}`, v: 1, lset: labels.FromStrings("__name__", "gh_bucket", "le", "+Inf"), }, { m: "ii", typ: MetricTypeInfo, }, { m: `ii{foo="bar"}`, v: 1, lset: labels.FromStrings("__name__", "ii", "foo", "bar"), }, { m: "ss", typ: MetricTypeStateset, }, { m: `ss{ss="foo"}`, v: 1, lset: labels.FromStrings("__name__", "ss", "ss", "foo"), }, { m: `ss{ss="bar"}`, v: 0, lset: labels.FromStrings("__name__", "ss", "ss", "bar"), }, { m: "un", typ: MetricTypeUnknown, }, { 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 := NewOpenMetricsParser([]byte(input)) i := 0 var res labels.Labels for { et, err := p.Next() if err == io.EOF { break } testutil.Ok(t, err) switch et { case EntrySeries: m, ts, v := p.Series() p.Metric(&res) testutil.Equals(t, exp[i].m, string(m)) testutil.Equals(t, exp[i].t, ts) testutil.Equals(t, exp[i].v, v) testutil.Equals(t, exp[i].lset, res) res = res[:0] case EntryType: m, typ := p.Type() testutil.Equals(t, exp[i].m, string(m)) testutil.Equals(t, exp[i].typ, typ) case EntryHelp: m, h := p.Help() testutil.Equals(t, exp[i].m, string(m)) testutil.Equals(t, exp[i].help, string(h)) case EntryUnit: m, u := p.Unit() testutil.Equals(t, exp[i].m, string(m)) testutil.Equals(t, exp[i].unit, string(u)) case EntryComment: testutil.Equals(t, exp[i].comment, string(p.Comment())) } i++ } testutil.Equals(t, len(exp), i) } func TestOpenMetricsParseErrors(t *testing.T) { cases := []struct { input string err string }{ { input: "", err: "unexpected end of data, got \"EOF\"", }, { input: "a", err: "expected value after metric, got \"MNAME\"", }, { input: "\n", err: "\"INVALID\" \"\\n\" is not a valid start token", }, { input: " a 1\n", err: "\"INVALID\" \" \" is not a valid start token", }, { input: "9\n", err: "\"INVALID\" \"9\" is not a valid start token", }, { input: "# TYPE u untyped\n", err: "invalid metric type \"untyped\"", }, { input: "# TYPE c counter \n", err: "invalid metric type \"counter \"", }, { input: "# TYPE c counter\n", err: "\"INVALID\" \" \" is not a valid start token", }, { input: "# UNIT metric suffix\n", err: "unit not a suffix of metric \"metric\"", }, { input: "# UNIT metricsuffix suffix\n", err: "unit not a suffix of metric \"metricsuffix\"", }, { input: "# UNIT m suffix\n", err: "unit not a suffix of metric \"m\"", }, { input: "# HELP m\n", err: "expected text in HELP, got \"INVALID\"", }, { input: "a\t1\n", err: "expected value after metric, got \"MNAME\"", }, { input: "a 1\t2\n", err: "strconv.ParseFloat: parsing \"1\\t2\": invalid syntax", }, { input: "a 1 2 \n", err: "expected next entry after timestamp, got \"MNAME\"", }, { input: "a 1 2 #\n", err: "expected next entry after timestamp, got \"MNAME\"", }, { input: "a 1 1z\n", err: "strconv.ParseFloat: parsing \"1z\": invalid syntax", }, { input: " # EOF\n", err: "\"INVALID\" \" \" is not a valid start token", }, { input: "# EOF\na 1", err: "unexpected data after # EOF", }, { input: "# EOF\n\n", err: "unexpected data after # EOF", }, { input: "# EOFa 1", err: "unexpected data after # EOF", }, { input: "#\tTYPE c counter\n", err: "\"INVALID\" \"\\t\" is not a valid start token", }, { input: "# TYPE c counter\n", err: "invalid metric type \" counter\"", }, { input: "a 1 1 1\n", err: "expected next entry after timestamp, got \"MNAME\"", }, { input: "a{b='c'} 1\n", err: "expected label value, got \"INVALID\"", }, { input: "a{b=\"c\",} 1\n", err: "expected label name, got \"BCLOSE\"", }, { input: "a{,b=\"c\"} 1\n", err: "expected label name or left brace, got \"COMMA\"", }, { input: "a{b=\"c\"d=\"e\"} 1\n", err: "expected comma, got \"LNAME\"", }, { input: "a{b=\"c\",,d=\"e\"} 1\n", err: "expected label name, got \"COMMA\"", }, { input: "a{b=\n", err: "expected label value, got \"INVALID\"", }, { input: "a{\xff=\"foo\"} 1\n", err: "expected label name or left brace, got \"INVALID\"", }, { input: "a{b=\"\xff\"} 1\n", err: "invalid UTF-8 label value", }, { input: "a true\n", err: "strconv.ParseFloat: parsing \"true\": invalid syntax", }, { input: "something_weird{problem=\"", err: "expected label value, got \"INVALID\"", }, { input: "empty_label_name{=\"\"} 0", err: "expected label name or left brace, got \"EQUAL\"", }, } for i, c := range cases { p := NewOpenMetricsParser([]byte(c.input)) var err error for err == nil { _, err = p.Next() } testutil.Equals(t, c.err, err.Error(), "test %d", i) } } func TestOMNullByteHandling(t *testing.T) { cases := []struct { input string err string }{ { input: "null_byte_metric{a=\"abc\x00\"} 1\n# EOF\n", err: "", }, { input: "a{b=\"\x00ss\"} 1\n# EOF\n", err: "", }, { input: "a{b=\"\x00\"} 1\n# EOF\n", err: "", }, { input: "a{b=\"\x00\"} 1\n# EOF", err: "", }, { input: "a{b=\x00\"ssss\"} 1\n# EOF\n", err: "expected label value, got \"INVALID\"", }, { input: "a{b=\"\x00", err: "expected label value, got \"INVALID\"", }, { input: "a{b\x00=\"hiih\"} 1", err: "expected equal, got \"INVALID\"", }, { input: "a\x00{b=\"ddd\"} 1", err: "expected value after metric, got \"MNAME\"", }, } for i, c := range cases { p := NewOpenMetricsParser([]byte(c.input)) var err error for err == nil { _, err = p.Next() } if c.err == "" { testutil.Equals(t, io.EOF, err, "test %d", i) continue } testutil.Equals(t, c.err, err.Error(), "test %d", i) } }