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

Errant GTID Counts metric in VTOrc #16829

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Errant GTID Counts metric in VTOrc #16829

wants to merge 3 commits into from
+97 −12

Conversation

GuptaManan100
Copy link
Member

Description

As pointed out in #16828, it would be a good idea to also publish the number of errant GTIDs in each tablet as a metric. This PR accomplishes this goal.

The new metric looks like -

"ErrantGTIDCounts": {"zone1-0000000100": 1},

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 was added or is not required

Deployment Notes

@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Sep 24, 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 Sep 24, 2024
@GuptaManan100 GuptaManan100 added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTorc Vitess Orchestrator integration and 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 Sep 24, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Sep 24, 2024
@codecov Codecov
Copy link

codecov bot commented Sep 24, 2024

Codecov Report

Attention: Patch coverage is 71.42857% with 4 lines in your changes missing coverage. Please review.

Project coverage is 69.53%. Comparing base (95f2e3e) to head (bd70d2d).

Files with missing lines Patch % Lines
go/vt/vtorc/inst/instance_dao.go 20.00% 4 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #16829      +/-   ##
==========================================
+ Coverage   69.51%   69.53%   +0.02%     
==========================================
  Files        1569     1569              
  Lines      202517   202531      +14     
==========================================
+ Hits       140780   140833      +53     
+ Misses      61737    61698      -39

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

mattlord
mattlord approved these changes Sep 24, 2024
View reviewed changes
changelog/21.0/21.0.0/summary.md
@@ -137,3 +138,6 @@ Currently many of the configuration options for VReplication Workflows are vttab
requires restarts of vttablets. We now allow these to be overridden while creating a workflow or dynamically once
the workflow is in progress. See https://github.com/vitessio/vitess/pull/16583 for details.

### <a id="errant-gtid-metric"/>Errant GTIDs Count Metric
A new metric called `ErrantGTIDCounts` has been added to the `VTOrc` component.
Copy link
Contributor

Choose a reason for hiding this comment

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

A count[er] stat is an ever increasing metric that indicates the number of times X has occurred. So I would assume this is the number of times it's had an errant GTID. I would suggest calling this ~ CurrentErrantGTIDCount (which is a gauge vs a counter).

go/vt/vtorc/inst/instance_dao.go
@@ -61,6 +61,7 @@ var forgetAliases *cache.Cache
var (
readTopologyInstanceCounter = stats.NewCounter("InstanceReadTopology", "Number of times an instance was read from the topology")
readInstanceCounter = stats.NewCounter("InstanceRead", "Number of times an instance was read")
errantGTIDCounts = stats.NewGaugesWithSingleLabel("ErrantGTIDCounts", "Number of errant GTIDs in a vttablet", "TabletAlias")
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
errantGTIDCounts = stats.NewGaugesWithSingleLabel("ErrantGTIDCounts", "Number of errant GTIDs in a vttablet", "TabletAlias")
errantGTIDCounts = stats.NewGaugesWithSingleLabel("ErrantGTIDCounts", "Number of errant GTIDs a vttablet currently has", "TabletAlias")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@systay systay systay approved these changes

@mattlord mattlord mattlord approved these changes

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

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

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

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

Assignees
No one assigned
Labels
Component: VTorc Vitess Orchestrator integration Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v21.0.0
Development

Successfully merging this pull request may close these issues.

Feature Request: Errant GTID Count Metric in VTOrc
3 participants
@GuptaManan100 @systay @mattlord