// Copyright 2020 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 main import ( "context" "math" "sort" "testing" "time" "github.com/stretchr/testify/require" "github.com/prometheus/prometheus/model/labels" "github.com/prometheus/prometheus/storage" "github.com/prometheus/prometheus/tsdb" "github.com/prometheus/prometheus/tsdb/chunkenc" "github.com/prometheus/prometheus/util/testutil" ) type backfillSample struct { Timestamp int64 Value float64 Labels labels.Labels } func sortSamples(samples []backfillSample) { sort.Slice(samples, func(x, y int) bool { sx, sy := samples[x], samples[y] if sx.Timestamp != sy.Timestamp { return sx.Timestamp < sy.Timestamp } return sx.Value < sy.Value }) } func queryAllSeries(t testing.TB, q storage.Querier, expectedMinTime, expectedMaxTime int64) []backfillSample { ss := q.Select(context.Background(), false, nil, labels.MustNewMatcher(labels.MatchRegexp, "", ".*")) samples := []backfillSample{} for ss.Next() { series := ss.At() it := series.Iterator(nil) require.NoError(t, it.Err()) for it.Next() == chunkenc.ValFloat { ts, v := it.At() samples = append(samples, backfillSample{Timestamp: ts, Value: v, Labels: series.Labels()}) } } return samples } func testBlocks(t *testing.T, db *tsdb.DB, expectedMinTime, expectedMaxTime, expectedBlockDuration int64, expectedSamples []backfillSample, expectedNumBlocks int) { blocks := db.Blocks() require.Len(t, blocks, expectedNumBlocks, "did not create correct number of blocks") for i, block := range blocks { require.Equal(t, block.MinTime()/expectedBlockDuration, (block.MaxTime()-1)/expectedBlockDuration, "block %d contains data outside of one aligned block duration", i) } q, err := db.Querier(math.MinInt64, math.MaxInt64) require.NoError(t, err) defer func() { require.NoError(t, q.Close()) }() allSamples := queryAllSeries(t, q, expectedMinTime, expectedMaxTime) sortSamples(allSamples) sortSamples(expectedSamples) testutil.RequireEqual(t, expectedSamples, allSamples, "did not create correct samples") if len(allSamples) > 0 { require.Equal(t, expectedMinTime, allSamples[0].Timestamp, "timestamp of first sample is not the expected minimum time") require.Equal(t, expectedMaxTime, allSamples[len(allSamples)-1].Timestamp, "timestamp of last sample is not the expected maximum time") } } func TestBackfill(t *testing.T) { t.Parallel() tests := []struct { ToParse string IsOk bool Description string MaxSamplesInAppender int MaxBlockDuration time.Duration Labels map[string]string Expected struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample } }{ { ToParse: `# EOF`, IsOk: true, Description: "Empty file.", MaxSamplesInAppender: 5000, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: math.MaxInt64, MaxTime: math.MinInt64, NumBlocks: 0, BlockDuration: tsdb.DefaultBlockDuration, Samples: []backfillSample{}, }, }, { ToParse: `# HELP http_requests_total The total number of HTTP requests. # TYPE http_requests_total counter http_requests_total{code="200"} 1021 1565133713.989 http_requests_total{code="400"} 1 1565133713.990 # EOF `, IsOk: true, Description: "Multiple samples with different timestamp for different series.", MaxSamplesInAppender: 5000, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: 1565133713989, MaxTime: 1565133713990, NumBlocks: 1, BlockDuration: tsdb.DefaultBlockDuration, Samples: []backfillSample{ { Timestamp: 1565133713989, Value: 1021, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1565133713990, Value: 1, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "400"), }, }, }, }, { ToParse: `# HELP http_requests_total The total number of HTTP requests. # TYPE http_requests_total counter http_requests_total{code="200"} 1021 1565133713.989 http_requests_total{code="200"} 1022 1565392913.989 http_requests_total{code="200"} 1023 1565652113.989 # EOF `, IsOk: true, Description: "Multiple samples separated by 3 days.", MaxSamplesInAppender: 5000, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: 1565133713989, MaxTime: 1565652113989, NumBlocks: 3, BlockDuration: tsdb.DefaultBlockDuration, Samples: []backfillSample{ { Timestamp: 1565133713989, Value: 1021, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1565392913989, Value: 1022, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1565652113989, Value: 1023, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, }, }, }, { ToParse: `# TYPE go info go_info{version="go1.15.3"} 1 1565392913.989 # TYPE http_requests_total counter http_requests_total{code="200"} 1021 1565133713.989 # EOF `, IsOk: true, Description: "Unordered samples from multiple series, which end in different blocks.", MaxSamplesInAppender: 5000, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: 1565133713989, MaxTime: 1565392913989, NumBlocks: 2, BlockDuration: tsdb.DefaultBlockDuration, Samples: []backfillSample{ { Timestamp: 1565133713989, Value: 1021, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1565392913989, Value: 1, Labels: labels.FromStrings("__name__", "go_info", "version", "go1.15.3"), }, }, }, }, { ToParse: `# HELP http_requests_total The total number of HTTP requests. # TYPE http_requests_total counter http_requests_total{code="200"} 1021 1565133713.989 http_requests_total{code="200"} 1 1565133714.989 http_requests_total{code="400"} 2 1565133715.989 # EOF `, IsOk: true, Description: "Multiple samples with different timestamp for the same series.", MaxSamplesInAppender: 5000, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: 1565133713989, MaxTime: 1565133715989, NumBlocks: 1, BlockDuration: tsdb.DefaultBlockDuration, Samples: []backfillSample{ { Timestamp: 1565133713989, Value: 1021, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1565133714989, Value: 1, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1565133715989, Value: 2, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "400"), }, }, }, }, { ToParse: `# HELP http_requests_total The total number of HTTP requests. # TYPE http_requests_total counter http_requests_total{code="200"} 1021 1624463088.000 http_requests_total{code="200"} 1 1627055153.000 http_requests_total{code="400"} 2 1627056153.000 # EOF `, IsOk: true, Description: "Long maximum block duration puts all data into one block.", MaxSamplesInAppender: 5000, MaxBlockDuration: 2048 * time.Hour, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: 1624463088000, MaxTime: 1627056153000, NumBlocks: 1, BlockDuration: int64(1458 * time.Hour / time.Millisecond), Samples: []backfillSample{ { Timestamp: 1624463088000, Value: 1021, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1627055153000, Value: 1, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1627056153000, Value: 2, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "400"), }, }, }, }, { ToParse: `# HELP http_requests_total The total number of HTTP requests. # TYPE http_requests_total counter http_requests_total{code="200"} 1 1624463088.000 http_requests_total{code="200"} 2 1629503088.000 http_requests_total{code="200"} 3 1629863088.000 # EOF `, IsOk: true, Description: "Long maximum block duration puts all data into two blocks.", MaxSamplesInAppender: 5000, MaxBlockDuration: 2048 * time.Hour, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: 1624463088000, MaxTime: 1629863088000, NumBlocks: 2, BlockDuration: int64(1458 * time.Hour / time.Millisecond), Samples: []backfillSample{ { Timestamp: 1624463088000, Value: 1, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1629503088000, Value: 2, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1629863088000, Value: 3, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, }, }, }, { ToParse: `# HELP http_requests_total The total number of HTTP requests. # TYPE http_requests_total counter http_requests_total{code="200"} 1 1624463088.000 http_requests_total{code="200"} 2 1765943088.000 http_requests_total{code="200"} 3 1768463088.000 # EOF `, IsOk: true, Description: "Maximum block duration longer than longest possible duration, uses largest duration, puts all data into two blocks.", MaxSamplesInAppender: 5000, MaxBlockDuration: 200000 * time.Hour, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: 1624463088000, MaxTime: 1768463088000, NumBlocks: 2, BlockDuration: int64(39366 * time.Hour / time.Millisecond), Samples: []backfillSample{ { Timestamp: 1624463088000, Value: 1, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1765943088000, Value: 2, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1768463088000, Value: 3, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, }, }, }, { ToParse: `# HELP http_requests_total The total number of HTTP requests. # TYPE http_requests_total counter http_requests_total{code="200"} 1021 1565133713.989 http_requests_total{code="200"} 1022 1565144513.989 http_requests_total{code="400"} 2 1565155313.989 http_requests_total{code="400"} 1 1565166113.989 # EOF `, IsOk: true, Description: "Multiple samples that end up in different blocks.", MaxSamplesInAppender: 5000, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: 1565133713989, MaxTime: 1565166113989, NumBlocks: 4, BlockDuration: tsdb.DefaultBlockDuration, Samples: []backfillSample{ { Timestamp: 1565133713989, Value: 1021, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1565144513989, Value: 1022, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1565155313989, Value: 2, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "400"), }, { Timestamp: 1565166113989, Value: 1, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "400"), }, }, }, }, { ToParse: `# HELP http_requests_total The total number of HTTP requests. # TYPE http_requests_total counter http_requests_total{code="200"} 1021 1565133713.989 http_requests_total{code="200"} 1022 1565133714 http_requests_total{code="200"} 1023 1565133716 http_requests_total{code="200"} 1022 1565144513.989 http_requests_total{code="400"} 2 1565155313.989 http_requests_total{code="400"} 3 1565155314 http_requests_total{code="400"} 1 1565166113.989 # EOF `, IsOk: true, Description: "Number of samples are greater than the sample batch size.", MaxSamplesInAppender: 2, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: 1565133713989, MaxTime: 1565166113989, NumBlocks: 4, BlockDuration: tsdb.DefaultBlockDuration, Samples: []backfillSample{ { Timestamp: 1565133713989, Value: 1021, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1565133714000, Value: 1022, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1565133716000, Value: 1023, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1565144513989, Value: 1022, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 1565155313989, Value: 2, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "400"), }, { Timestamp: 1565155314000, Value: 3, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "400"), }, { Timestamp: 1565166113989, Value: 1, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "400"), }, }, }, }, { // For https://github.com/prometheus/prometheus/issues/8476. ToParse: `# HELP http_requests_total The total number of HTTP requests. # TYPE http_requests_total counter http_requests_total{code="200"} 1021 0 http_requests_total{code="200"} 1022 7199 http_requests_total{code="400"} 1023 0 http_requests_total{code="400"} 1024 7199 # EOF `, IsOk: true, Description: "One series spanning 2h in same block should not cause problems to other series.", MaxSamplesInAppender: 1, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: 0, MaxTime: 7199000, NumBlocks: 1, BlockDuration: tsdb.DefaultBlockDuration, Samples: []backfillSample{ { Timestamp: 0, Value: 1021, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 7199000, Value: 1022, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200"), }, { Timestamp: 0, Value: 1023, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "400"), }, { Timestamp: 7199000, Value: 1024, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "400"), }, }, }, }, { ToParse: `no_help_no_type{foo="bar"} 42 6900 # EOF `, IsOk: true, Description: "Sample with no #HELP or #TYPE keyword.", MaxSamplesInAppender: 5000, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: 6900000, MaxTime: 6900000, NumBlocks: 1, BlockDuration: tsdb.DefaultBlockDuration, Samples: []backfillSample{ { Timestamp: 6900000, Value: 42, Labels: labels.FromStrings("__name__", "no_help_no_type", "foo", "bar"), }, }, }, }, { ToParse: `no_newline_after_eof 42 6900 # EOF`, IsOk: true, Description: "Sample without newline after # EOF.", MaxSamplesInAppender: 5000, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: 6900000, MaxTime: 6900000, NumBlocks: 1, BlockDuration: tsdb.DefaultBlockDuration, Samples: []backfillSample{ { Timestamp: 6900000, Value: 42, Labels: labels.FromStrings("__name__", "no_newline_after_eof"), }, }, }, }, { ToParse: `bare_metric 42.24 1001 # EOF `, IsOk: true, Description: "Bare sample.", MaxSamplesInAppender: 5000, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: 1001000, MaxTime: 1001000, NumBlocks: 1, BlockDuration: tsdb.DefaultBlockDuration, Samples: []backfillSample{ { Timestamp: 1001000, Value: 42.24, Labels: labels.FromStrings("__name__", "bare_metric"), }, }, }, }, { ToParse: `# HELP http_requests_total The total number of HTTP requests. # TYPE http_requests_total counter http_requests_total{code="200"} 1 1624463088.000 http_requests_total{code="200"} 2 1629503088.000 http_requests_total{code="200"} 3 1629863088.000 # EOF `, IsOk: true, Description: "Sample with external labels.", MaxSamplesInAppender: 5000, MaxBlockDuration: 2048 * time.Hour, Labels: map[string]string{"cluster_id": "123", "org_id": "999"}, Expected: struct { MinTime int64 MaxTime int64 NumBlocks int BlockDuration int64 Samples []backfillSample }{ MinTime: 1624463088000, MaxTime: 1629863088000, NumBlocks: 2, BlockDuration: int64(1458 * time.Hour / time.Millisecond), Samples: []backfillSample{ { Timestamp: 1624463088000, Value: 1, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200", "cluster_id", "123", "org_id", "999"), }, { Timestamp: 1629503088000, Value: 2, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200", "cluster_id", "123", "org_id", "999"), }, { Timestamp: 1629863088000, Value: 3, Labels: labels.FromStrings("__name__", "http_requests_total", "code", "200", "cluster_id", "123", "org_id", "999"), }, }, }, }, { ToParse: `# HELP rpc_duration_seconds A summary of the RPC duration in seconds. # TYPE rpc_duration_seconds summary rpc_duration_seconds{quantile="0.01"} 3102 rpc_duration_seconds{quantile="0.05"} 3272 # EOF `, IsOk: false, Description: "Does not have timestamp.", }, { ToParse: `# HELP bad_metric This a bad metric # TYPE bad_metric bad_type bad_metric{type="has a bad type information"} 0.0 111 # EOF `, IsOk: false, Description: "Has a bad type information.", }, { ToParse: `# HELP no_nl This test has no newline so will fail # TYPE no_nl gauge no_nl{type="no newline"} # EOF `, IsOk: false, Description: "No newline.", }, { ToParse: `# HELP no_eof This test has no EOF so will fail # TYPE no_eof gauge no_eof 1 1 `, IsOk: false, Description: "No EOF.", }, { ToParse: `# HELP after_eof There is data after EOF. # TYPE after_eof gauge after_eof 1 1 # EOF after_eof 1 2 `, IsOk: false, Description: "Data after EOF.", }, } for _, test := range tests { t.Run(test.Description, func(t *testing.T) { t.Parallel() t.Logf("Test:%s", test.Description) outputDir := t.TempDir() err := backfill(test.MaxSamplesInAppender, []byte(test.ToParse), outputDir, false, false, test.MaxBlockDuration, test.Labels) if !test.IsOk { require.Error(t, err, test.Description) return } require.NoError(t, err) options := tsdb.DefaultOptions() options.RetentionDuration = int64(10 * 365 * 24 * time.Hour / time.Millisecond) // maximum duration tests require a long retention db, err := tsdb.Open(outputDir, nil, nil, options, nil) require.NoError(t, err) defer func() { require.NoError(t, db.Close()) }() testBlocks(t, db, test.Expected.MinTime, test.Expected.MaxTime, test.Expected.BlockDuration, test.Expected.Samples, test.Expected.NumBlocks) }) } }