Skip to content

Conversation

@timvaillancourt
Copy link
Contributor

@timvaillancourt timvaillancourt commented Jun 26, 2025

Description

This PR move the shard primary timestamp in VTOrc to be represented as a real time.Time, not just a string (that is currently only compared with != and ==)

While updating this, I noticed the .GetTime() method of rows in sqlutils is broken. It seems the way time.Time is represented as .String() changed since the time this code was written. We've been unaffected by this breakage because, before this PR, .GetTime() was called in a single place where we never use the value, so we don't know it's broken (an empty time.Time{}). See unit tests for more context

Related Issue(s)

Aides in implementation of #18337. Aside from this, having a time-comparable timestamp will aid in a future feature I would like to add

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

@timvaillancourt timvaillancourt added Type: Internal Cleanup Component: VTorc Vitess Orchestrator integration labels Jun 26, 2025
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Jun 26, 2025

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Jun 26, 2025
@github-actions github-actions bot added this to the v23.0.0 milestone Jun 26, 2025
Signed-off-by: Tim Vaillancourt <[email protected]>
@timvaillancourt timvaillancourt removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Jun 26, 2025
Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
@timvaillancourt timvaillancourt marked this pull request as ready for review June 26, 2025 00:50
@codecov
Copy link

codecov bot commented Jun 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.49%. Comparing base (fae2b51) to head (32f9a22).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #18401      +/-   ##
==========================================
- Coverage   67.49%   67.49%   -0.01%     
==========================================
  Files        1603     1603              
  Lines      262495   262495              
==========================================
- Hits       177180   177170      -10     
- Misses      85315    85325      +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@timvaillancourt
Copy link
Contributor Author

timvaillancourt commented Jun 26, 2025

There is a minor memory implication to this. In the current approach, and empty timestamp is stored as just "". In this new approach we're always storing a full timestamp, just a zero-ed out one if it's empty

If this is a concern I could use *time.Time instead of time.Time (and remove NOT NULL in schema), which will allow an empty/nil value to be stored as NULL. cc @GuptaManan100 / @deepthi for 💡s

Copy link
Contributor

@GuptaManan100 GuptaManan100 left a 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 VTOrc performance is that much of a concern. In our experiements we found it wasn't a CPU or memory bound workload. Mostly dependent on the network calls, so its fine I think

@timvaillancourt
Copy link
Contributor Author

timvaillancourt commented Jun 27, 2025

I don't think VTOrc performance is that much of a concern. In our experiements we found it wasn't a CPU or memory bound workload. Mostly dependent on the network calls, so its fine I think

@GuptaManan100 yeah, I agree. For us a /api/database-state dump of an instance with 3000~ tablets is still just a couple of MB, including the json indentation/overhead. I guess there are some *cache.Cache objects too, but the total memory usage should be just 1 to 10s of megabytes

I think the only resource we'd be concerned to increase is CPU or remote topo calls 👍

@timvaillancourt timvaillancourt merged commit bd9e5d0 into vitessio:main Jun 30, 2025
100 of 106 checks passed
@timvaillancourt timvaillancourt deleted the vtorc-primary-timestamp-time.Time branch June 30, 2025 21:20
morgo added a commit to morgo/vitess that referenced this pull request Jul 7, 2025
…tests

* origin/master: (32 commits)
  test: Fix race condition in TestStreamRowsHeartbeat (vitessio#18414)
  VReplication: Improve permission check logic on external tablets on SwitchTraffic (vitessio#18348)
  Perform post copy actions in atomic copy (vitessio#18411)
  Update `operator.yaml` (vitessio#18364)
  Feature(onlineddl): Add shard-specific completion to online ddl (vitessio#18331)
  Set parsed comments in operator for subqueries (vitessio#18369)
  `vtorc`: move shard primary timestamp to time type (vitessio#18401)
  `vtorc`: rename `isClusterWideRecovery` -> `isShardWideRecovery` (vitessio#18351)
  `vtorc`: remove dupe keyspace/shard in replication analysis (vitessio#18395)
  Topo: Add NamedLock test for zk2 and consul and get them passing (vitessio#18407)
  Handle MySQL 9.x as New Flavor in getFlavor() (vitessio#18399)
  Add support for sending grpc server backend metrics via ORCA (vitessio#18282)
  asthelpergen: add design documentation (vitessio#18403)
  `vtorc`: add keyspace/shard labels to recoveries stats (vitessio#18304)
  `vtorc`: cleanup `database_instance` location fields (vitessio#18339)
  avoid derived tables for UNION when possible (vitessio#18393)
  [Bugfix] Broken Heartbeat system in Row Streamer (vitessio#18390)
  Update MAINTAINERS.md (vitessio#18394)
  move vmg to emeritus (vitessio#18388)
  Make sure to check if the server is closed in etcd2topo (vitessio#18352)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: VTorc Vitess Orchestrator integration Type: Internal Cleanup

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants