Skip to content

vtorc: update metrics in e2e test TestAPIEndpoints #18406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timvaillancourt merged 7 commits into from
Sep 23, 2025
Merged

vtorc: update metrics in e2e test TestAPIEndpoints #18406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c58ae5f
`vtorc`: update metrics in e2e test `TestAPIEndpoints`
timvaillancourt Jun 29, 2025
405a657
update metric name
timvaillancourt Jun 29, 2025
edf37fd
add `_bucket` suffix to timings metrics
timvaillancourt Jun 29, 2025
4f5c98b
fix typo metric
timvaillancourt Jun 29, 2025
7f7f5c4
fix typo metric
timvaillancourt Jun 29, 2025
33704bc
remove `vtorc_failed_recoveries`, there are no failures in test
timvaillancourt Jun 30, 2025
db69aae
add replacement metric name
timvaillancourt Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions changelog/23.0/23.0.0/summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
### Table of Contents

- **[Minor Changes](#minor-changes)**
- **[Deprecations](#deprecations)**
- [Metrics](#deprecated-metrics)
- **[Deletions](#deletions)**
- [Metrics](#deleted-metrics)
- **[New Metrics](#new-metrics)**
Expand All @@ -17,6 +19,14 @@

## <a id="minor-changes"/>Minor Changes</a>

### <a id="deprecations"/>Deprecations</a>

#### <a id="deprecated-metrics"/>Metrics</a>

| Component | Metric Name | Notes | Deprecation PR |
|:---------:|:-------------------------:|:--------------------------------------:|:-------------------------------------------------------:|
| `vtorc` | `DiscoverInstanceTimings` | Replaced by `DiscoveryInstanceTimings` | [#18406](https://github.com/vitessio/vitess/pull/18406) |

### <a id="deletions"/>Deletions</a>

#### <a id="deleted-metrics"/>Metrics</a>
Expand Down
25 changes: 25 additions & 0 deletions go/test/endtoend/vtorc/api/api_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,24 +110,49 @@ func TestAPIEndpoints(t *testing.T) {
t.Run("Check Vars and Metrics", func(t *testing.T) {
utils.CheckVarExists(t, vtorc, "AnalysisChangeWrite")
utils.CheckVarExists(t, vtorc, "AuditWrite")
utils.CheckVarExists(t, vtorc, "CurrentErrantGTIDCount")
utils.CheckVarExists(t, vtorc, "DetectedProblems")
utils.CheckVarExists(t, vtorc, "DiscoveriesAttempt")
utils.CheckVarExists(t, vtorc, "DiscoveriesFail")
utils.CheckVarExists(t, vtorc, "DiscoveriesInstancePollSecondsExceeded")
utils.CheckVarExists(t, vtorc, "DiscoveriesQueueLength")
utils.CheckVarExists(t, vtorc, "DiscoveriesRecentCount")
utils.CheckVarExists(t, vtorc, "DiscoveryWorkers")
utils.CheckVarExists(t, vtorc, "DiscoveryWorkersActive")
utils.CheckVarExists(t, vtorc, "DiscoveryInstanceTimings")
utils.CheckVarExists(t, vtorc, "FailedRecoveries")
utils.CheckVarExists(t, vtorc, "InstanceRead")
utils.CheckVarExists(t, vtorc, "InstanceReadTopology")
utils.CheckVarExists(t, vtorc, "PendingRecoveries")
utils.CheckVarExists(t, vtorc, "RecoveriesCount")
utils.CheckVarExists(t, vtorc, "ShardLocksActive")
utils.CheckVarExists(t, vtorc, "ShardLockTimings")
utils.CheckVarExists(t, vtorc, "SuccessfulRecoveries")
utils.CheckVarExists(t, vtorc, "TabletsWatchedByCell")
utils.CheckVarExists(t, vtorc, "TabletsWatchedByShard")

// Metrics registered in prometheus
utils.CheckMetricExists(t, vtorc, "vtorc_analysis_change_write")
utils.CheckMetricExists(t, vtorc, "vtorc_audit_write")
utils.CheckMetricExists(t, vtorc, "vtorc_detected_problems")
utils.CheckMetricExists(t, vtorc, "vtorc_discoveries_attempt")
utils.CheckMetricExists(t, vtorc, "vtorc_discoveries_fail")
utils.CheckMetricExists(t, vtorc, "vtorc_discoveries_instance_poll_seconds_exceeded")
utils.CheckMetricExists(t, vtorc, "vtorc_discoveries_queue_length")
utils.CheckMetricExists(t, vtorc, "vtorc_discoveries_recent_count")
utils.CheckMetricExists(t, vtorc, "vtorc_discovery_instance_timings_bucket")
utils.CheckMetricExists(t, vtorc, "vtorc_discovery_workers")
utils.CheckMetricExists(t, vtorc, "vtorc_discovery_workers_active")
utils.CheckMetricExists(t, vtorc, "vtorc_errant_gtid_tablet_count")
utils.CheckMetricExists(t, vtorc, "vtorc_instance_read")
utils.CheckMetricExists(t, vtorc, "vtorc_instance_read_topology")
utils.CheckMetricExists(t, vtorc, "vtorc_pending_recoveries")
utils.CheckMetricExists(t, vtorc, "vtorc_recoveries_count")
utils.CheckMetricExists(t, vtorc, "vtorc_shard_locks_active")
utils.CheckMetricExists(t, vtorc, "vtorc_shard_lock_timings_bucket")
utils.CheckMetricExists(t, vtorc, "vtorc_successful_recoveries")
utils.CheckMetricExists(t, vtorc, "vtorc_tablets_watched_by_cell")
utils.CheckMetricExists(t, vtorc, "vtorc_tablets_watched_by_shard")
})

t.Run("Disable Recoveries API", func(t *testing.T) {
Expand Down
11 changes: 9 additions & 2 deletions go/vt/vtorc/logic/vtorc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,10 @@ var (
discoveryWorkersGauge = stats.NewGauge("DiscoveryWorkers", "Number of discovery workers")
discoveryWorkersActiveGauge = stats.NewGauge("DiscoveryWorkersActive", "Number of discovery workers actively discovering tablets")

discoverInstanceTimingsActions = []string{"Backend", "Instance", "Other"}
discoverInstanceTimings = stats.NewTimings("DiscoverInstanceTimings", "Timings for instance discovery actions", "Action", discoverInstanceTimingsActions...)
discoveryInstanceTimingsActions = []string{"Backend", "Instance", "Other"}
discoveryInstanceTimings = stats.NewTimings("DiscoveryInstanceTimings", "Timings for instance discovery actions", "Action", discoveryInstanceTimingsActions...)
// TODO: deprecate in v24
discoverInstanceTimings = stats.NewTimings("DiscoverInstanceTimings", "Timings for instance discovery actions", "Action", discoveryInstanceTimingsActions...)
)

var discoveryMetrics = collection.CreateOrReturnCollection(DiscoveryMetricsName)
Expand Down Expand Up @@ -197,10 +199,15 @@ func DiscoverInstance(tabletAlias string, forceDiscovery bool) {
instanceLatency := latency.Elapsed("instance")
otherLatency := totalLatency - (backendLatency + instanceLatency)

// TODO: deprecate in v24
discoverInstanceTimings.Add("Backend", backendLatency)
discoverInstanceTimings.Add("Instance", instanceLatency)
discoverInstanceTimings.Add("Other", otherLatency)

discoveryInstanceTimings.Add("Backend", backendLatency)
discoveryInstanceTimings.Add("Instance", instanceLatency)
discoveryInstanceTimings.Add("Other", otherLatency)

if forceDiscovery {
log.Infof("Force discovered - %+v, err - %v", instance, err)
}
Expand Down
Loading