Skip to content
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.

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

VDiff: Add some stats #15175

Merged
merged 16 commits into from
Feb 14, 2024
Merged

VDiff: Add some stats #15175

merged 16 commits into from
Feb 14, 2024

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Feb 8, 2024

Description

VDiff emitted no metrics/stats (not technically true after #14786) so you could not monitor it in the standard Vitess ways — e.g. see some of the key VReplication stats. Instead you relied on the vdiff show command. While the show command provides the information you'd typically want to know about a specific vdiff — you could not monitor and graph vdiff stats over time and correlate those with other system events (e.g. to try and understand why a vdiff was taking longer than expected) and you got no aggregated stats across vdiffs.

This PR adds some initial metrics that I believe will be helpful to monitor and debug the VDiff component and individual vdiffs over time. You can see example stats and metrics here: https://gist.github.com/mattlord/bf49025acc7fe0c9d84da35b86ccc555

Related Issue(s)

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 PR: Add docs for vdiff metrics website#1687

Signed-off-by: Matt Lord <mattalord@gmail.com>
Copy link
Contributor

vitess-bot bot commented Feb 8, 2024

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 Feb 8, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Feb 8, 2024
@mattlord mattlord removed the NeedsIssue A linked issue is missing for this Pull Request label Feb 8, 2024
Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
Copy link

codecov bot commented Feb 9, 2024

Codecov Report

Attention: 79 lines in your changes are missing coverage. Please review.

Comparison is base (a60297b) 67.29% compared to head (14d3f73) 67.41%.
Report is 23 commits behind head on main.

Files Patch % Lines
go/vt/vttablet/tabletmanager/vdiff/stats.go 45.31% 35 Missing ⚠️
go/vt/vttablet/tabletmanager/vdiff/controller.go 0.00% 13 Missing ⚠️
go/vt/vttablet/tabletmanager/vdiff/engine.go 0.00% 11 Missing ⚠️
go/vt/vttablet/tabletmanager/vdiff/table_differ.go 0.00% 10 Missing ⚠️
go/vt/vttablet/tabletmanager/vdiff/action.go 50.00% 5 Missing ⚠️
...vt/vttablet/tabletmanager/vdiff/workflow_differ.go 0.00% 5 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15175      +/-   ##
==========================================
+ Coverage   67.29%   67.41%   +0.12%     
==========================================
  Files        1560     1560              
  Lines      192089   192996     +907     
==========================================
+ Hits       129259   130114     +855     
- Misses      62830    62882      +52     

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

Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord removed the NeedsBackportReason If backport labels have been applied to a PR, a justification is required label Feb 9, 2024
Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VReplication Component: Observability Pull requests that touch tracing/metrics/monitoring and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Feb 9, 2024
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord marked this pull request as ready for review February 10, 2024 02:40
@mattlord mattlord requested a review from deepthi as a code owner February 10, 2024 02:40
Signed-off-by: Matt Lord <mattalord@gmail.com>
@@ -44,7 +44,10 @@ comment: # https://docs.codecov.com/docs/pull-request-comments

coverage:
status: # https://docs.codecov.com/docs/commit-status
patch:
default:
informational: true # Don't ever fail the codecov/patch test
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant to do this in: #14967

Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord removed the request for review from GuptaManan100 February 10, 2024 03:47
Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
Because we're not deferring a new function, the parameters
passed to Record are calculated when we register the defer
and thus Record is able to compare the current time to the
time we passed in when registering the defer (time.Now()).

Signed-off-by: Matt Lord <mattalord@gmail.com>
Copy link
Contributor

@rohit-nayak-ps rohit-nayak-ps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Some nits, otherwise lgtm.

defer testStats.controllers[id].TableDiffPhaseTimings.Record(phase, time.Now())
time.Sleep(sleepTime)
}
want := int64(1.2 * float64(sleepTime)) // Allow 20% overhead for recording timing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have seen flakiness with such precise timings in the past, especially since you are dealing in milliseconds here. We should probably just compare that it is not zero.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can update it if it becomes flaky. I don't recall ever seeing TestVReplicationStats fail, and that does the same thing. If they are flaky then we should update both.

Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord merged commit fa59f9d into vitessio:main Feb 14, 2024
102 checks passed
@mattlord mattlord deleted the vdiff_stats branch February 14, 2024 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Observability Pull requests that touch tracing/metrics/monitoring Component: VReplication Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Feature Request: Add additional stats/metrics for VDiff
3 participants