This repository has been archived by the owner on Apr 2, 2024. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds E2E tests for evaluating recording rules.
Signed-off-by: Harkishen-Singh <harkishensingh@hotmail.com> This commit adds an E2E test that evaluates 2 samples of a constant timestamp and checks for the recording metric name and the new sample in the database.
- Loading branch information
1 parent
3fb6f85
commit 6dc1a15
Showing
11 changed files
with
329 additions
and
280 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| // This file and its contents are licensed under the Apache License 2.0. | ||
| // Please see the included NOTICE for copyright information and | ||
| // LICENSE for a copy of the license. | ||
|
|
||
| package end_to_end_tests | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/go-kit/log" | ||
| "github.com/jackc/pgx/v4/pgxpool" | ||
| "github.com/prometheus/client_golang/prometheus" | ||
| prom_rules "github.com/prometheus/prometheus/rules" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/timescale/promscale/pkg/prompb" | ||
|
|
||
| "github.com/timescale/promscale/pkg/pgclient" | ||
| "github.com/timescale/promscale/pkg/pgmodel/cache" | ||
| "github.com/timescale/promscale/pkg/query" | ||
| "github.com/timescale/promscale/pkg/rules" | ||
| "github.com/timescale/promscale/pkg/tenancy" | ||
| ) | ||
|
|
||
| const RecordingRulesEvalConfigPath = "../testdata/rules/config.recording_rules_eval.yaml" | ||
|
|
||
| func TestRecordingRulesEval(t *testing.T) { | ||
| withDB(t, *testDatabase, func(db *pgxpool.Pool, t testing.TB) { | ||
| conf := &pgclient.Config{ | ||
| CacheConfig: cache.DefaultConfig, | ||
| WriteConnectionsPerProc: 4, | ||
| MaxConnections: -1, | ||
| } | ||
|
|
||
| pgClient, err := pgclient.NewClientWithPool(conf, 1, db, tenancy.NewNoopAuthorizer(), false) | ||
| require.NoError(t, err) | ||
| defer pgClient.Close() | ||
| err = pgClient.InitPromQLEngine(&query.Config{ | ||
| MaxQueryTimeout: query.DefaultQueryTimeout, | ||
| EnabledFeatureMap: map[string]struct{}{"promql-at-modifier": {}}, | ||
| SubQueryStepInterval: query.DefaultSubqueryStepInterval, | ||
| LookBackDelta: query.DefaultLookBackDelta, | ||
| MaxSamples: query.DefaultMaxSamples, | ||
| MaxPointsPerTs: 11000, | ||
| }) | ||
| require.NoError(t, err) | ||
|
|
||
| ingestor := pgClient.Ingestor() | ||
| ts := tsToSeconds(generateSmallTimeseries(), time.Second) // Converts ts of samples into seconds. | ||
| _, _, err = ingestor.Ingest(context.Background(), newWriteRequestWithTs(ts)) | ||
| require.NoError(t, err) | ||
|
|
||
| rulesCfg := &rules.Config{ | ||
| NotificationQueueCapacity: rules.DefaultNotificationQueueCapacity, | ||
| OutageTolerance: rules.DefaultOutageTolerance, | ||
| ForGracePeriod: rules.DefaultForGracePeriod, | ||
| ResendDelay: rules.DefaultResendDelay, | ||
| PrometheusConfigAddress: RecordingRulesEvalConfigPath, | ||
| } | ||
| require.NoError(t, rules.Validate(rulesCfg)) | ||
| require.True(t, rulesCfg.ContainsRules()) | ||
|
|
||
| ruleCtx, stopRuler := context.WithCancel(context.Background()) | ||
| defer stopRuler() | ||
|
|
||
| manager, err := rules.NewManager(ruleCtx, prometheus.NewRegistry(), pgClient, rulesCfg) | ||
| require.NoError(t, err) | ||
|
|
||
| require.NotNil(t, rulesCfg.PrometheusConfig) | ||
|
|
||
| manager.WithPostRulesProcess(func(*prom_rules.Group, time.Time, log.Logger) error { | ||
| defer func() { | ||
| stopRuler() // Cancels the context so that the blocking manager.Run() is released when the test finishes. | ||
| }() | ||
| // Check if recording rule as a metric exists in metric catalog table. | ||
| var exists bool | ||
| err := db.QueryRow(context.Background(), "select count(*)>0 from _prom_catalog.metric where metric_name = 'test_rule'").Scan(&exists) | ||
| require.NoError(t, err) | ||
| require.True(t, exists) | ||
|
|
||
| // Check if the sum is right. | ||
| expected := 0.9 | ||
| var value float64 | ||
| err = db.QueryRow(context.Background(), "select value from prom_data.test_rule order by time limit 1").Scan(&value) | ||
| require.NoError(t, err) | ||
| require.Equal(t, expected, value) | ||
|
|
||
| return nil | ||
| }) | ||
| require.NoError(t, manager.ApplyConfig(rulesCfg.PrometheusConfig)) | ||
| require.NoError(t, manager.Run(), "error running rules manager") // This is blocking. It will be released after stopRuler() in defer func. | ||
| }) | ||
| } | ||
|
|
||
| func tsToSeconds(ts []prompb.TimeSeries, multiplier time.Duration) []prompb.TimeSeries { | ||
| for i := range ts { | ||
| for j := range ts[i].Samples { | ||
| ts[i].Samples[j].Timestamp *= multiplier.Milliseconds() | ||
| } | ||
| } | ||
| return ts | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| global: | ||
| evaluation_interval: 100ms | ||
|
|
||
| rule_files: | ||
| - rules.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| groups: | ||
| - name: e2e | ||
| rules: | ||
| - record: test_rule | ||
| expr: firstMetric @ 4 + firstMetric @ 5 | ||
| labels: | ||
| kind: recording |