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.

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

Jump to bottom

vtorc: Switch to Vitess stats #15948

Merged
merged 1 commit into from
May 17, 2024
Merged

vtorc: Switch to Vitess stats #15948

merged 1 commit into from
May 17, 2024
+28 −54

Conversation

dbussink
Copy link
Contributor

This moves the stats setup to the internal Vitess stats package instead of another external dependency.

With this change we can remove the external dependency.

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

@dbussink
vtorc: Switch to Vitess stats
ab1f0eb 
This moves the stats setup to the internal Vitess stats package instead
of another external dependency.

With this change we can remove the external dependency.

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
@dbussink dbussink added Type: Internal Cleanup Component: VTorc Vitess Orchestrator integration labels May 15, 2024
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented May 15, 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 May 15, 2024
@dbussink dbussink 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 May 15, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone May 15, 2024
@codecov Codecov
Copy link

codecov bot commented May 15, 2024

Codecov Report

Attention: Patch coverage is 33.33333% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 68.42%. Comparing base (9cfd040) to head (ab1f0eb).
Report is 1 commits behind head on main.

Files Patch % Lines
go/vt/vtorc/logic/vtorc.go 0.00% 5 Missing ⚠️
go/vt/vtorc/inst/instance_dao.go 50.00% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #15948      +/-   ##
==========================================
- Coverage   68.44%   68.42%   -0.03%     
==========================================
  Files        1562     1562              
  Lines      197055   197040      -15     
==========================================
- Hits       134876   134818      -58     
- Misses      62179    62222      +43

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

deepthi
deepthi reviewed May 15, 2024
View reviewed changes
go/vt/vtorc/inst/analysis_dao.go
)

var analysisChangeWriteCounter = metrics.NewCounter()
var analysisChangeWriteCounter = stats.NewCounter("analysis.change.write", "Number of times analysis has changed")
Copy link
Member

Choose a reason for hiding this comment

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

Should also not deprecate this old style naming of stats and make them consistent with Vitess-style naming?
@GuptaManan100 WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

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

@deepthi do you mean the . delimiter? If so I agree. I think most Vitess stats are _ separated

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@deepthi I was explicitly here opting for not changing anything yet here, to not trigger a rename of metrics. That's not backwards compatible then so we'd need to probably emit both for a while and then remove the old one?

I was here just focussed on a little cleanup. I think if we want to change the name, that's something for a separate PR?

Copy link
Member

Choose a reason for hiding this comment

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

I think it's a good idea to make it consistent.

Copy link
Member

Choose a reason for hiding this comment

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

we'd need to probably emit both for a while and then remove the old one

That's what deprecation means for stats. We start emitting new stats along with old ones for 1 release, delete the old ones in a follow up release, and document in release notes of both releases.

GuptaManan100
GuptaManan100 approved these changes May 16, 2024
View reviewed changes
Copy link
Member

@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.

LGTM!

@dbussink dbussink merged commit 9911880 into vitessio:main May 17, 2024
105 checks passed
@dbussink dbussink deleted the dbussink/remove-additional-metrics-lib branch May 17, 2024 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@deepthi deepthi deepthi left review comments

@timvaillancourt timvaillancourt timvaillancourt left review comments

@GuptaManan100 GuptaManan100 GuptaManan100 approved these changes

@mattlord mattlord mattlord approved these changes

@shlomi-noach shlomi-noach Awaiting requested review from shlomi-noach shlomi-noach is a code owner

@ajm188 ajm188 Awaiting requested review from ajm188 ajm188 is a code owner

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal harshit-gangal is a code owner

@rohit-nayak-ps rohit-nayak-ps Awaiting requested review from rohit-nayak-ps rohit-nayak-ps is a code owner

@systay systay Awaiting requested review from systay systay is a code owner

@frouioui frouioui Awaiting requested review from frouioui frouioui is a code owner

Assignees
No one assigned
Labels
Component: VTorc Vitess Orchestrator integration Type: Internal Cleanup
Projects
None yet
Milestone
v20.0.0
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@dbussink @deepthi @mattlord @timvaillancourt @GuptaManan100