diff --git a/changelog/24.0/24.0.0/summary.md b/changelog/24.0/24.0.0/summary.md index c3118314555..f6577d7f696 100644 --- a/changelog/24.0/24.0.0/summary.md +++ b/changelog/24.0/24.0.0/summary.md @@ -17,9 +17,10 @@ - [New `in_order_completion_pending_count` field in OnlineDDL outputs](#vttablet-onlineddl-in-order-completion-count) - [Tablet Shutdown Tracking and Connection Validation](#vttablet-tablet-shutdown-validation) - **[VTOrc](#minor-changes-vtorc)** - - [Deprecated VTOrc Metric Removed](#vtorc-deprecated-metric-removed) - - [Improved VTOrc Discovery Logging](#vtorc-improved-discovery-logging) - [New `--cell` Flag](#vtorc-cell-flag) + - [Improved VTOrc Discovery Logging](#vtorc-improved-discovery-logging) + - [Deprecated VTOrc Metric Removed](#vtorc-deprecated-metric-removed) + - [Deprecation of Snapshot Topology feature](#vtorc-snapshot-topology-deprecation) ## Major Changes @@ -93,13 +94,15 @@ Vitess now tracks when tablets cleanly shut down and validates tablet records be ### VTOrc -#### Deprecated VTOrc Metric Removed +#### New `--cell` Flag -The `discoverInstanceTimings` metric has been removed from VTOrc in v24.0.0. This metric was deprecated in v23. +VTOrc now supports a `--cell` flag that specifies which Vitess cell the VTOrc process is running in. The flag is optional in v24 but will be required in v25+, similar to VTGate's `--cell` flag. -**Migration**: Use `discoveryInstanceTimings` instead, which provides the same timing information for instance discovery actions (Backend, Instance, Other). +When provided, VTOrc validates that the cell exists in the topology service on startup. Without the flag, VTOrc logs a warning about the v25+ flag requirement. -**Impact**: Monitoring dashboards or alerting systems using `discoverInstanceTimings` must be updated to use `discoveryInstanceTimings`. +This enables future cross-cell problem validation, where VTOrc will be able to ask another cell to validate detected problems before taking recovery actions. The flag is currently validated but not yet used in VTOrc recovery logic. + +**Note**: If you're running VTOrc in a multi-cell deployment, start using the `--cell` flag now to prepare for the v25 requirement. #### Improved VTOrc Discovery Logging @@ -107,12 +110,21 @@ VTOrc's `DiscoverInstance` function now includes the tablet alias in all log mes This improvement makes it easier to identify and debug issues with specific tablets when discovery operations fail. -#### New `--cell` Flag +#### Deprecated VTOrc Metric Removed -VTOrc now supports a `--cell` flag that specifies which Vitess cell the VTOrc process is running in. The flag is optional in v24 but will be required in v25+, similar to VTGate's `--cell` flag. +The `DiscoverInstanceTimings` metric has been removed from VTOrc in v24. This metric was deprecated in v23. -When provided, VTOrc validates that the cell exists in the topology service on startup. Without the flag, VTOrc logs a warning about the v25+ flag requirement. +**Migration**: Use `DiscoveryInstanceTimings` instead, which provides the same timing information for instance discovery actions (Backend, Instance, Other). -This enables future cross-cell problem validation, where VTOrc will be able to ask another cell to validate detected problems before taking recovery actions. The flag is currently validated but not yet used in VTOrc recovery logic. +**Impact**: Monitoring dashboards or alerting systems using `DiscoverInstanceTimings` must be updated to use `DiscoveryInstanceTimings`. + +#### Deprecation of Snapshot Topology feature + +VTOrc's Snapshot Topology feature, which is enabled by setting `--snapshot-topology-interval` to a non-zero-value is deprecated as of v24 and the logic is planned for removal in v25. + +The lack of facilities to read the snapshots created by this feature coupled with the in-memory nature of VTOrc's backend means this logic has limited usefulness. This deprecation is explained and tracked in detail in https://github.com/vitessio/vitess/issues/18691. + +**Migration**: remove the VTOrc flag `--snapshot-topology-interval` before v25. + +**Impact**: VTOrc can no longer create snapshots of the topology in it's backend database. -**Note**: If you're running VTOrc in a multi-cell deployment, start using the `--cell` flag now to prepare for the v25 requirement. diff --git a/go/vt/vtorc/logic/vtorc.go b/go/vt/vtorc/logic/vtorc.go index 518be508e72..72c330b0cc0 100644 --- a/go/vt/vtorc/logic/vtorc.go +++ b/go/vt/vtorc/logic/vtorc.go @@ -259,6 +259,7 @@ func ContinuousDiscovery() { var recoveryEntrance int64 var snapshotTopologiesTick <-chan time.Time if config.GetSnapshotTopologyInterval() > 0 { + log.Warning("--snapshot-topology-interval is deprecated and will be removed in v25+") snapshotTopologiesTick = time.Tick(config.GetSnapshotTopologyInterval()) }