backup: Export tenant backup schedule metric #141156
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| // Copyright 2025 The Cockroach Authors. | ||
| // | ||
| // Use of this software is governed by the CockroachDB Software License | ||
| // included in the /LICENSE file. | ||
|
|
||
| package backup | ||
|
|
||
| import ( | ||
| "context" | ||
| "github.com/cockroachdb/cockroach/pkg/util/leaktest" | ||
| "testing" | ||
|
|
||
| "github.com/cockroachdb/cockroach/pkg/backup/backuppb" | ||
| "github.com/cockroachdb/cockroach/pkg/jobs" | ||
| "github.com/cockroachdb/cockroach/pkg/jobs/jobspb" | ||
| "github.com/cockroachdb/cockroach/pkg/roachpb" | ||
| "github.com/cockroachdb/cockroach/pkg/util/hlc" | ||
| "github.com/cockroachdb/cockroach/pkg/util/metric" | ||
| pbtypes "github.com/gogo/protobuf/types" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestBackupSucceededUpdatesMetrics(t *testing.T) { | ||
| defer leaktest.AfterTest(t)() | ||
| ctx := context.Background() | ||
| executor := &scheduledBackupExecutor{ | ||
| metrics: backupMetrics{ | ||
| RpoMetric: metric.NewGauge(metric.Metadata{}), | ||
| RpoTenantMetric: metric.NewExportedGaugeVec(metric.Metadata{}, []string{"tenant_id"}), | ||
| }, | ||
| } | ||
|
|
||
| t.Run("updates RPO metric", func(t *testing.T) { | ||
| schedule := createSchedule(t, true) | ||
| endTime := hlc.Timestamp{WallTime: hlc.UnixNano()} | ||
| details := jobspb.BackupDetails{EndTime: endTime} | ||
|
|
||
| err := executor.backupSucceeded(ctx, nil, schedule, details, nil) | ||
| require.NoError(t, err) | ||
| require.Equal(t, endTime.GoTime().Unix(), executor.metrics.RpoMetric.Value()) | ||
| }) | ||
|
|
||
| t.Run("updates RPO tenant metric", func(t *testing.T) { | ||
| schedule := createSchedule(t, true) | ||
| tenantIDs := mustMakeTenantIDs(t, 1, 2) | ||
| endTime := hlc.Timestamp{WallTime: hlc.UnixNano()} | ||
| details := jobspb.BackupDetails{ | ||
| EndTime: endTime, | ||
| SpecificTenantIds: tenantIDs, | ||
| } | ||
|
|
||
| err := executor.backupSucceeded(ctx, nil, schedule, details, nil) | ||
| require.NoError(t, err) | ||
|
|
||
| expectedTenantIDs := []string{"system", "2"} | ||
| verifyRPOTenantMetricLabels(t, executor.metrics.RpoTenantMetric, expectedTenantIDs) | ||
| verifyRPOTenantMetricGaugeValue(t, executor.metrics.RpoTenantMetric, details.EndTime) | ||
| }) | ||
| } | ||
|
|
||
| func createSchedule(t *testing.T, updatesLastBackupMetric bool) *jobs.ScheduledJob { | ||
| schedule := jobs.NewScheduledJob(nil) | ||
|
|
||
| args := &backuppb.ScheduledBackupExecutionArgs{ | ||
| UpdatesLastBackupMetric: updatesLastBackupMetric, | ||
| } | ||
| any, err := pbtypes.MarshalAny(args) | ||
| require.NoError(t, err) | ||
| schedule.SetExecutionDetails(schedule.ExecutorType(), jobspb.ExecutionArguments{Args: any}) | ||
| return schedule | ||
| } | ||
|
|
||
| func mustMakeTenantIDs(t *testing.T, ids ...int) []roachpb.TenantID { | ||
| var tenantIDs []roachpb.TenantID | ||
| for _, id := range ids { | ||
| tid, err := roachpb.MakeTenantID(uint64(id)) | ||
| require.NoError(t, err) | ||
| tenantIDs = append(tenantIDs, tid) | ||
| } | ||
| return tenantIDs | ||
| } | ||
|
|
||
| func verifyRPOTenantMetricLabels( | ||
|
There was a problem hiding this comment. could you also pass in and verify the expected end time? |
||
| t *testing.T, metric *metric.GaugeVec, expectedTenantIDs []string, | ||
| ) { | ||
| prometheusMetrics := metric.ToPrometheusMetrics() | ||
| var actualTenantIDs []string | ||
| for _, promMetric := range prometheusMetrics { | ||
| labels := promMetric.GetLabel() | ||
| for _, label := range labels { | ||
| if label.GetName() == "tenant_id" { | ||
| actualTenantIDs = append(actualTenantIDs, label.GetValue()) | ||
| } | ||
| } | ||
| } | ||
| require.ElementsMatch(t, expectedTenantIDs, actualTenantIDs) | ||
| } | ||
|
|
||
| func verifyRPOTenantMetricGaugeValue(t *testing.T, metric *metric.GaugeVec, endTime hlc.Timestamp) { | ||
| prometheusMetrics := metric.ToPrometheusMetrics() | ||
| for _, promMetric := range prometheusMetrics { | ||
| value := promMetric.Gauge.GetValue() | ||
| require.Equal(t, float64(endTime.GoTime().Unix()), value) | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: also verify that
executor.metrics.RpoMetric.Value()was also updated in this case?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think there is a
Value()method in RpoMetric. I verified the Gauge metric value in a separate function.